1. Loader简介
从3.0开始,Android引入了Loader API。它可以帮我我们从content provider或其他数据源获取数据并显示在UI界面上。
如果没有Loader API:
- 我们在UI线程中获取数据,如果耗时则界面会卡顿。
- 我们在非UI线程中获取数据,比如通过AsycTask,那么我们需要处理activity或fragment生命周期所触发的event,比如onDestory()和configuration changes。非UI线程和UI线程我们都需要做处理。
Loader可以帮助我们解决上面的问题:
- Loader运行在非UI线程。
- Loader提供了回调方法,用以应对event的发生,简化了线程的管理。
- Loader在configuration changes时会对数据进行保存和缓存,防止重复的获取。
- Loader实现了对数据源的监控(观察者)。比如CursorLoader会注册一个ContentObserver,在数据发生改变的时候会自动触发重加载。
2. Loader API概述
Class/Interface Description LoaderManager 一个Activity或Fragment可能有多个Loader实例。但只能有一个LoaderManager,它能管理多个Loader。通过getLoaderManager()获取LoaderMananger实例。
从loader中获取数据,可以调用initLoader() 或 restartLoader()。系统会自动判断包含相同ID的loader是否已经存在,从而重新创建或者复用已有的loader。
LoaderManager.LoaderCallbacks 这个接口里的回调方法会在loader events触发时调用。定义了三个回调方法:
- onCreateLoader(int, Bundle) - 当系统需要创建一个新的loader时被调用。我们需要在这个方法中创建一个Loader对象并返回给系统。
- onLoadFinished(Loader<D>, D) - 当loader加载数据完成时被调用。通常我们需要在这个方法中将数据展示给用户。
- onLoaderReset(Loader<D>) - 当一个已存在的loader被reset时被调用(当我们调用了destroyLoader(int) 或 当前的activity/fragment被销毁,这会导致当前的数据不能用)。我们需要在这个方法中去掉这个loader的所有引用。
通常这个接口我们需要在activitiy/fragment中实现,并在调用initLoader() 或 restartLoader()之前注册。
Loader Loders负责加载数据。这是个抽象类,同时也是所有类型loader的基类。我们可以自己继承Loader 或者 直接使用系统的Loader子类:
- AsyncTaskLoader - 一个抽象类,内部通过AsyncTask实现异步加载数据。
- CursorLoader - AsyncTaskLoader的实体子类,实现异步地从ContentProvider加载数据。它查询ContentResolver,返回一个Cursor对象。
下面会讨论如何使用这些类。
3. Using Loaders in an Application
本节会讨论如何使用loaders。步骤如下:
- 在Activity或Fragment中。
- 声明一个LoaderManager实例。
- 一个CursorLoader用来从ContentProvider中获取数据。如果我们需要从其他的数据源获取数据,我们可以自己实现Loader或AsyncTaskLoader的子类。
- 实现LoaderManager.LoaderCallbacks。我们在回调中创建并管理loaders。
- 选择一个展示loader数据的方式,比如SimpleCursorAdapter。
- 选择数据源,比如ContentProvider,我们使用CursorLoader来获取数据。
3.1 Starting a Loader
LoaderManager在Activity或Fragment中管理一个或多个Loader的实例。一个Activity或Fragment中只能有一个LoaderMananger。
通常我们在onCreate()/onActivityCreated()中初始化一个Loader。
// Prepare the loader. Either re-connect with an existing one, // or start a new one. getLoaderManager().initLoader(0, null, this);
initLoder()方法有两个参数:
- 唯一的ID用来标记标记loader。
- 可选的参数,在loader构造时会使用。没有传null。
- LoaderManager.LoaderCallbacks的实现,LoaderManager会负责进行回调。
调用initLoader()之后,一个loader被初始化并且可用。存在两种可能的返回值:
- 如果指定ID对应的loader已经存在,则返回这个loader。
- 如果指定ID对应的loader不存在,initLoader()方法会触发callback中的onCreateLoader()回调。前面提到,我们会在这个回调中自己创建loader的方法。更详细的介绍可以参考onCreateLoader章节。
同时,返回的loader会跟LoaderMananger.LoaderCallbacks绑定,在这个loader有状态改变的时候回调都会被触发。如果在请求创建过程中,请求的loader已经存在同时产生了数据,回调onLoadFinish()会立刻被创建(还在initLoader()的过程中),所以我们需要考虑这种情况的判断。更详细的介绍可以参考onLoaderFinished章节。
需要注意的是,虽然initLoader()方法会返回一个Loader实例,但我们不用去引用它。LoaderManager会自动地在loader的生命周期中对它进行管理。LoaderMananger会自动在适当时机开始或停止loader,并保存loader的状态和它关联的数据。这意味着,我们不用直接对Loader进行操作(除非我们需要额外地管理loader的行为,可以参考例子LoaderThrottle)。我们只需要在LoaderManager.LoaderCallbacks的回调方法中进行处理。更详细的介绍可以参考Using the LoadManager Callbacks章节。
3.2 Restarting a Loader
正如前面介绍的,initLoader()在我们制定ID对应的Loader不存在时才会创建一个新的,如果存在则直接复用。但有的时候,我们需要丢弃旧的数据,使用新的。这时候我们可以使用restartLoader()方法。
比如,我们在实现SearchView.OnQueryTextListener的时候,当我们需要查询数据的条件发生改变时,我们需要改变search filter之后restart loader。
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;
}
3.3 Using the LoaderMananger Callbacks
我们可以通过LoaderMananger.LoaderCallbacks的回调方法与LoaderManager进行交互。这可以使我们知道loader什么时候被创建、什么时候被停止,进而对我们的UI进行更新。
LoaderMananger.LoaderCallbacks包含了3个回调方法:
- onCreateLoader() - 初始化并返回指定ID对应的Loader。
- onLoadFinished() - 当loader完成数据加载会被调用。
- onLoaderReset() - 当loader被reset时调用,这会导致数据无法使用。
3.3.1 onCreateLoader
当我们尝试访问loader,比如initLoader(),它会检查ID对应的loader是否存在。如果不存在,则触发LoaderManager.LoaderCallbacks的onCreateLoader()。我们在这个回调里创建loader。通常是CursorLoader,也可以自己实现Loader的子类。
举个例子,如果我们创建CursorLoader。我们需要构造函数创建CursorLoader,如果用它查询ContentProvider,我们需要:
- uri - 查询数据的URI。
- projection - 指定会返回哪些columns。传递null会返回所有的columns,不过这样效率很低。
- selection - 指定会返回哪些rows,格式是WHERE SQL语句。传递null会返回所有的rows。
- selectionArgs - 我们可以在selection中使用通配符?,它会被selectionArgs中的值代替。格式是Strings。
- sortOrder - 设置查询顺序,格式是ORDER BY SQL语句。传递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"); }
3.3.2 onLoadFinished
// 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); }
3.3.3 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); }
4. Example
下面是在Fragment中使用listview展示从contacts content provider获取到的数据。使用CursorLoader管理数据。
因为这个例子需要访问联系人信息,所以我们需要在manifest中添加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); } }
4.1 More Examples
其他使用loader的场景:
- LoaderCursor - 如上面的例子。
- Retrieving a List of Contacts
- LoaderThrottle
- AsyncTaskLoader - 通过AsyncTaskLoader从package manager中获取已安装的app信息。