android--加载器loader详解

Loaders

loader在android 3.0之后才被引入，它简化了在activity和fragment中异步加载数据的步骤（个人认为简化是次要的，更重要的是优雅的实现了异步加载），loader有如下特点：

适用于每个activity和fragment

提供异步加载的实现方法

监听数据源的一举一动，在数据发生变更时自动返回新的结果

当由于配置改变而被重新创建后，它们自动重连到上一个加载器的游标，所以不必重新查询数据

loader api简要说明

使用loader的过程中可能会遇到这些类和接口：

Class/Interface	描述
LoaderManager	一个与activity和fragment相关联的抽象类，它管理一个或多个loader实例，帮助一个应用管理那些与Activity或Fragment的生命周期相关的长时间运行的的操作。最常见的方式是与一个CursorLoader一起使用，然而应用也可以自己写一个加载其他数据类型或者数据源的loader。 每个activity或fragment只有一个LoaderManager。但是一个LoaderManager可以拥有多个加载器。
LoaderManager.LoaderCallbacks	一个用于客户端与LoaderManager交互的回调接口。例如，你使用回调方法onCreateLoader()来创建一个新的加载器。
Loader	一个执行异步数据加载的抽象类。它是加载器的基类。你可以使用典型的CursorLoader，但是你也可以实现你自己的子类。一旦加载器被激活，它们将监视它们的数据源并且在数据改变时发送新的结果。
AsyncTaskLoader	提供一个AsyncTask来执行异步加载工作的抽象类。
CursorLoader	AsyncTaskLoader的子类，它查询ContentResolver然后返回一个Cursor。这个类为查询cursor以标准的方式实现了加载器的协议，它的游标查询是通过AsyncTaskLoader在后台线程中执行，从而不会阻塞界面。使用这个加载器是从一个ContentProvider异步加载数据的最好方式。相比之下，通过fragment或activity的API来执行一个被管理的查询就不行了。

上面所列的类和接口们是你在你的应用中要实现加载器时的核心组件。你的每个加载器并不一定需要所有的组件，但是你总是需要引用LoaderManager来初始化一个加载器。

使用加载器

一个使用加载器的应用会典型的包含如下组件：

• 一个Activity或Fragment．

• 一个LoaderManager的实例．

• 一个加载被ContentProvider所支持的数据的CursorLoader．或者，你可以从Loader或AsyncTaskLoader实现你自己的加载器来从其它源加载数据．

• 一个LoaderManager.LoaderCallbacks的实现．这是你创建新的加载器以及管理你的已有加载器的引用的地方．

• 一个显示加载器的数据的途径，例如使用一个SimpleCursorAdapter．

• 一个数据源，比如当是用CursorLoader时，它将是一个ContentProvider．

启动加载器

LoaderManager管理一个Activiry或Fragment中的一个或多个加载器．但每个activity或fragment只拥有一个LoaderManager．

你通常要在activity的onCreate()方法中或fragment的onActivityCreated()方法中初始化一个加载器．你可以如下创建：

// 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调用以报告加载器的事件，在这个例子中，类本实现了这个接口，所以传的是它自己：this．

initLoader()保证一个加载器被初始化并激活．它具有两种可能的结果：

• 如果ID所指的加载器已经存在，那么这个加载器将被重用．

• 如果加载器不存在，initLoader()就触发LoaderManager.LoaderCallbacks的方法onCreateLoader()．这是你实例化并返回一个新加载器的地方．

在这两种情况中，传入的LoaderManager.LoaderCallbacks的实现都与加载器绑定在一起．并且会在加载器状态变化时被调用．如果在调用这个方法时，调用者正处于启动状态，并且所请求的加载器已存在并产生了数据，那么系统会马上调用onLoadFinished()(也就是说在initLoader()还在执行时)．所以你必须为这种情况的发生做好准备．

注意initLoader()返回所创建的加载器，但是你不需保存一个对它的引用．LoaderManager自动管理加载器的生命．LoaderManager会在需要时开始和停止装载动作，并且维护加载器的状态和它所关联的内容．这意味着，你很少与加载器直接交互．你通常都是使用LoaderManager.LoaderCallbacks的方法们在某个事件发生时介入到数据加载的过程中．

loader的重启与回调

重启

当你使用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 ;
}

