【Android API指南】App组件(4) - Activities(2) - Loaders

Loader在Android3.0开始引进，作用的异步加载数据到activity或者fragment。有下面这些特征：

• 任何activity和fragment都可用。
• 提供异步加载数据功能。
• 监控数据源，当数据改变时，传递新数据。
• 当配置改变并重启时，自动连接并加载最后的游标。

API概述

Class/Interface	Description
LoaderManager	抽象类，用来管理一个或多个Loader实例。帮助程序管理activity或者fragment与长时间操作的联系。通常和CursorLoader一起使用，程序可以自由的编写自己的loader来加载不同的数据。 每个activity或者fragment只有一个LoaderManager，但是一个LoaderManager可以管理多个loader。
LoaderManager.LoaderCallbacks	连接LoaderManager的客户端回调接口，例如，你可以使用onCreateLoader()回调方法来创建一个新的loader。
Loader	实现异步加载数据的抽象类，你可以使用CursorLoader，也可以继承Loader实现自己的子类。如果loader被激活，那么应该监控数据变化。
AsyncTaskLoader	提供一个AsyncTask。
CursorLoader	AsyncTaskLoader的子类，用来取得ContentResolver然后返回一个Cursor。这个类实现了Loader查询cursor的标准方法：创建AsyncTaskLoader在后台线程执行cursor查询，防止UI线程被阻塞。

在程序中使用Loader

使用步骤：

• 一个Activity或Fragment。
• 一个LoaderManager的实例。
• 使用CursorLoader从ContentProvider加载数据。当然，你也可以继承Loader或AsyncTaskLoader来实现自定义加载。
• 一个LoaderManager.LoaderCallbacks的实现。创建loader或管理loader使用。
• 展示loader的数据，例如使用SimpleCursorAdapter。
• 数据源，比如使用ContentProvider。

开始一个Loader

通常在activity的onCreate()方法中初始化一个loader，或者在fragment的onActivityCreated()方法中初始化：

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

initLoader的三个参数：

• loader独一无二的ID，例子中为0；
• 可选参数，在构造函数上提供一个loader。
• 一个LoaderManager.LoadCallbacks的实现，例子中的类实现了这个接口，所以可以传递this。

initLoader()的调用确保一个loader被初始化并激活，它有两个可能的结果：

• 如果ID已经存在，已经创建的loader被重用。
• 如果ID不存在，那么触发LoaderManager.LoaderCallbacks的onCreateLoader()方法，在这个方法中可以实例化一个loader。

不论是那种情况，LoaderManager.LoaderCallbacks的实现都是和loader相关的，当loader状态改变时，也会被调用。如果loader已经存在，数据也已经生成，这时候状态的改变的话，就会调用onLoadFinished()。

initLoader()方法能返回Loader，不过你不需要引用它，因为LoaderManager会自动管理。

重启一个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;
}

使用LoaderManager回调

LoaderManager.LoaderCallbacks是一个回调接口，让客户端和LoaderManager关联。

Loader允许activity或者fragment通过onStop()和onStart()保持数据，这样数据就不需要重新加载。使用LoaderManager.LoaderCallbacks函数来知道什么时候创建一个loader，什么时候停止加载loader数据。

LoaderManager.LoaderCallbacks包括3个方法：

• onCreateLoader() - 初始化，然后返回一个赋了ID的Loader。
• onLoadFinished() - 当前面创建的Loader已经完成了加载时调用。
• onLoaderReset() - 当前面创建的loader被重新设置时调用，然后设置它的数据为不可用。

onCreateLoader

当你要访问loader时，会检测这个ID是否存在，不存在的话就调用onCreateLoader()方法创建一个新的。

这个例子中我们创建一个CursorLoader，因为要执行ContentProvider的查询，所以我们需要：

• uri - 检索内容的URI
• projection - 需要返回的列的列表。null的话是返回全部列。
• selection - 一个过滤器指定返回哪一行，和sql语句中的WHERE类似，null的话就返回所以行。
• selectionArgs - 你可能包含一些？号在selection中，在这个参数中的值会替换selection中的？号的内容。
• sortOrder - 和sql中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会释放那些很久没使用的数据。比如，如果数据是一个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);
}

实例

这个例子实现了Fragment从联系人content provider取得信息展示一个listview，然后使用CursorLoader来管理数据提供者。

要使用联系人信息，需要在清单文件中声明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);
    }
}