Загрузчики

Загрузчики, которые появились в Android 3.0, упрощают асинхронную загрузку данных в операцию или фрагмент. Загрузчики имеют следующие свойства:

• Они имеются для любых операций Activity и фрагментов Fragment.
• Они обеспечивают асинхронную загрузку данных.
• Они отслеживают источник своих данных и выдают новые результаты при изменении контента.
• Они автоматически переподключаются к последнему курсору загрузчика при воссоздании после изменения конфигурации. Таким образом, им не требуется повторно запрашивать свои данные.

Сводная информация об API-интерфейсе загрузчика

Имеется несколько классов и интерфейсов, которые могут использовать загрузчики в приложении. Они приведены в этой таблице:

Приведенные в этой таблице классы и интерфейсы являются наиболее важными компонентами, с помощью которых в приложении реализуется загрузчик. При создании каждого загрузчика не нужно использовать все эти компоненты, однако всегда следует указывать ссылку на LoaderManager для инициализации загрузчика и использовать реализацию класса Loader, например CursorLoader. В следующих разделах рассказывается, как использовать эти классы и интерфейсы в приложении.

Использование загрузчиков в приложении

В этом разделе описывается использование загрузчиков в приложении для Android. В приложениях, использующих загрузчики, обычно имеются следующие элементы:

• Activity или Fragment;
• экземпляр LoaderManager;
• CursorLoader для загрузки данных, выдаваемых ContentProvider. Вы также можете реализовать собственный подкласс класса Loader или AsyncTaskLoader для загрузки данных из другого источника;
• реализация для LoaderManager.LoaderCallbacks. Именно здесь создаются новые загрузчики и ведется управление ссылками на существующие загрузчики;
• способ отображения данных загрузчика, например SimpleCursorAdapter;
• источник данных, например ContentProvider, когда используется CursorLoader.

Запуск загрузчика

LoaderManager управляет одним или несколькими экземплярами Loader в Activity или Fragment. Имеется только один LoaderManager на каждую операцию или каждый фрагмент.

Loader обычно инициализируется в методе onCreate() операции или в методе фрагмента onActivityCreated(). Делается это следующим образом:

// Prepare the loader.  Either re-connect with an existing one,
// or start a new one.
getLoaderManager().initLoader(0, null, this);

Метод initLoader() принимает следующие параметры:

• уникальный идентификатор, обозначающий загрузчик. В данном примере идентификатором является 0;
• необязательные аргументы, которые передаются загрузчику при построении (в данном примере это null);
• реализация LoaderManager.LoaderCallbacks, которая вызывает класс LoaderManager для выдачи событий загрузчика. В данном примере локальный класс реализует интерфейс LoaderManager.LoaderCallbacks, поэтому он передает ссылку самому себе: this.

Вызов initLoader() обеспечивает инициализацию загрузчика. Возможен один из двух результатов:

• Если загрузчик, указанный с помощью идентификатора, уже существует, будет повторно использован загрузчик, созданный последним.
• Если загрузчик, указанный с помощью идентификатора, не существует, initLoader() вызывает метод LoaderManager.LoaderCallbacks из onCreateLoader(). Именно здесь реализуется код для создания экземпляра и возврата нового загрузчика. Более подробные сведения см. в разделе onCreateLoader.

В любом случае данная реализация LoaderManager.LoaderCallbacks связывается с загрузчиком и будет вызываться при изменении состояния загрузчика. Если в момент этого вызова вызывающий компонент находится в запущенном состоянии, это означает, что запрошенный загрузчик уже существует и сформировал свои данные. В этом случае система сразу же вызовет onLoadFinished() (во времяinitLoader()), будьте готовы к этому. Более подробные сведения об этом обратном вызове см. в разделе onLoadFinished.

