Android4.0框架–【Activity-Loader】
在Android3.0介绍中，Loader(加载器)使得在Activity或Fragment中异步加载数据变得很容易。Loaders有以下特性：
- 在每个Activity和Fragment中都是可用的。
- 提供异步的数据加载机制
- 能够检测数据源，当内容发生变化时提供新的结果。
- 当配置更改需要重建时他们会自动重新连接到最后一个Loader的光标处。
Loader API Summary
当在应用程序中使用loader时，有多个类和接口供调用，下面的表里总结练一下。
| 类/接口 | 描述 |
| LoaderManager | 与Activity或Fragment关联的一个抽象类，可以用来管理一个或多个Loader的实例。这有助于应用程序配合Activity和Fragment生命周期管理长时间运行的操作。通常这个与CursorLoader一起使用，然而，应用程序为装载其他数据类型写他们自己的装载器。每个Activity或Fragment只有一个LoaderManager，但是一个LoaderManager可以有多个Loaders。 |
| LoaderManager.LoaderCallbacks | 客户端与LoaderManager交互的回调接口。例如，可以使用onCreateLoader()回调方法创建一个新的loader。 |
| Loader | 用于执行异步数据加载的抽象类。这个是加载器的基类。通常会使用CursorLoader,但也可以实现自己的子类。当loaders处于活动状态，他们可以检测数据源并且当内容改变时提供新的结果。 |
| AsyncTaskLoader | 能够提供一个AsyncTask处理工作的抽象Loader |
| CursorLoader | AsyncTaskLoader的一个子类，能够查询ContentResolver并返回一个Cursor.这个类一标准方式实现了查询cursors的Loader协议，在后台进程中在AsyncTaskLoader上进行创建并执行查询，以至于不会阻塞应用程序的UI.这是从ContentProvider进行异步加载数据的最好的方法，来代替通过Fragment或Activity的APIs来执行一个查询。 |
在应用程序中，上面这些类和接口都是用于实现loader的重要组件。你不需要所有的这些组件来创建每个loader，但通常需要LoaderManager的引用以便于可以初始化一个loader，以及Loader类如CursorLoader的实现。下面内容展示在应用程序中如何使用这些类和接口。
Using Loaders in an Application
下面描述在Android应用程序中如何使用loaders。应用程序中使用loaders通常包含以下内容：
- 一个Activity或Fragment
- LoaderManager的一个实例
- 一个用于加载数据的CursorLoader,这些数据通过ContentProvider备份。或者可以自己实现Loader或AsyncTaskLoader的子类来从其他数据源加载数据。
- 一个LoaderManager.LoaderCallbacks的实现，这里你可以创建新的loaders以及管理以及存在loaders的引用。
- 一种展示loaders数据的方式，例如simpleCursorAdapter。
- 一个数据源，例如当使用CursorLoader时，使用contentProvider做数据源
Starting a Loader
在一个Activity或Fragment中，一个LoaderManager管理一个或多个Loader实例。每个Activity或Fragment中只有一个LoaderManager。通常在activity的onCreate()方法或fragment的onActivityCreate()方法中初始化一个Loader对象。像下面这样：
// Prepare the loader. Either re-connect with an existing one,
// or start a new one.
getLoaderManager().initLoader(0, null, this);
initLoader()方法可以传入以下参数：
- l 标识loader的唯一的ID,这里是0
- l loader在构造时提供的可选参数，这里是null
- l 一个LoaderManager.LoaderCallback实现，LoaderManager通过这个实现来报告loader事件。这个例子中，本类实现了LoaderManager.LoaderCallback的接口，因此参数为this。
initLoader()调用确保一个loader初始化并且处于活动状态，它有两种可能的结果：
- l 如果指定ID的loader已经存在，上一个loader继续使用。
- l 如果指定ID的loader不存在，initLoader()触发LoaderManager.LoaderCallback的onCreateLoader()方法。这里实现代码来实例化并返回一个新的loader。
这两种情况下，给定的LoaderManager.LoaderCallback实现与一个loader关联，当loader状态变化时会调用这个实现。如果在调用时，调用方处于启动状态，并且请求的loader已经存在，并且已经产生了数据，这时系统立即调用onLoadFinished()(在initLoader())，因此你必须为此做好准备。
注意的是，在initLoder()方法中创建的loader，你并不需要获取其引用。LoaderManager会自动管理loader的生命周期。在必要时，LoaderManager会启动或停止该loader，并且管理loader的状态以及相关内容。这意味着，你很少直接与loaders交互。通常是在特定事件发生时，利用LoaderManager.LoaderCallback方法在加载过程中进行干预。
Restarting a Loader
在上面的initLoader()方法中，通过指定一个ID来使用一个已经存在的loader，如果没有就创建一个。但有时需要丢弃旧数据重新开始。
丢弃旧数据可以利用restartLoader()，例如，在SearchView.OnQueryTextListener的实现中重起loader,当用户查询变化时。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;
}
Using the LoaderManager Callbacks
LoaderManager.LoaderCallbacks是一个能让客户端与LoaderManager交互的回调接口。
Loaders，特别是CursorLoader，都期望在停止后能够保留其数据。这使得应用程序能够在activity或fragment的onStop()和onStart()方法中能够保持对数据的获取，以便当用户返回应用程序时，他们不必等待数据的加载。你可以使用LoaderManager.LoaderCallbacks方法来通知什么时间创建一个新的loader，以及什么时间停止使用loader的数据。
LoaderManager.LoaderCallbacks包含以下这些方法：
- l onCreateLoader() 为给定的ID实例化并返回一个新的loader。
- l onLoadFinished() 当之前创建的loader完成其加载时调用。
- l onLoaderReset() 当之前创建的loader重置时调用，这样使得其数据不可获取。
下面来更详细的描述这些方法：
onCreateLoader
当你试图访问一个loader(例如，通过initLoader()),它检测指定ID的loader是否存在，如果不存在，它触发了LoaderManager.LoaderCallbacks的onCreateLoader()方法，这里用来创建一个新的loader，特别是CursorLoader，但是你也可以实现你自己的Loader子类。
在这个例子中，onCreateLoader()回调方法创建了一个CursorLoader，你必须通过他的构造函数来构建一个CursorLoader,他需要对ContentProvider执行一个查询所需的一套信息。具体的需要：
- l URI---需要检索内容的URI
- l projection---返回列的集合，如果为null返回所有的列
- l selection---声明返回行的过滤器，以SQL WHERE语句格式(不包含WHERE本身)，如果为null返回所有的行。
- l selectionArgs---你可能在selection中包含 ?s，这个将会用selectionArgs的值取代，按照在selection中出现的顺序，这些值以字符串的形式绑定。
- l 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
当之前创建的loader已经完成数据加载时调用该方法。在提供给这个loader的最后一个数据释放之前确保该方法被调用。这时你应该删除所有使用的旧数据(因为他很快就释放了)，但是不需要你自己去释放数据，因为loader拥有该数据并且会自动完成。
一旦知道应用程序不再使用它，loader就会释放其数据。例如，如果数据是来自CursorLoader的cursor，你不应该调用close()方法。如果cursor置于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
当之前创建的loader重置时调用该方法，这样使得他的数据不可获取。这个调用使得你能够找出相关数据什么时间释放，以便你可以移除对他的引用。
通过对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);
}
Example
下面的例子，是Fragment的完整实现，展示了一个包含从content provider联系人中查询结果的ListView.他是通过一个CursorLoader来管理对provider的查询。
对于在下面的例子中，该应用程序访问一个用户的通讯录，他的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);
}
}