Загрузчики, которые появились в Android 3.0, упрощают асинхронную загрузку данных в операцию или фрагмент. Загрузчики имеют следующие свойства:
Имеется несколько классов и интерфейсов, которые могут использовать загрузчики в приложении. Они приведены в этой таблице:
| Класс/интерфейс | Описание |
|---|---|
| {@link android.app.LoaderManager} | Абстрактный класс, связываемый с {@link android.app.Activity} или
{@link android.app.Fragment} для управления одним или несколькими интерфейсами {@link
android.content.Loader}. Это позволяет приложению управлять
длительно выполняющимися операциями вместе с жизненным циклом {@link android.app.Activity}
или {@link android.app.Fragment}; чаще всего этот класс используется с
{@link android.content.CursorLoader}, однако приложения могут писать
свои собственные загрузчики для работы с другими типами данных.
Имеется только один класс {@link android.app.LoaderManager} на операцию или фрагмент. Однако у класса {@link android.app.LoaderManager} может быть несколько загрузчиков. |
| {@link android.app.LoaderManager.LoaderCallbacks} | Интерфейс обратного вызова, обеспечивающий взаимодействие клиента с {@link android.app.LoaderManager}. Например, с помощью метода обратного вызова {@link android.app.LoaderManager.LoaderCallbacks#onCreateLoader onCreateLoader()} создается новый загрузчик. |
| {@link android.content.Loader} | Абстрактный класс, который выполняет асинхронную загрузку данных. Это базовый класс для загрузчика. Обычно используется {@link android.content.CursorLoader}, но можно реализовать и собственный подкласс. Когда загрузчики активны, они должны отслеживать источник своих данных и выдавать новые результаты при изменении контента. |
| {@link android.content.AsyncTaskLoader} | Абстрактный загрузчик, который предоставляет {@link android.os.AsyncTask} для выполнения работы. |
| {@link android.content.CursorLoader} | Подкласс класса {@link android.content.AsyncTaskLoader}, который запрашивает {@link android.content.ContentResolver} и возвращает {@link android.database.Cursor}. Этот класс реализует протокол {@link android.content.Loader} стандартным способом для выполнения запросов к курсорам. Он строится на {@link android.content.AsyncTaskLoader} для выполнения запроса к курсору в фоновом потоке, чтобы не блокировать пользовательский интерфейс приложения. Использование этого загрузчика — это лучший способ асинхронной загрузки данных из {@link android.content.ContentProvider} вместо выполнения управляемого запроса через платформу или API-интерфейсы операции. |
Приведенные в этой таблице классы и интерфейсы являются наиболее важными компонентами, с помощью которых в приложении реализуется загрузчик. При создании каждого загрузчика не нужно использовать все эти компоненты, однако всегда следует указывать ссылку на {@link android.app.LoaderManager} для инициализации загрузчика и использовать реализацию класса {@link android.content.Loader}, например {@link android.content.CursorLoader}. В следующих разделах рассказывается, как использовать эти классы и интерфейсы в приложении.
В этом разделе описывается использование загрузчиков в приложении для Android. В приложениях, использующих загрузчики, обычно имеются следующие элементы:
{@link android.app.LoaderManager} управляет одним или несколькими экземплярами {@link android.content.Loader} в {@link android.app.Activity} или {@link android.app.Fragment}. Имеется только один {@link android.app.LoaderManager} на каждую операцию или каждый фрагмент.
{@link android.content.Loader} обычно инициализируется в методе {@link android.app.Activity#onCreate onCreate()} операции или в методе фрагмента {@link android.app.Fragment#onActivityCreated onActivityCreated()}. Делается это следующим образом:
// Prepare the loader. Either re-connect with an existing one, // or start a new one. getLoaderManager().initLoader(0, null, this);
Метод {@link android.app.LoaderManager#initLoader initLoader()} принимает следующие параметры:
null);Вызов {@link android.app.LoaderManager#initLoader initLoader()} обеспечивает инициализацию загрузчика. Возможен один из двух результатов:
В любом случае данная реализация {@link android.app.LoaderManager.LoaderCallbacks} связывается с загрузчиком и будет вызываться при изменении состояния загрузчика. Если в момент этого вызова вызывающий компонент находится в запущенном состоянии, это означает, что запрошенный загрузчик уже существует и сформировал свои данные. В этом случае система сразу же вызовет {@link android.app.LoaderManager.LoaderCallbacks#onLoadFinished onLoadFinished()} (во время{@link android.app.LoaderManager#initLoader initLoader()}), будьте готовы к этому. Более подробные сведения об этом обратном вызове см. в разделе onLoadFinished.
Обратите внимание, что метод {@link android.app.LoaderManager#initLoader initLoader()} возвращает создаваемый класс {@link android.content.Loader}, но записывать ссылку на него не требуется. Класс {@link android.app.LoaderManager} управляет жизненным циклом загрузчика автоматически. Класс {@link android.app.LoaderManager} начинает загрузку и заканчивает ее при необходимости, а также поддерживает состояние загрузчика и связанного с ним контента. А это подразумевает, что вы будете редко взаимодействовать с загрузчиками напрямую (однако пример использования методов загрузчика для тонкой настройки его поведения см. в образце кода LoaderThrottle). Для вмешательства в процесс загрузки при возникновении определенных событий обычно используются методы {@link android.app.LoaderManager.LoaderCallbacks} . Более подробные сведения об этом см. в разделе Использование обратных вызовов LoaderManager.
При использовании метода {@link android.app.LoaderManager#initLoader initLoader()}, как показано выше, он задействует существующий загрузчик с указанным идентификатором — в случае его наличия. Если такого загрузчика нет, метод его создаст. Однако иногда старые данные нужно отбросить и начать все заново.
Для удаления старых данных используется метод {@link android.app.LoaderManager#restartLoader restartLoader()}. Например, эта реализация метода{@link android.widget.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;
}
{@link android.app.LoaderManager.LoaderCallbacks} представляет собой интерфейс обратного вызова, который позволяет клиенту взаимодействовать с классом {@link android.app.LoaderManager}.
Ожидается, что загрузчики, в частности {@link android.content.CursorLoader}, будут сохранять свои данные после их остановки. Это позволяет приложениям сохранять свои данные в методах {@link android.app.Activity#onStop onStop()} и {@link android.app.Activity#onStart onStart()} операции или фрагмента, с тем чтобы, когда пользователь вернется в приложение, ему не пришлось ждать, пока данные загрузятся заново. Методы {@link android.app.LoaderManager.LoaderCallbacks} используются, чтобы узнать, когда требуется создать новый загрузчик, а также для того, чтобы указать приложению, когда пришло время перестать использовать данные загрузчика.
Интерфейс {@link android.app.LoaderManager.LoaderCallbacks} использует следующие методы:
Более подробно эти методы описаны в разделах ниже.
При попытке доступа к загрузчику (например, посредством метода {@link android.app.LoaderManager#initLoader initLoader()}), он проверяет, существует ли загрузчик, указанный с помощью идентификатора. Если он не существует, он вызывает метод {@link android.app.LoaderManager.LoaderCallbacks} {@link android.app.LoaderManager.LoaderCallbacks#onCreateLoader onCreateLoader()}. Именно здесь и создается новый загрузчик. Обычно это будет класс {@link android.content.CursorLoader}, однако можно реализовать и собственный подкласс класса {@link android.content.Loader}.
В этом примере метод обратного вызова {@link android.app.LoaderManager.LoaderCallbacks#onCreateLoader onCreateLoader()} создает класс {@link android.content.CursorLoader}. Вы должны построить класс {@link android.content.CursorLoader} с помощью его метода конструктора, для чего требуется полный набор информации, которая нужна для выполнения запроса к {@link android.content.ContentProvider}. В частности, требуется:
null будут возвращены все столбцы, а это неэффективно; null будут возвращены все строки для данного URI; 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");
}
Этот метод вызывается, когда созданный ранее загрузчик завершил загрузку. Этот метод гарантировано вызывается до высвобождения последних данных, которые были предоставлены этому загрузчику. К этому моменту необходимо полностью перестать использовать старые данные (поскольку они скоро будут заменены). Однако этого не следует делать самостоятельно, поскольку данными владеет загрузчик и он позаботится об этом.
Загрузчик высвободит данные, как только узнает, что приложение их больше не использует. Например, если данными является курсор из {@link android.content.CursorLoader}, не следует вызывать {@link android.database.Cursor#close close()} самостоятельно. Если курсор размещается в {@link android.widget.CursorAdapter}, следует использовать метод {@link android.widget.SimpleCursorAdapter#swapCursor swapCursor()} с тем, чтобы старый {@link android.database.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); }
Этот метод вызывается, когда состояние созданного ранее загрузчика сбрасывается, в результате чего его данные теряются. Этот обратный вызов позволяет узнать, когда данные вот-вот будут высвобождены, с тем чтобы можно было удалить свою ссылку на них.
Данная реализация вызывает
{@link android.widget.SimpleCursorAdapter#swapCursor 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);
}
В качестве примера далее приведена полная реализация фрагмента {@link android.app.Fragment}, который отображает {@link android.widget.ListView} с результатами запроса к поставщику такого контента, как контакты. Для управления запросом к поставщику используется класс {@link android.content.CursorLoader}.
Чтобы приложение могло обращаться к контактам пользователя, как показано в этом примере, в его манифесте должно присутствовать разрешение {@link android.Manifest.permission#READ_CONTACTS 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 есть несколько различных примеров, которые иллюстрируют использование загрузчиков:
Сведения о загрузке и установке образцов кода SDK см. в статье Получение образцов кода.