Android Loader解析

概述

Google在Android3.0引入了loaders,目的是为了在Activity或Fragment里异步加载数据更加容易。Loaders有一下这些特点：

• 在任何Activity以及Fragment中可用。
• 异步加载数据。
• 监听数据资源，在数据源发生改变时可以得到新的数据。
• 能够自动连接上一次的Cursor对象，不需要重复查询数据。

如果在3.0之前，做一个图片资源查看器，你可以需要自己去做所以的事情。但是3.0之后有了Loaders，你只需要告诉它你要什么，然后躺赢就行了啦。就是这么屌！什么？你还不知道Loaders？那还不快来get新技能。

Loaders Api总结

Class/interface	介绍
LoaderManager	看名字就知道，用来管理一个或者多个loader实例进行耗时操作。
LoaderManager.LoaderCallbacks	用来与LoaderManager进行交互的回调接口，有了它我们就知道何时创建loader何时数据饭回来了
Loader	真正去异步加载数据的一个抽象类，这是所有loader的父类，最典型的就是CursorLoader。
AsyncTaskLoader	看名字就很好理解了，一个用AsycTask机制去加载数据的Loader
CursorLoader	对Android中ContentProvider有了解的都知道用ContentProvider查询数据之后会返回一个Cursor对象，只是具体的操作我们需要处理，而CursorLoader就是这些操作的一个合体，通过它，可以更方便的查询数据

上面对Loaders相关的api进行了介绍，接下来我们来看看怎么通过Loader去获取数据。

在应用中使用Loaders

在应用中使用Loaders加载数据通常需要以下几点:

• 一个Activity或者一个Fragment
• 一个LoaderManager
• 一个CursorLoader用来加载数据（我们可以实现自己的loader，但是大部分情况下不需要这么做，Android提供的CursorLoader已经足够了）
• 在Activity或者Fragment中实现LoaderManager.LoaderCallbacks接口，LoaderCallbacks回调会让我们去创建一个loaders或者管理已经存在的loaders
• 根据情况的不同需要不同的展示数据的方式

这里介绍使用Loaders的步骤，接下来我们就根据上面的步骤来具体学习一下。

开启一个Loader

对于第一步Activity和Fragment很简单就不了

LoaderManager类通常和Activity和Fragment交互，用来管理一个或者多个Loaders实例,每个Fragment和Activity只能有一个LoaderManager。

我们可以在Activity或者Fragment中通过getLoaderManager()获取LoaderManager.

一般我们会在Activity的onCreate方法或者Fragment中的onCreateView方法中初始化一个loader

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

第一个参数代表创建的loader唯一id,第一个参数为可选参数，这里填为null,第三个参数就是上面提到的LoaderManager.LoaderCallbacks接口。这里直接传入this,在当前Activity处理回调。

initLoader() 方法能够确保创建的loader是新创建的还是已经创建的

上面我们提到第一个参数为id,用来区分loader，如果调用initLoader指定的id已经存在，则直接重用之前的loader,否则才需要重新创建。

在任何情况下，LoaderManager.LoaderCallbacks的实现总是和一个Loaders关联，我们在LoaderCallbacks的onCreateLoader方法中创建一个Loaders，数据加载完成后，LoaderManager.LoaderCallbacks会回调onLoadFinished。

getLoaderManager().initLoader(0, null, this);会返回一个创建好的loader对象，但是我们不可以引用它做任何操作，因为LoaderManager会自动的管理它的生命周期

重启一个Loader

有时候考虑这种情况，我们手机上的数据发生了改变我们需要重新获取其他条件的数据。其实我们不需要再次调用initLoader。只需要调用restartLoader()方法。
下面的代码是一个典型的在查询条件发生改变时的查询情况

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

代码很简单，添加了过滤条件，然后调用getLoaderManager().restartLoader(0, null, this);重新启动Loaders

使用 LoaderManager Callbacks

LoaderManager.LoaderCallbacks是一个让客户端和LoaderManager交互的一个接口。
使用LoaderManager.LoaderCallbacks回调来确定什么时候去创建一个新loader、告诉应用什么时候数据加载结束了。

LoaderManager.LoaderCallbacks 包含以下方法:

• onCreateLoader() — 初始化并且返回一个拥有被给予id的Loader
• onLoadFinished() — 当先前创建的Loader数据加载完成时调用
• onLoaderReset() — 当先前创建的Loader被重置，导致数据不可用时被调用

结下来详细讲解上面的三个回调方法。

onCreateLoader()

当调用initLoader()去获取一个loader对象的时候，LoaderManager去检查给定id的loader是否存在，如果不存在，就会触发 LoaderManager.LoaderCallbacks的onCreateLoader()方法。我们需要在这个方法里创建我们的loader。

请看例子

 //过滤条件
String mCurFilter;
...
public Loader<Cursor> onCreateLoader(int id, Bundle args) {
    // 该方法会在需要一个新Loader对象的时候调用. 
    // 该例子只需要创建一个Loader，所有并不关心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;
    }

    //创建一个并且返回一个可以得到Cusor对象的Loader
    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

该方法在onCreateLoader方法中创建的Loader对象完成数据的加载之后触发。回调参数会带有loader对象和返回的Cursor数据。你不需要管理Loader对象的对象的释放。Loader会在不需要数据的时候自动释放它。如果Cursor被放置在CursorAdapter里，你通常需要调用 swapCursor()保证数据更新。

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

public void onLoadFinished(Loader<Cursor> loader, Cursor data) {

    mAdapter.swapCursor(data);//加载到数据，为适配器设置数据源
}

onLoaderReset

该方法在先前创建的Loader对象被重新设置导致数据Loader加载的数据不用的时候触发。假如你引用了加载的数据，在这里你可以清空你的引用。

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

public void onLoaderReset(Loader<Cursor> loader) {
    //由于Loader重置，调用swapCursor将Adapter里的数据源清空。
    mAdapter.swapCursor(null);
}

官方例子

下面是Android官方给出的一个读取联系人用于ListView展示的例子，很好的介绍了Loader相关的用法。

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

上面的例子简单介绍了Loader的用法，相信大家对Loader有了很好的认识，知识在加载不同数据时，onCreateLoader回调中返回Loader对象中的查询条件不同而已。

对于想看完整代码进一步研究的同学可以参考 Android 使用Loader 读取联系人