Loaders

Android 3.0以后，使用加载器在fragment和activity中异步加载数据非常方便。loaders有以下特点：
1.可用于每个activity和fragment.
2.异步加载数据。
3.监控数据源，当有变化时把新结果传递过来。
4.当配置发生改变，重新创建时，会自动连接上个loader的cursor,不需要重新询数据。

Loader API Summary

在app中使用loaders时，有多个类和接口。总结如下：

上边表中的类和接口是我们在使用loader时主要使用到的组件。创建一个loader时不是必须使用它们所有的，但是我们通常需要使用到LoaderManager来初始化一个loader和实现一个Loader(比如CursorLoader)。下边将展示如何在app中使用他们。

在app中使用Loaders

这一部分介绍如何在app中使用Loaders。一个使用Loaders的app主要包括以下部分：
1.一个activity或者fragment.
2.一个LoaderManager对象。
3.一个从ContentProvider获取数据的CursorLoader。或者可以使用AsyncTaskLoader或继承Loader来从其它数据源加载数据。
4.一个LoaderManager.LoaderCallbacks的实现。可以创建新的loaders并管理已有的loader.
5.展示数据的方式，比如SimpleCursorAdapter。
6.使用CursorLoader的数据源，比如ContentProvider

启动一个loader

LoaderManager在activity或者fragment中管理一个或者多个loader.每个activity或者fragment中只有一个LoaderManager实例。

我们可以在activity的onCreate或者fragment的onActivityCreated中初始化一个Loader。如下所示：

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

initLoader接收几个参数：
1.　一个id作为唯一标示。示例中是0.
2.在构造时传入的可选参数(示例中为null).　
3.LoaderManager.LoaderCallbacks的实现，LoaderManager调用它来通知加载事件。在这个示例中，类自己实现了接口，所以传递的是this.

initLoader保证会初始化一个loader.有两个可能的输出结果：
1.如果id已经有了，就会重用上个loader.
2.如果id不存在，initLoader会触发LoaderManager.LoaderCallbacks的onCreateLoader。这里我们会初始化并返回一个loader.参阅onCreateLoader来了解更多。

不论哪种情况，LoaderManager.LoaderCallbacks的实现总是关联一个loader,当loader的状态改变时会被调用。如果是在开始状态，loader已经存在，并且已经有数据了，系统会立刻调用onLoadFinished.所以我们必须做好这种准备。参阅onLoadFinished来了解更多。

注意initLoader返回已经创建的Loader，但是我们不需要声明变量来指向它。LoaderManager会自动管理loader的生命周期。LoaderManager会在必要时启动和停止加载，并维护loadet的状态和它关联的数据。这也意味着，我们基本上不需要直接和loaders交互(有关使用加载器方法调整加载器行为的示例，请参阅 LoaderThrottle 示例)。只有在特定情况下，我们才会使用LoaderManager.LoaderCallbacks来参与加载的过程。参阅Using the LoaderManager Callbacks来加载更多。

重启一个loader

当我们调用initLoader时，如果已经存在，会使用已经有的。如果没有，才会创建。但是有的时候我们需要扔掉原来的数据，重新开始。

为了能放弃老数据，我们可以使用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;
}

使用LoaderManager Callbacks

LoaderManager Callbacks是客户端和LoaderManager进行交互的回调接口。

Loaders(尤其是CursorLoader)是能够在停止后还保留数据的。这就可以让app可以在activity和fragment的onStop和onStart之间传递数据，所以当用户返回app时，不需要重新加载数据。使用 LoaderManager.LoaderCallbacks方法可以知道何时创建了一个新的loader，也可以通知app何时停止使用loader的数据。

LoaderManager.LoaderCallbacks 有下列方法:

1.onCreateLoader() — 给指定的id,初始化并返回一个新的loader.
onLoadFinished() — 刚才创建的loader加载完成时调用。
onLoaderReset() — 刚才创建的loader被重置且数据不可用。

下面会更详细地描述这些方法。

onCreateLoader

当我们想要访问一个loader时(比如，通过initLoader),他会检查指定id的loader是否已经存在。如果不存在，会触发LoaderManager.LoaderCallbacks的onCreateLoader()。我们就是在这里创建一个新的loader. CursorLoader是一个典型,我们也可以实现自己的loader.

在这个例子中,onCreateLoader创建了一个CursorLoader.我们必须使用构造方法来创建,他需要用来查询ContentProvider所需要的所有信息。具体的说，他需要：
1.uri — 检索内容的URI.
2.projection — 查询列表的列。传入null会返回所有，但是效率比较低。
3.selection — 行的过滤器,最后被格式化成为一个SQL Where语句(不包括where). 传入null会返回所有.
4.selectionArgs — 我们可以在selction中使用占位符，然后使用selectionArgs来替换它们。这些值都会绑定成string.
5.sortOrder — 如何排序,最后格式化成为一个SQL ORDER BY 语句 (除了 ORDER BY 本身). 传入null会使用默认排序，可能是无序的。

比如：

 // If non-null, this is the current filter the user has provided.
String mCurFilter;
...
public Loader 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确定app不会再使用数据，他就会释放数据。比如，如果是一个CursorLoader的数据，我们不应该调用close。如果cursor在CursorAdapter中，我们应该使用swapCursor来确保老的Cursor不会被关闭。比如：

// This is the Adapter being used to display the list's data.
SimpleCursorAdapter mAdapter;
...

public void onLoadFinished(Loader 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被重置时调用，这样数据就不能访问了。这个回调能够让我们知道数据何时将要被释放这样我们就能够及时移除自己的应用。

这个方法使用null来调用swapCursor:

// This is the Adapter being used to display the list's data.
SimpleCursorAdapter mAdapter;
...

public void onLoaderReset(Loader 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来展示一个联系人的查询结果的完整示例。使用CursorLoader来管理对provider的查询。

为了能够访问用户的通讯录，清单文件中必须包含READ_CONTACTS的权限，如下所示：

public static class CursorLoaderListFragment extends ListFragment
        implements OnQueryTextListener, LoaderManager.LoaderCallbacks {

    // 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 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 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 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);
    }
}