Android Loader 使用

• 每个Activity 和 Fragment 都可以使用 (3.0之前可以使用 support-lib)
• 拥有异步加载数据的功能
• 监视数据源，如果数据发生变化了，会自动传回更新后的结果
• 如果被重新创建(比如屏幕选装)了会自动连接到上次的Cursor，这样不需要重新查询数据

Loader API Summary

在使用Loader的时候需要关心的几个类和接口，总结如下

• 每个Activity和Fragment默认组合的一个抽象类，用来管理一个或多个 实例。它帮助App管理一些耗时的后台任务，同时处理好和Activity/Fragment生命周期的关系。最常见的一种用法是管理 , 当然了你可以自己写一些Loader实现来管理其他类型的数据。每个Activity和Fragment只有一个，但是一个 可以有多个 Loaders 对象。
• 用来处理和 交互的一个回调接口。比如，在 [onCreateLoader()](, android.os.Bundle)) 接口中创建一个新的 Loader。
• 一个执行异步数据加载的抽象类。它是其他Loader的基类。比如你可能会使用 ，但是你也可以实现自己的子类。当Loaders是活跃的时候，你应该监视数据源，当内容发生变化的时候把新的结果传回。
• Loader 提供的一个异步任务类（注：这应该是来取代旧的吧）。
• 是 的子类。它会查询 然后返回一个 对象。这个类基于 实现了标准的 接口协议，会在后台执行一次cursor查询不会阻塞UI。使用这个Loader是异步从 加载数据的最佳方式而不是使用 Activity或者Fragment的API来查询。

Using Loaders in an Application

本节描述如何在 App 中使用Loaders。使用Loaders的App一般包含下面这些：

• 一个 Activity 或者 Fragment
• 一个 实例
• 一个 来加载 驱动的数据。或者你可以实现Loader或者的子类来加载其他的数据源。
• 实现 回调。这里是你创建新的loader并管理它的地方。
• 一个数据源，比如一个使用 的数据源 。

Starting a Loader

在 Activity/Fragment 中 LoaderManger 管理了一个或多个 Loader 对象。每个 Activity/Fragment 仅有一个 LoaderManager 对象。

一般情况下，会在 activities 的 onCreate 方法里面初始化 Loader，或者在 fragment 的 onActivityCreated 方法里面。大概这样：

// Prepare the loader.  Either re-connect with an existing one,
// or start a new one.
getLoaderManager().initLoader(0, null, this);

• 唯一的ID来标识这个Loader（本例中 ID = 0）
• 可选的参数用来构造Loader（本例中是null）
• 接口实现，LoaderManager 会通过这个接口来回调一些 loader 事件。（ 本例中的本地方法实现了这个接口）

• 如果指定Id的loader已经存在了，那么会复用上次的
• 如果不存在，那么 [initLoader()](, android.os.Bundle, android.app.LoaderManager.LoaderCallbacks<D>)) 方法会执行 方法的 [onCreateLoader()](, android.os.Bundle)) 函数。这里你需要初始化，并返回一个 Loader 对象。

在任何一种情况下，LoaderManager.LoaderCallbacks 的实现都会和 loader 联系在一起，并且在 loader 状态发生变化的时候被调用。如果调用 initLoader() 的时候，loader已经初始化并且已经加载了数据，那么系统会调用 onLoaderFinished() 方法（与initLoader() 方法同时）。所以你应该考虑到这种情况，详细情况见 onLoaderFinished 部分的讨论。

Restarting a Loader

当你使用上面的 initLoader() 方法时，如果指定ID的loader已经存在，那么它会复用之前的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交互。像 CursorLoader 这样的 loaders 即使被停止也应该保持它的数据。这样可以使App在activity或者fragment的onStop和onStart() 方法执行前后也能一直持有数据，这样，当用户重新回到App的时候，他们不需要等待数据的重新加载。可以使用 LoaderManager.LoaderCallbacks 方法来决断何时创建一个新的 loader，何时告知App来停用一个 loader。

LoaderManager.LoaderCallbacks 回调包含下面几个方法：

• onCreateLoader() - 根据指定的 ID 初始化并创建一个新的 loader。
• onLoaderFinished() - 当之前 loader 完成了数据加载后调用。
• onLoaderReset() - 当之前的 loader 被重置时调用，这样，它不能在提供数据。

下面会更详细的讨论这些方法。

onCreateLoader

当你尝试访问一个 Loader （比如，通过 initLoader 方法），它会去查看指定ID的 loader 是否已经存在，如果不存在的话，它会触发 LoaderManager.LoaderCallbacks 的 onCreateLoader() 方法。在这里，你会创建一个新的 loader，通常这会是一个 CursorLoader, 但是你也可以实现你自己的 Loader 子类。

在这个例子中， onCreateLoader 回调方法创建一个 CursorLoader。你必须使用 CursorLoader 的构造方法创建 CursorLoader，这些参数会用来完成一个完整 ContentProvider 请求。 具体的说，它需要：

• uri - 指向数据源的 URI
• projection - 指定哪些列(columns)会被返回的数组，传入 null 的话会返回所有的数据，这样并不高效。
• selection - 指定哪些行（rows）会被返回的过滤条件，会被格式化为 SQL 语句中的 WHERE 语法（不要包含 WHERE 自身）。传 null 将返回所有的行。
• selectionArgs - 如果你在 selection 中使用 ?s 语法，那么这些值会被 selectionArgs 参数替换，替换顺序按照在 selection 中的顺序。
• sortOrder - 如何对返回结果排序，它会被格式化为 SQL 的 ORDER BY 语句（排除 ORDER BY 自身）。传入 null 的话使用默认顺序（也许是无序的）。

eg：

// 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 完成了数据加载之后调用。这个方法可以保证在它最后加载的数据被释放之前被调用（This method is guaranteed to be called prior to the release of the last data that was supplied for this loader）。这时候，你应该移除所有的对旧数据的使用（因为这些旧的数据很快会被释放掉），但是你不必手动释放这些数据因为loader 会自己管理。

Loader 在得知App不再使用它的数据之后会立刻释放持有的数据，比如来自 CursorLoader 的数据是一个cursor，但是你不需要调用 close() 方法。如果这个 cursor 是放在 CursorAdapter 中使用的，你应该掉用 swapCursor() 方法，这样不会关闭旧的 Cursor.

eg:

// 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 被重置的时候调用，这样它的的数据将不再可用。这个回调接口让你知道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 展示一个 ListView, 引用的数据来自联系人的 ContentProvider. 它使用 CursorLoader 来管理对 ContentProvider 的查询。

对于一个需要访问联系人列表的应用，必须要在 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);
    }
}

More Example

在 ApiDemos 中有几个不同的例子，展示了如何使用 loaders：

• LoaderCursor - 上面例子的完整版本
• LoaderThrottle - 如何使用 throttling 来在 ContentProvider 数据变化时减少查询次数的例子。