<p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;"><span style="box-sizing: border-box; border: 0px; margin: 0px; padding: 0px;">回调</span><br style="box-sizing: border-box;" /></p><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">LoaderManager.LoaderCallbacks是一个回调接口，它使得客户端可以与LoaderManager进行交互．</p><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">加载器，一般指的是CursorLoader，我们希望在它停止后依然保持数据．这使得应用可以在activity或fragment的 onStop()和onStart()之间保持数</p><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">据，所以当用户回到一个应用时，它们不需等待数据加载．你使用LoaderManager.LoaderCallbacks的方法们，在需要时创建新的加载器，并且告诉应用</p><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">什么时候要停止使用加载器的数据．</p><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">LoaderManager.LoaderCallbacks包含以下方法们：</p><ul class=" list-paddingleft-2" style="box-sizing: border-box; border: 0px; margin: 0px 0px 10px; padding: 0px; list-style: none;"><li style="box-sizing: border-box; border: 0px; margin: 0px; padding: 0px; list-style: none;"><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">onCreateLoader() —跟据传入的ID，初始化并返回一个新的加载器．</p></li><li style="box-sizing: border-box; border: 0px; margin: 0px; padding: 0px; list-style: none;"><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">onLoadFinished() —当一个加载器完成了它的装载过程后被调用．</p></li><li style="box-sizing: border-box; border: 0px; margin: 0px; padding: 0px; list-style: none;"><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">onLoaderReset() —当一个加载器被重置而什其数据无效时被调用．</p></li></ul><h4 style="box-sizing: border-box; border: 0px; margin: 0px; padding: 0px; font-size: 1em;"><a target=_blank name="t2" style="box-sizing: border-box; color: rgb(15, 153, 50); border: 0px; margin: 0px; padding: 0px; transition: opacity 0.2s; -webkit-transition: opacity 0.2s; background-color: transparent;"></a><a target=_blank name="onCreateLoader" style="box-sizing: border-box; color: rgb(15, 153, 50); border: 0px; margin: 0px; padding: 0px; transition: opacity 0.2s; -webkit-transition: opacity 0.2s; background-color: transparent;"></a></h4><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;"><span style="box-sizing: border-box; border: 0px; margin: 0px; padding: 0px;">onCreateLoader</span></p><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">当你试图去操作一个加载器时(比如，通过initLoader())，会检查是否指定ID的加载器已经存在．如果它不存在，将会触发LoaderManager.LoaderCallbacks的方法<a target=_blank href="http://developer.android.com/reference/android/app/LoaderManager.LoaderCallbacks.html#onCreateLoader%28int,%20android.os.Bundle%29" style="box-sizing: border-box; color: rgb(15, 153, 50); text-decoration: none; border: 0px; margin: 0px; padding: 0px; -webkit-transition: opacity 0.2s; transition: opacity 0.2s; background-color: transparent;">onCreateLoader()</a>．这是你创建一个新加载器的地方．通常这个加载器是一个CursorLoader，</p><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">但是你也可以实现你自己的加载器．</p><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">在下面的例子中，回调方法onCreateLoader()创建一个CursorLoader．你必须使用构造方法来建立CursorLoader，构造方法需要向ContentProvider执行</p><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">一次查询的完整信息作为参数，它尤其需要：</p><ul class=" list-paddingleft-2" style="box-sizing: border-box; border: 0px; margin: 0px 0px 10px; padding: 0px; list-style: none;"><li style="box-sizing: border-box; border: 0px; margin: 0px; padding: 0px; list-style: none;"><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">uri —要获取的内容的URI．</p></li><li style="box-sizing: border-box; border: 0px; margin: 0px; padding: 0px; list-style: none;"><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">projection —要返回的列组成的列被．传入null将会返回所有的列，但这是低效的．</p></li><li style="box-sizing: border-box; border: 0px; margin: 0px; padding: 0px; list-style: none;"><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;"><a target=_blank name="__DdeLink__11630_1772819336" style="box-sizing: border-box; color: rgb(15, 153, 50); border: 0px; margin: 0px; padding: 0px; transition: opacity 0.2s; -webkit-transition: opacity 0.2s; background-color: transparent;"></a>selection —一个过滤器，表明哪些行将被返回．格式化成类似SQLWHERE 语句的样子(除了没有WHERE)．传入null将返回所有的行．</p></li><li style="box-sizing: border-box; border: 0px; margin: 0px; padding: 0px; list-style: none;"><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">selectionArgs —你可以在selection中包含一些'?'，它将被本参数的值替换掉．这些值出现的顺序与'?'在selection中出现的顺序一至．值将作为字符串．</p></li><li style="box-sizing: border-box; border: 0px; margin: 0px; padding: 0px; list-style: none;"><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">sortOrder —如何为行们排序．格式化成类似于SQLORDER BY 语句的样字(除了没有ORDERBY)．传入null将使用默认顺序，默认顺序可能是无顺序．</p></li></ul><p style="box-sizing: border-box; border: 0px; margin-top: 8px; margin-bottom: 8px; padding-top: 0px; padding-bottom: 0px; line-height: 22px;">例子：</p>

// 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()方法，以使旧的游标不被关闭．例如：

//这个Adapter被用于显示列表的数据．
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()：

// 这个Adapter被用于显示列表的数据．
SimpleCursorAdapter mAdapter;
...
public void onLoaderReset(Loader<Cursor> loader) {
    //此处是用于上面的onLoadFinished()的游标将被关闭时执行， 我们需确保我们不再使用它．
    mAdapter.swapCursor( null );
}

完整例子

这个例子实现了一个Fragment显示一个包含从联系人contentprovider返回查询数据的ListView的内容的功能．它使用一个CursorLoader来管理对provider的查询．

为了能从用户的联系人中取得数据，本例的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 );
    }
}