Android关于Loaders的使用

介绍了在Android 3.0,加载器使它容易异步加载数据在一个活动或片段。加载器有以下特点:

1.他们适用于每一个 Activity 和Fragment.

2.他们提供异步加载的数据。

3.他们监控数据的来源和当内容发生改变时提供新结果。

4.重新创建一个配置更改后他们自动重新连接到最后加载程序的指针。因此,他们不需要重新查询他们的数据。

Loader API总结

有多个类和接口可能参与使用加载器在一个应用程序。他们总结表

Class/Interface	Description
LoaderManager	一个抽象类关联着一个活动或片段来管理一个或多个加载器实例。这有助于管理长时间运行的业务应用程序结合活动或片段生命周期;最常见的用法就是一个CursorLoader,但是应用程序是免费的写下他们自己的加载器加载其他类型的数据。
LoaderManager.LoaderCallbacks	一个回调接口为客户LoaderManager互动。例如,您可以使用onCreateLoader()回调方法,来创建一个新的装入器。
Loader	一个抽象类,它执行异步加载的数据。这是一个装入器的基类。您通常使用CursorLoader,但是您可以实现您自己的子类。虽然他们应监控加载器是活跃的来源的数据和提供新结果当内容变化。
AsyncTaskLoader	它提供了一个AsyncTask来做这个工作的抽象Loader。
CursorLoader	AsyncTaskLoader的一个子类,查询,并返回一个ContentResolver光标。这个类实现了加载程序协议以一种标准方式查询游标,建立在AsyncTaskLoader查询在执行游标一个后台线程,这样它才不会阻止该应用程序的UI。使用该程序的最佳方法是异步加载数据从一个内容提供者,而不是执行一个查询,通过管理片段或活动的api。

类和接口在上面的表的重要组件,您将使用实现一个装入器在您的应用程序。您不需要所有您创建的每个加载程序,但你永远需要一个参考LoaderManager为了初始化一个装入器和一个实现类加载器CursorLoader等。下面几节将向您展示如何使用这些类和接口在一个应用程序。

在应用程序中使用加载器

本节描述如何在一个Android应用程序中使用加载器。一个应用程序,它使用加载器通常包括以下内容:

• 一个活动或片段。
  
• LoaderManager的一个实例。
  
• 一个CursorLoader加载数据支持的一个内容提供者。或者,您可以实现您自己的类加载器或AsyncTaskLoader加载来自其他一些来源的数据。
  
• LoaderManager.LoaderCallbacks的一个实现。这就是你创建新的装载机和管理你的引用现有装载机。
  
• 一个程序的方式显示的数据,比如一个SimpleCursorAdapter。
  
• 一个数据源,如ContentProvider,当使用CursorLoader。
  

开始一个类装载器

这个LoaderManager管理一个或多个加载程序实例中一个活动或片段。只有一个LoaderManager对于每一个活动或片段。

你通常初始化一个装入器在该活动的onCreate()方法,或在代码段的onActivityCreated()方法。你这样做如下:

getLoaderManager().initLoader(0, null, this);//

这个initLoader()方法接受以下参数:

• 一个惟一的ID,用于标识该加载程序。在这个例子中,ID是0。
  
• 可选参数提供加载器在建设(在这个示例中为null)。
  
• 一个LoaderManager。LoaderCallbacks实现,LoaderManager调用报告装入器事件。在这个例子中,当地的类实现了LoaderManager。LoaderCallbacks接口,因此它通过对其自身的引用,这个。

这个initLoader()调用可确保一个装入器的初始化和活跃。它有两种可能的结果:

• 如果装入器指定的ID已经存在,最后创建加载器是重用。
  
• 如果装入器指定的ID不存在,initLoader()触发LoaderManager。LoaderCallbacks onCreateLoader()方法。这是你实现代码来初始化并返回一个新的装入器。
  

重新开始一个类装载器

当你使用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。
  
• onLoadFinished()——先前创建的加载程序时调用完成了其负载。
  