Обратите внимание, что метод initLoader() возвращает создаваемый класс Loader, но записывать ссылку на него не требуется. Класс LoaderManager управляет жизненным циклом загрузчика автоматически. Класс LoaderManager начинает загрузку и заканчивает ее при необходимости, а также поддерживает состояние загрузчика и связанного с ним контента. А это подразумевает, что вы будете редко взаимодействовать с загрузчиками напрямую (однако пример использования методов загрузчика для тонкой настройки его поведения см. в образце кода LoaderThrottle). Для вмешательства в процесс загрузки при возникновении определенных событий обычно используются методы LoaderManager.LoaderCallbacks . Более подробные сведения об этом см. в разделе Использование обратных вызовов LoaderManager.

Перезапуск загрузчика

При использовании метода initLoader(), как показано выше, он задействует существующий загрузчик с указанным идентификатором — в случае его наличия. Если такого загрузчика нет, метод его создаст. Однако иногда старые данные нужно отбросить и начать все заново.

Для удаления старых данных используется метод restartLoader(). Например, эта реализация методаSearchView.OnQueryTextListener перезапускает загрузчик, когда изменяется запрос пользователя. Загрузчик необходимо перезагрузить, с тем чтобы он мог использовать измененный фильтр поиска для выполнения нового запроса:

public boolean onQueryTextChanged(String newText) {
    // Called when the action bar search text has changed.  Update
    // the search filter, and restart the loader to do a new query
    // with this filter.
    mCurFilter = !TextUtils.isEmpty(newText) ? newText : null;
    getLoaderManager().restartLoader(0, null, this);
    return true;
}

Использование обратных вызовов класса LoaderManager

LoaderManager.LoaderCallbacks представляет собой интерфейс обратного вызова, который позволяет клиенту взаимодействовать с классом LoaderManager.

Ожидается, что загрузчики, в частности CursorLoader, будут сохранять свои данные после их остановки. Это позволяет приложениям сохранять свои данные в методах onStop() и onStart() операции или фрагмента, с тем чтобы, когда пользователь вернется в приложение, ему не пришлось ждать, пока данные загрузятся заново. Методы LoaderManager.LoaderCallbacks используются, чтобы узнать, когда требуется создать новый загрузчик, а также для того, чтобы указать приложению, когда пришло время перестать использовать данные загрузчика.

Интерфейс LoaderManager.LoaderCallbacks использует следующие методы:

• onCreateLoader() — создает экземпляр и возвращает новый класс Loader для данного идентификатора.

• onLoadFinished() — вызывается, когда созданный ранее загрузчик завершил загрузку.

• onLoaderReset() — вызывается, когда состояние созданного ранее загрузчика сбрасывается, в результате чего его данные теряются.

Более подробно эти методы описаны в разделах ниже.

onCreateLoader

При попытке доступа к загрузчику (например, посредством метода initLoader()), он проверяет, существует ли загрузчик, указанный с помощью идентификатора. Если он не существует, он вызывает метод LoaderManager.LoaderCallbacks onCreateLoader(). Именно здесь и создается новый загрузчик. Обычно это будет класс CursorLoader, однако можно реализовать и собственный подкласс класса Loader.

В этом примере метод обратного вызова onCreateLoader() создает класс CursorLoader. Вы должны построить класс CursorLoader с помощью его метода конструктора, для чего требуется полный набор информации, которая нужна для выполнения запроса к ContentProvider. В частности, требуется:

• uri — URI контента, который необходимо получить;
• projection — список столбцов, которые будут возвращены. При передаче null будут возвращены все столбцы, а это неэффективно;
• selection — фильтр, объявляющий, какие строки возвращать, отформатированный в виде предложения SQL WHERE (за исключением самого WHERE). При передаче null будут возвращены все строки для данного URI;
• selectionArgs — в выборку можно включить символы "?", которые будут заменены значениями из selectionArgs в порядке следования в выборке. Значения будут привязаны как строки;
• sortOrder — порядок расположения строк, отформатированный в виде предложения SQL ORDER BY (за исключением самого ORDER BY). При передаче null будет использоваться стандартный порядок сортировки, поэтому, список, возможно, будет неотсортирован.

