Android3.0之后引入了加载器,支持轻松在Activity和Fragment中异步加载数据。加载器具有以下特点:
1、可用于任何Activity和Fragment
2、支持异步加载数据
3、监控其数据源并在内容变化时传递新结果
4、在某一配置更改后重建加载器时,会自动重新连接上一个加载器的游标。 因此,它们无需重新查询其数据。
Loader API摘要
在应用中使用加载器时,可能会涉及到多个类和接口。 下表汇总了这些类和接口:
类/接口 | 描述 |
LoaderManager |
一种与Activity或Fragment相关联的的抽象类,用于管理一个或多个Loader实例。 这有助于应用管理与 Activity或 Fragment生命周期相关联的、运行时间较长的操作。它最常见的用法是与CursorLoader一起使用,但应用可自由写入其自己的加载器,用于加载其他类型的数据。 每个Activity或Fragment中只有一个LoaderManager。但一个LoaderManager可以有多个加载器 |
LoaderManager.LoaderCallbacks |
一种回调接口,用于客户端与LoaderManager进行交互。例如,您可使用onCreateLoader()回调方法创建新的加载器。 |
Loader | 一种执行异步数据加载的抽象类。这是加载器的基类。 您通常会使用CursorLoader,但您也可以实现自己的子类。加载器处于活动状态时,应监控其数据源并在内容变化时传递新结果。 |
AsyncTaskLoader | 提供 AsyncTask 来执行工作的抽象加载器 |
CursorLoader | AsyncTaskLoader 的子类,它将查询ContentResolver并返回一个Cursor。此类采用标准方式为查询游标实现 Loader 协议。它是以AsyncTaskLoader为基础而构建,在后台线程中执行游标查询,以免阻塞应用的 UI。使用此加载器是从ContentProvider异步加载数据的最佳方式,而不用通过Fragment或 Activity 的 API 来执行托管查询。 |
上表中的类和接口是您在应用中用于实现加载器的基本组件。 并非您创建的每个加载器都要用到上述所有类和接口。但是,为了初始化加载器以及实现一个 Loader 类(如 CursorLoader),您始终需要要引用 LoaderManager。 下文将为您展示如何在应用中使用这些类和接口。
在应用中使用Loaders
此部分描述如何在 Android 应用中使用加载器。使用加载器的应用通常包括:
1、Activity或Fragment。
2、LoaderManager的实例。
3、一个CursorLoader,用于加载由ContentProvider支持的数据。您也可以实现自己的Loader或AsyncTaskLoader子类,从其他源中加载数据。
4、一个 LoaderManager.LoaderCallbacks实现。您可以使用它来创建新加载器,并管理对现有加载器的引用。
5、一种显示加载器数据的方法,如SimpleCursorAdapter。
6、使用CursorLoader时的数据源,如ContentProvider。
启动Loader
LoaderManager可在Activity或Fragment内管理一个或多个Loader实例。每个Activity或Fragment中只有一个LoaderManager。通常我们不需要实例化LoaderManager,在Activity或Fragment中调用getLoaderManager()方法即可获取LoaderManager的引用。对LoaderManager我们通常只对两个方法感兴趣:initLoader()和restartLoader()。
通常,您会在Activity的onCreate()方法或Fragment的onActivityCreated()方法内初始化Loader。您执行操作如下:
// Prepare the loader. Either re-connect with an existing one,
// or start a new one.
getLoaderManager().initLoader(0, null, this);
initLoader()方法有以下参数:
1、用于标识加载器的唯一 ID。在此示例中,ID为0。
2、在构建时提供给加载器的可选参数(在此示例中为 null)。
3、LoaderManager.LoaderCallbacks 实现, LoaderManager 将调用此实现来报告加载器事件。在此示例中,本地类实现 LoaderManager.LoaderCallbacks接口,因此它会传递对自身的引用this。
initLoader() 调用确保加载器已初始化且处于活动状态。这可能会出现两种结果:
1、如果 ID 指定的加载器已存在,则将重复使用上次创建的加载器。
2、如果 ID 指定的加载器不存在,则 initLoader() 将触发 LoaderManager.LoaderCallbacks 方法 onCreateLoader()。在此方法中,您可以实现代码以实例化并返回新加载器。有关详细介绍,请参阅 onCreateLoader 部分。
无论何种情况,给定的 LoaderManager.LoaderCallbacks 实现均与加载器相关联,且将在加载器状态变化时调用。如果在调用时,调用程序处于启动状态,且请求的加载器已存在并生成了数据,则系统将立即调用 onLoadFinished()(在 initLoader() 期间),因此您必须为此做好准备。
请注意,initLoader() 方法将返回已创建的 Loader,但您不必捕获其引用。LoaderManager 将自动管理加载器的生命周期。LoaderManager 将根据需要启动和停止加载,并维护加载器的状态及其相关内容。 这意味着您很少直接与加载器进行交互(有关使用加载器方法调整加载器行为的示例,请参阅 LoaderThrottle 示例)。当特定事件发生时,您通常会使用 LoaderManager.LoaderCallbacks 方法干预加载进程。
restartLoader():
Android通常不会自动执行查询,在数据源发生变化时,就需要一种重新初始化加载器的机制,通常在执行搜索查询时需要这种机制,调用restartLoader()方法可以重启加载器,它与initLoader()方法接收同样的参数,当然要和initLoader()使用相同的ID。
重启加载器
当您使用 initLoader() 时(如上所述),它将使用含有指定 ID 的现有加载器(如有)。如果没有,则它会创建一个。但有时,您想舍弃这些旧数据并重新开始。
要舍弃旧数据,请使用 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 Callbacks
LoaderManager.LoaderCallbacks 是一个支持客户端与 LoaderManager 交互的回调接口。
加载器(特别是 CursorLoader)在停止运行后,仍需保留其数据。这样,应用即可保留 Activity 或片段的 onStop() 和 onStart() 方法中的数据。当用户返回应用时,无需等待它重新加载这些数据。您可使用 LoaderManager.LoaderCallbacks 方法了解何时创建新加载器,并告知应用何时停止使用加载器的数据。
LoaderManager.LoaderCallbacks包含以下方法:
onCreateLoader():针对指定的 ID 进行实例化并返回新的 Loader
onLoadFinished() :将在先前创建的加载器完成加载时调用
onLoaderReset():将在先前创建的加载器重置且其数据因此不可用时调用
onCreateLoader
当您尝试访问加载器时(例如,通过 initLoader()),该方法将检查是否已存在由该 ID 指定的加载器。 如果没有,它将触发 LoaderManager.LoaderCallbacks 方法 onCreateLoader()。在此方法中,您可以创建新加载器。 通常,这将是 CursorLoader,但您也可以实现自己的 Loader 子类。
在此示例中,onCreateLoader() 回调方法创建了 CursorLoader。您必须使用其构造函数方法来构建 CursorLoader。该方法需要对 ContentProvider 执行查询时所需的一系列完整信息。具体地说,它需要:
uri:用于检索内容的 URI
projection:要返回的列的列表。传递 null 时,将返回所有列,这样会导致效率低下
selection:一种用于声明要返回哪些行的过滤器,采用 SQL WHERE 子句格式(WHERE 本身除外)。传递 null 时,将为指定的 URI 返回所有行
selectionArgs:您可以在 selection 中包含 ?s,它将按照在 selection 中显示的顺序替换为 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
此方法将在先前创建的加载器重置且其数据因此不可用时调用。 通过此回调,您可以了解何时将释放数据,因而能够及时移除其引用。
此实现调用值为 null 的swapCursor():
// 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 管理提供程序的查询。因为需要访问联系人列表,所以需要在AndroidManifest.xml配置文件中添加访问联系人权限:
<uses-permission android:name="android.permission.READ_CONTACTS"/>
1 public class CursorLoaderListFragment extends ListFragment implements SearchView.OnQueryTextListener, 2 LoaderManager.LoaderCallbacks<Cursor> { 3 //需要查找的联系人行信息 4 private static final String[] CONTACTS_SUMMARY_PROJECTION = new String[]{ 5 ContactsContract.Contacts._ID, 6 ContactsContract.Contacts.DISPLAY_NAME, 7 ContactsContract.Contacts.CONTACT_STATUS, 8 ContactsContract.Contacts.CONTACT_PRESENCE, 9 ContactsContract.Contacts.PHOTO_ID, 10 ContactsContract.Contacts.LOOKUP_KEY, 11 }; 12 //若非空,表示是用户提供的当前使用的filter 13 String mCurFilter; 14 //用于显示列表数据的适配器对象 15 private SimpleCursorAdapter mAdapter; 16 17 @Override 18 public void onActivityCreated(Bundle savedInstanceState) { 19 super.onActivityCreated(savedInstanceState); 20 //当列表为空时,用以显示一些提示信息,实际开发中,提示文本内容应该来自于资源文件 21 setEmptyText("No Phone Numbers"); 22 //想让Fragment中的onCreateOptionsMenu生效必须先调用setHasOptionsMenu方法 23 setHasOptionsMenu(true); 24 //创建一个适配器对象,之后将被用来显示加载数据 25 mAdapter = new SimpleCursorAdapter(getActivity(), 26 android.R.layout.simple_list_item_2, 27 null, 28 new String[]{ContactsContract.Contacts.DISPLAY_NAME, ContactsContract.Contacts.CONTACT_STATUS}, 29 new int[]{android.R.id.text1, android.R.id.text2}, 0); 30 setListAdapter(mAdapter); 31 //准备loader,或者与已存在的loader重新连接,或者启动一个新的loader 32 getLoaderManager().initLoader(0, null, this); 33 } 34 35 /** 36 * Android手机不强制要求设备必须有Menu键,这样导致的问题是用户无法打开 37 * 选项菜单.但此时即可以将选项菜单设置成Action Item. 38 * 即从Android 3.0 开始为MenuItem新增如下方法: 39 * setShowAsAction(int actionEnum),该方法用于设置是否将该菜单栏 40 * 显示在ActionBar上,作为ActionItem 41 * 参数值如下: 42 * SHOW_AS_ACTION_ALWAYS:总是将该MenuItem显示在ActionBar上 43 * SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW:将该Action View折叠成普通菜单项 44 * SHOW_AS_ACTION_IF_ROOM:当ActionBar位置有足够空间时才显示该MenuItem 45 * SHOW_AS_ACTION_NEVER:不将该MenuItem显示在ActionBar上 46 * SHOW_AS_ACTION_WITH_TEXT:将该MenuItem显示在ActionBar上,且显示该菜单项的文本 47 * 当然我们最好是在xml文件中来定义菜单. 48 * 所以在menu下的item属性中指定showAsAction属性即可 49 * 该属性的值和上面提到的参数值的表达形式很类似,作用是相同的 50 * @param menu 51 * @param inflater 52 */ 53 @Override 54 public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) { 55 //放置搜索选项到ActionBar上 56 MenuItem item = menu.add("Search"); 57 item.setIcon(android.R.drawable.ic_menu_search); 58 //该方法用于设置是否将该菜单栏显示在ActionBar上 59 item.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM); 60 SearchView sv = new SearchView(getActivity()); 61 sv.setOnQueryTextListener(this); 62 item.setActionView(sv); 63 } 64 65 66 /** 67 * 当创建新的loader时被回调,由于本例只有一个loader 68 * 所以不用考虑id 69 * 首先根据是否提供有filter来选择所使用的baseUri. 70 * @param id 71 * @param args 72 * @return 73 */ 74 @Override 75 public Loader<Cursor> onCreateLoader(int id, Bundle args) { 76 Uri baseUri; 77 if (mCurFilter != null) { 78 baseUri = Uri.withAppendedPath(ContactsContract.Contacts.CONTENT_FILTER_URI, Uri.encode(mCurFilter)); 79 } else { 80 baseUri = ContactsContract.Contacts.CONTENT_URI; 81 } 82 // Now create and return a CursorLoader that will take care of 83 // creating a Cursor for the data being displayed 84 String select = "((" + ContactsContract.Contacts.DISPLAY_NAME + " NOTNULL) AND (" 85 + ContactsContract.Contacts.HAS_PHONE_NUMBER + "=1) AND (" 86 + ContactsContract.Contacts.DISPLAY_NAME + " != '' ))"; 87 //返回对该数据源的监控 88 return new CursorLoader(getActivity(), 89 baseUri, CONTACTS_SUMMARY_PROJECTION, 90 select, null, ContactsContract.Contacts.DISPLAY_NAME +" COLLATE LOCALIZED ASC"); 91 } 92 //每次数据源有更新时都会回调这个方法更新UI 93 @Override 94 public void onLoadFinished(Loader<Cursor> loader, Cursor data) { 95 // Swap the new cursor in. (The framework will take care of closing the 96 // old cursor once we return.) 97 mAdapter.swapCursor(data); 98 } 99 100 /** 101 * 当一个已创建的加载器被重置从而使其数据无效时,此方法被调用 102 * 此回调能使你发现什么时候数据将被释放以便你释放对它们的引用 103 * @param loader 104 */ 105 @Override 106 public void onLoaderReset(Loader<Cursor> loader) { 107 // This is called when the last Cursor provided to onLoadFinished() 108 // above is about to be closed. We need to make sure we are no 109 // longer using it. 110 mAdapter.swapCursor(null); 111 } 112 113 @Override 114 public boolean onQueryTextSubmit(String query) { 115 //不用管这个方法 116 return true; 117 } 118 119 /** 120 * 当ActionBar上的搜索内容改变时被回调,更新搜索过滤条件 121 * 并重启loader使用该过滤条件做一次新的查询 122 * @param newText 123 * @return 124 */ 125 @Override 126 public boolean onQueryTextChange(String newText) { 127 mCurFilter = !TextUtils.isEmpty(newText) ? newText : null; 128 getLoaderManager().restartLoader(0, null, this); 129 return true; 130 } 131 }
正如实例化SimpleCursorAdapter类那样,在回调onLoadFinished()方法调用之前尚且没有Cursor实例存在,换句话说在创建适配器之前cursor还未就绪,所以在创建适配器对象时传入的Cursor参数(27行)为null。当Cursor对象最终就绪时,我们需要把该对象添加到适配器对象中,这可以通过调用方法swapCursor()来实现(97行所示)。当最终回调onLoadReset()方法释放资源时,仍然需要swapCursor()方法来实现,只是此时我们传入参数为null(110行所示)
什么时候不要使用加载器?
虽然加载器可以非常方便的实现异步数据加载功能,但是并不是说加载器可以随便使用;正如“在应用中使用Loaders”所需要的条件指明的那样,加载器是依赖于Activity或Fragment的,因此,如果你在等待后台任务完成时,就不要使用加载器了,因为加载器将会随着Activity或Fragment的销毁而被销毁。此时,您可以通过使用Service来完成那些耗时的操作。
请记住,加载器是一种特殊组件,用以创建响应UI和异步加载UI所需数据,这就是为什么加载器的生命周期附属在创建它们的组件的生命周期中,不要滥用加载器。
Reference: