Android官方文档—APP组件（Activities）（Loaders）

加载器

在Android 3.0中引入，加载器可以轻松地在活动或片段中异步加载数据。加载器具有以下特点：

• 它们适用于每个Activity和Fragment。
• 它们提供异步数据加载。
• 他们监控数据来源，并在内容发生变化时提供新的结果。
• 在配置更改后重新创建时，它们会自动重新连接到最后一个加载器的光标。因此，他们不需要重新查询他们的数据。

Loader API摘要 

---

在应用程序中使用加载器可能涉及多个类和接口。它们总结在此表中：

Class/Interface	Description
LoaderManager	与Activity或Fragment关联的抽象类，用于管理一个或多个Loader实例。这有助于应用程序结合Activity或Fragment生命周期管理长时间运行的操作;最常见的用途是使用CursorLoader，但是应用程序可以自由编写自己的加载器来加载其他类型的数据。 每个活动或片段只有一个LoaderManager。但是LoaderManager可以有多个加载器。
LoaderManager.LoaderCallbacks	客户端与LoaderManager交互的回调接口。例如，您使用onCreateLoader（）回调方法来创建新的加载器。
Loader	一个执行异步数据加载的抽象类。这是加载器的基类。您通常会使用CursorLoader，但您可以实现自己的子类。当加载器处于活动状态时，它们应监视其数据源并在内容更改时提供新结果。
AsyncTaskLoader	抽象加载器，提供AsyncTask来完成工作。
CursorLoader	AsyncTaskLoader的子类，用于查询ContentResolver并返回Cursor。此类以标准方式实现Loader协议以查询游标，构建在AsyncTaskLoader上以在后台线程上执行游标查询，以便它不会阻止应用程序的UI。使用此加载器是从ContentProvider异步加载数据的最佳方式，而不是通过片段或活动的API执行托管查询。

 上表中的类和接口是您将在应用程序中实现加载器的基本组件。对于您创建的每个加载器，您不需要所有这些加载器，但是您始终需要引用LoaderManager以初始化加载器和Loader类的实现，例如CursorLoader。以下部分介绍如何在应用程序中使用这些类和接口。

在应用程序中使用加载器

---

本节介绍如何在Android应用程序中使用加载器。使用加载器的应用程序通常包括以下内容：

• Activity或片段
• LoaderManager的一个实例。
• 用于加载由ContentProvider支持的数据的CursorLoader。或者，您可以实现自己的Loader或AsyncTaskLoader子类来从其他来源加载数据。
• LoaderManager.LoaderCallbacks的实现。您可以在此处创建新的加载器并管理对现有加载器的引用。
• 一种显示加载程序数据的方法，例如SimpleCursorAdapter。
• 使用CursorLoader时的数据源，如ContentProvider。

启动装载器

LoaderManager管理Activity或Fragment中的一个或多个Loader实例。每个活动或片段只有一个LoaderManager。

您通常在活动的onCreate（）方法或片段的onActivityCreated（）方法中初始化Loader。你这样做如下：

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

initLoader（）方法采用以下参数：

• 标识加载程序的唯一ID。在此示例中，ID为0。
• 在构造时提供给加载器的可选参数（在本例中为null）。
• 一个LoaderManager.LoaderCallbacks实现，LoaderManager调用它来报告加载器事件。在这个例子中，本地类实现了LoaderManager.LoaderCallbacks接口，因此它将引用传递给它自己，this。

initLoader（）调用确保加载器已初始化并处于活动状态。它有两种可能的结果：

• 如果ID指定的加载器已存在，则重用最后创建的加载器。
• 如果ID指定的加载器不存在，则initLoader（）将触发LoaderManager.LoaderCallbacks方法onCreateLoader（）。这是您实现代码以实例化并返回新加载器的地方。有关更多讨论，请参阅onCreateLoader一节。

在任何一种情况下，给定的LoaderManager.LoaderCallbacks实现都与加载器相关联，并在加载器状态改变时被调用。如果在此调用时调用者处于启动状态，并且请求的加载器已经存在并且已生成其数据，则系统立即调用onLoadFinished（）（在initLoader（）期间），因此您必须为此做好准备发生。有关此回调的更多讨论，请参阅onLoadFinished。

请注意，initLoader（）方法返回已创建的Loader，但您无需捕获对它的引用。 LoaderManager自动管理加载程序的生命周期。 LoaderManager在必要时启动和停止加载，并维护加载程序及其相关内容的状态。这意味着，您很少直接与加载器交互（尽管使用加载器方法来微调加载器的行为，请参阅LoaderThrottle示例）。您最常使用LoaderManager.LoaderCallbacks方法在特定事件发生时干预加载过程。有关此主题的更多讨论，请参阅使用LoaderManager回调。

重新启动加载器

当您使用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回调

LoaderManager.LoaderCallbacks是一个回调接口，允许客户端与LoaderManager进行交互。

加载器，特别是CursorLoader，在被停止后应该保留它们的数据。这允许应用程序在活动或片段的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中包含多个？，它将被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);
}

示例

---

作为示例，这里是片段的完整实现，其显示包含针对联系人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);
    }
}

更多例子

ApiDemos中有一些不同的示例说明了如何使用加载器：

• LoaderCursor - 上面显示的完整版代码段。
• LoaderThrottle - 如何使用限制来减少内容提供程序在数据更改时执行的查询数量的示例。

有关下载和安装SDK示例的信息，请参阅获取示例。