Loader用法

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信息。

参考资料

笔记: Loader 加载器