• onLoaderReset()——先前创建的加载程序时调用被重置,从而使其数据不可用。
  

onCreateLoader

当您试图访问一个装入器(例如,通过initLoader()),它检查是否加载器指定的ID的存在。如果没有,它会触发LoaderManager.LoaderCallbacks onCreateLoader()方法。这就是你创建一个新的装入器。通常,这将是一个CursorLoader,但是您可以实现您自己的装入器子类。

在这个例子中,onCreateLoader()回调方法创建一个CursorLoader。你必须建立CursorLoader使用其构造函数方法,要求有一套完整的信息需要执行一个查询的内容提供者。具体来说,它需要:

• uri — URI,用于内容检索。
  
• projection —一个列表,其中的列返回。传递null将返回所有列,分别是低效的。
  
• selection — 一个过滤器声明哪些行返回格式化为一个SQL WHERE子句(不包括在本身)。传递null将返回所有的行给定的URI。
  
• selectionArgs — 你可能包括什么?年代时,选择”,它将会被替换的值selectionArgs,在它们出现的顺序在选择。这个值将被绑定为字符串。
  
• 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

这种方法被称作当先前创建的加载程序完成了其负载。这个方法是保证被称为前释放最后数据提供了该程序。这时您应该删除所有使用的旧数据(因为它很快就会发布),但不应该做你自己的数据发布的自其装入程序拥有它,将会照料他们。

加载程序将发布数据一旦它知道应用程序不再使用它。例如,如果数据是一个指针从一个CursorLoader,你不应该调用close()在它自己。如果光标被放置在一个CursorAdapter,您应该使用swapCursor()方法,这样旧光标没有关闭。例如:

// 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

这种方法被称作当先前创建的加载程序被重置,从而使其数据不可用。这个回调函数可以找出数据即将发布,这样你就可以把你的对它的引用。

这个实现调用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);
}

Example

作为一个例子,这里是全面执行一个片段,显示一个列表视图包含查询的结果对联系人内容提供商。它使用一个CursorLoader管理上的查询提供者

应用程序访问用户的联系人,如这个示例所示,其清单必须包括READ_CONTACTS许可

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

    // 这是适配器被用来显示列表的数据。
    SimpleCursorAdapter mAdapter;

    // 如果非空,这是当前过滤用户提供。
    String mCurFilter;

    @Override public void onActivityCreated(Bundle savedInstanceState) {
        super.onActivityCreated(savedInstanceState);

        // 给一些文本来显示如果没有数据。在一个真正的
        // 应用程序这将来自一个资源。
        setEmptyText("No phone numbers");

        // 我们有一个菜单项显示在操作栏。
        setHasOptionsMenu(true);

        // 创建一个空的适配器,我们将使用显示加载的数据。
        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);

        //准备装入器。
       
        getLoaderManager().initLoader(0, null, this);
    }

    @Override public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
        // 创建一个动作栏项用于搜索。
        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) {
        // 当操作栏搜索文本已经改变了调用 Update
        // 更新搜索筛选器,并重新启动加载程序来做一个新的查询
        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) {
        // 在这里插入所期望的行为。
        Log.i("FragmentComplexList", "Item clicked: " + id);
    }
    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) {
        // 当一个新的Loader需要创建时调用这个方法  
        // 这个例子只有一个Loader，所以我们不关心ID
        // 首先, 选择基本URI取决于是否使用当前过滤器
        Uri baseUri;
        if (mCurFilter != null) {
            baseUri = Uri.withAppendedPath(Contacts.CONTENT_FILTER_URI,
                    Uri.encode(mCurFilter));
        } else {
            baseUri = Contacts.CONTENT_URI;
        }

        //现在创建并返回一个CursorLoader照顾创建一个游标的数据显示。
        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) {
        //交换新指针
        mAdapter.swapCursor(data);
    }

    public void onLoaderReset(Loader<Cursor> loader) {
        //当最后一个称为游标提供给onLoadFinished()调用以上即将被关闭。
        // 我们需要确保我们不再使用它。
        mAdapter.swapCursor(null);
    }
}