本文主要从Loader入手, 去分析Loader使用、Loader的源码分析等,主要分为以下四篇:
本文基于原生的 Android8.0源码进行分析。以下是第四篇内容
1、CursorLoader简介
CursorLoader是Google封装的很好的专门用于数据库读取获取Cursor的Loader类, 在Google源代码中被大量使用, 比如联系人、短信等系统应用, 因为这些应用内部都包含了大量的读取数据库的操作。CursorLoader的使用极大的简化了开发者对于Cursor的管理, 从而更专注于应用的开发。
2、CursorLoader的构造方法
前文已提到, CursorLoader继承自AsyncTaskLoader, 我们这里贴一下CursorLoader的继承关系:
java.lang.Object
↳ android.content.Loader
↳ android.content.AsyncTaskLoader
↳ android.content.CursorLoader
CursorLoader已经完全实现了Loader所有必须实现的方法, 我们不用再想第一篇文中介绍得那样, 需要去做什么了, 不过如果想有一些特殊操作, 依然可以继承CursorLoader去再做一些改变,使用CursorLoader可以选择两种构造方法实现, 我们看一下CursorLoader两个构造方法:
构造方法 1:
public CursorLoader(Context context, Uri uri, String[] projection, String selection,
String[] selectionArgs, String sortOrder) {
super(context);
mObserver = new ForceLoadContentObserver();
mUri = uri;
mProjection = projection;
mSelection = selection;
mSelectionArgs = selectionArgs;
mSortOrder = sortOrder;
}
构造方法 2:
public CursorLoader(Context context) {
super(context);
mObserver = new ForceLoadContentObserver();
}
public Uri getUri() {
return mUri;
}
public void setUri(Uri uri) {
mUri = uri;
}
public String[] getProjection() {
return mProjection;
}
public void setProjection(String[] projection) {
mProjection = projection;
}
public String getSelection() {
return mSelection;
}
public void setSelection(String selection) {
mSelection = selection;
}
public String[] getSelectionArgs() {
return mSelectionArgs;
}
public void setSelectionArgs(String[] selectionArgs) {
mSelectionArgs = selectionArgs;
}
public String getSortOrder() {
return mSortOrder;
}
public void setSortOrder(String sortOrder) {
mSortOrder = sortOrder;
}
两个构造方法不同, 但是最后所需的参数都是相同的, 不过一个把参数放在了构造方法里面, 一个可以单独设置。
3、CursorLoader的使用
CursorLoader的使用就简单了,通过构造方法创建好对象后, 直接使用即可, 和普通的Loader没什么区别, 只需要再LoaderCallback接口的onCreateLoader()方法中创建CursorLoader即可。
关键在于构造方法的参数, 传入自己要访问的数据库的Uri, 然后要访问的数据, 以及对返回的数据排序等,使用时这些参数要格外注意。
介绍一下传入的参数:
Context context, Uri uri, String[] projection, String selection,
String[] selectionArgs, String sortOrder
- context : 上下文
- uri : 要访问数据库的 uri地址
- projection : 对应于数据库语句里的 某列, 如果只需要访问某几列, 则传入这几列的名字即可, 如果不传, 则默认访问全部数据。例如 学生对象, 有:name,number,age,sex 等, 如果只需要查询姓名和学号, 则传入[“name”,“number”]即可。
- selection :一些特殊的筛选条件,比如要求年龄大于10, 则传入 “age > ?”
- selectionArgs: 传入具体的参数, 会替换上述 selection中的?
- sortOrder: 排序规则, 可以为空
其实这些参数最后都会拼凑成数据库语句, 熟悉数据库语句的朋友应该对这个不陌生。
下面看一个完整的示例代码:
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);
}
}