Например:

 // If non-null, this is the current filter the user has provided.
String mCurFilter;
...
public Loader<Cursor> onCreateLoader(int id, Bundle args) {
    // This is called when a new Loader needs to be created.  This
    // sample only has one Loader, so we don't care about the ID.
    // First, pick the base URI to use depending on whether we are
    // currently filtering.
    Uri baseUri;
    if (mCurFilter != null) {
        baseUri = Uri.withAppendedPath(Contacts.CONTENT_FILTER_URI,
                  Uri.encode(mCurFilter));
    } else {
        baseUri = Contacts.CONTENT_URI;
    }

    // Now create and return a CursorLoader that will take care of
    // creating a Cursor for the data being displayed.
    String select = "((" + Contacts.DISPLAY_NAME + " NOTNULL) AND ("
            + Contacts.HAS_PHONE_NUMBER + "=1) AND ("
            + Contacts.DISPLAY_NAME + " != '' ))";
    return new CursorLoader(getActivity(), baseUri,
            CONTACTS_SUMMARY_PROJECTION, select, null,
            Contacts.DISPLAY_NAME + " COLLATE LOCALIZED ASC");
}

onLoadFinished

Этот метод вызывается, когда созданный ранее загрузчик завершил загрузку. Этот метод гарантировано вызывается до высвобождения последних данных, которые были предоставлены этому загрузчику. К этому моменту необходимо полностью перестать использовать старые данные (поскольку они скоро будут заменены). Однако этого не следует делать самостоятельно, поскольку данными владеет загрузчик и он позаботится об этом.

Загрузчик высвободит данные, как только узнает, что приложение их больше не использует. Например, если данными является курсор из CursorLoader, не следует вызывать close() самостоятельно. Если курсор размещается в CursorAdapter, следует использовать метод swapCursor() с тем, чтобы старый Cursor не закрылся. Например:

// This is the Adapter being used to display the list's data.
SimpleCursorAdapter mAdapter;
...

public void onLoadFinished(Loader<Cursor> loader, Cursor data) {
    // Swap the new cursor in.  (The framework will take care of closing the
    // old cursor once we return.)
    mAdapter.swapCursor(data);
}

onLoaderReset

Этот метод вызывается, когда состояние созданного ранее загрузчика сбрасывается, в результате чего его данные теряются. Этот обратный вызов позволяет узнать, когда данные вот-вот будут высвобождены, с тем чтобы можно было удалить свою ссылку на них.  

Данная реализация вызывает swapCursor() со значением null:

// This is the Adapter being used to display the list's data.
SimpleCursorAdapter mAdapter;
...

public void onLoaderReset(Loader<Cursor> loader) {
    // This is called when the last Cursor provided to onLoadFinished()
    // above is about to be closed.  We need to make sure we are no
    // longer using it.
    mAdapter.swapCursor(null);
}

Пример

В качестве примера далее приведена полная реализация фрагмента Fragment, который отображает ListView с результатами запроса к поставщику такого контента, как контакты. Для управления запросом к поставщику используется класс CursorLoader.

Чтобы приложение могло обращаться к контактам пользователя, как показано в этом примере, в его манифесте должно присутствовать разрешение READ_CONTACTS.

public static class CursorLoaderListFragment extends ListFragment
        implements OnQueryTextListener, LoaderManager.LoaderCallbacks<Cursor> {

    // This is the Adapter being used to display the list's data.
    SimpleCursorAdapter mAdapter;

    // If non-null, this is the current filter the user has provided.
    String mCurFilter;

    @Override public void onActivityCreated(Bundle savedInstanceState) {
        super.onActivityCreated(savedInstanceState);

        // Give some text to display if there is no data.  In a real
        // application this would come from a resource.
        setEmptyText("No phone numbers");

        // We have a menu item to show in action bar.
        setHasOptionsMenu(true);

        // Create an empty adapter we will use to display the loaded data.
        mAdapter = new SimpleCursorAdapter(getActivity(),
                android.R.layout.simple_list_item_2, null,
                new String[] { Contacts.DISPLAY_NAME, Contacts.CONTACT_STATUS },
                new int[] { android.R.id.text1, android.R.id.text2 }, 0);
        setListAdapter(mAdapter);

        // Prepare the loader.  Either re-connect with an existing one,
        // or start a new one.
        getLoaderManager().initLoader(0, null, this);
    }

    @Override public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
        // Place an action bar item for searching.
        MenuItem item = menu.add("Search");
        item.setIcon(android.R.drawable.ic_menu_search);
        item.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
        SearchView sv = new SearchView(getActivity());
        sv.setOnQueryTextListener(this);
        item.setActionView(sv);
    }

    public boolean onQueryTextChange(String newText) {
        // Called when the action bar search text has changed.  Update
        // the search filter, and restart the loader to do a new query
        // with this filter.
        mCurFilter = !TextUtils.isEmpty(newText) ? newText : null;
        getLoaderManager().restartLoader(0, null, this);
        return true;
    }

    @Override public boolean onQueryTextSubmit(String query) {
        // Don't care about this.
        return true;
    }

    @Override public void onListItemClick(ListView l, View v, int position, long id) {
        // Insert desired behavior here.
        Log.i("FragmentComplexList", "Item clicked: " + id);
    }

    // These are the Contacts rows that we will retrieve.
    static final String[] CONTACTS_SUMMARY_PROJECTION = new String[] {
        Contacts._ID,
        Contacts.DISPLAY_NAME,
        Contacts.CONTACT_STATUS,
        Contacts.CONTACT_PRESENCE,
        Contacts.PHOTO_ID,
        Contacts.LOOKUP_KEY,
    };
    public Loader<Cursor> onCreateLoader(int id, Bundle args) {
        // This is called when a new Loader needs to be created.  This
        // sample only has one Loader, so we don't care about the ID.
        // First, pick the base URI to use depending on whether we are
        // currently filtering.
        Uri baseUri;
        if (mCurFilter != null) {
            baseUri = Uri.withAppendedPath(Contacts.CONTENT_FILTER_URI,
                    Uri.encode(mCurFilter));
        } else {
            baseUri = Contacts.CONTENT_URI;
        }

        // Now create and return a CursorLoader that will take care of
        // creating a Cursor for the data being displayed.
        String select = "((" + Contacts.DISPLAY_NAME + " NOTNULL) AND ("
                + Contacts.HAS_PHONE_NUMBER + "=1) AND ("
                + Contacts.DISPLAY_NAME + " != '' ))";
        return new CursorLoader(getActivity(), baseUri,
                CONTACTS_SUMMARY_PROJECTION, select, null,
                Contacts.DISPLAY_NAME + " COLLATE LOCALIZED ASC");
    }

    public void onLoadFinished(Loader<Cursor> loader, Cursor data) {
        // Swap the new cursor in.  (The framework will take care of closing the
        // old cursor once we return.)
        mAdapter.swapCursor(data);
    }

    public void onLoaderReset(Loader<Cursor> loader) {
        // This is called when the last Cursor provided to onLoadFinished()
        // above is about to be closed.  We need to make sure we are no
        // longer using it.
        mAdapter.swapCursor(null);
    }
}

Другие примеры

В ApiDemos есть несколько различных примеров, которые иллюстрируют использование загрузчиков:

• LoaderCursor — полная версия показанного выше фрагмента.
• LoaderThrottle — пример того, как использовать регулирование для сокращения числа запросов, выполняемых поставщиком контента при изменении его данных.

Сведения о загрузке и установке образцов кода SDK см. в статье Получение образцов кода.