码迷,mamicode.com
首页 > 移动开发 > 详细

Android官方文档之App Components(Loaders)

时间:2016-05-13 00:07:16      阅读:318      评论:0      收藏:0      [点我收藏+]

标签:

Loaders在Android 3.0中引入。在ActivityFragment中,使用Loaders可以方便地加载数据。有关ActivityFragment的介绍,您可以参考我翻译的官方文档:


本文将介绍Loaders API、Loaders的启动、重启、Loaders管理器 等内容,如需访问Loaders的官方原文,您可以点击这个链接:Loaders


Loaders


Loaders具有如下特性:

  • 它适用于任何ActivityFragment

  • 它使用异步加载的方式(asynchronous loading of data);

  • 当内容发生变化时,它监听数据源的变化并传递新的结果;

  • 当系统配置发生改变后,在数据重载时,它自动重连最新一次Loader的游标(automatically reconnect to the last loader’s cursor)。所以,无需重新查询数据。


Loader的API概览(Loader API Summary)


Loader的主要API总结如下:

Class/Interface Description
LoaderManager 这是一个抽象类,用于与某一个Activity或Fragment绑定,以管理若干个Loader实例 ,这可以帮助一个应用程序轻松处理Activity或Fragment生命周期中的长时间操作(manage longer-running operations in conjunction with the Activity or Fragment lifecycle);该抽象类最普遍的用法是与CursorLoader一起使用,当然应用程序也可以自由地为其他类型的数据写入相应的Loaders。
LoaderManager.LoaderCallbacks 一个与LoaderManager交互的回调接口,如可以调用onCreateLoader()方法创建一个Loader实例。
Loader 一个用于异步加载数据的类。这是所有Loader的基类,CursorLoader就是一个比较常用的实现类。不过您也可以自己定制实现类。Loader是动态的,它能够实时监听数据源的改变。
AsyncTaskLoader 这是一个用来提供AsyncTask类的抽象类(AsyncTask是一个用来做异步任务的抽象类)
CursorLoader 这是一个AsyncTaskLoader的子类,它可以从ContentResolver中查询并返回Cursor对象的引用。

在上述表格中,LoaderManager是一个创建Loader对象的基础类;另外Loader是一个实现不同类型Loader的基础类,比如CursorLoader就一个Loader的实现类。

下面将介绍如何使用这些类。


在应用程序中使用Loaders(Using Loaders in an Application)


在一个应用程序中,Loader的使用场景如下:

  • ActivityFragment 中;

  • LoaderManager的实例中(An instance of the LoaderManager);

  • 使用CursorLoader加载ContentProvider中提供的数据。您也可以通过继承LoaderAsyncTaskLoader加载其他类型的数据;

  • 实现LoaderManager.LoaderCallbacks回调接口。在回调中,可以创建新的Loader实例,也可以管理已存在的Loader实例。

  • 决定加载数据的显示布局方式,如SimpleCursorAdapter

  • 加载数据源时,如CursorLoader


创建Loader对象(Starting a Loader)


LoaderManager负责在ActivityFragment中创建一个或多个Loader实例。每一个ActivityFragment持有且仅持有一个LoaderManager实例


一般情况下,在ActivityonCreate()回调方法中、或在FragmentonActivityCreated()回调方法中创建Loader实例:

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

initLoader()方法的参数如下:

  • 参数1(int):一个Loader实例的ID标识,示例中为ID为0;

  • 参数2(Bundle):一个用于构建Loader实例的可选参数,示例中为null;

  • 参数3(LoaderManager.LoaderCallbacks):由LoaderManager调用,以便通知loader事件。在示例中,所在类实现了LoaderManager.LoaderCallbacks接口,故为this


调用initLoader()方法可以确保一个loader实例被创建和激活(a loader is initialized and active)。这会产生两种结果:

  • 若为loader指定的ID已存在,则已存在的loader将被重用(the last created loader is reused);

  • 若为loader指定的ID不存在,则initLoader()方法会触发(triggers )LoaderManager.LoaderCallbacks中的回调方法onCreateLoader(),在该方法中,您需要实例化Loader对象,并返回该对象。


无论发生上述那种情况,实现了LoaderManager.LoaderCallbacks接口的对象的将与loader相关联。并且当loader的状态发生改变时,该回调接口中的方法将被回调。回调方法时,要求绑定的loader已初始化并已加载数据,接着,系统立即回调onLoadFinished()方法(在执行initLoader()方法时回调(during initLoader()))。


尽管initLoader()方法返回Loader对象或其子类对象的引用,但程序无需持有这个引用(you don’t need to capture a reference to it),因为LoaderManager自动管理着所有已创建的Loader的生命周期,LoaderManager会在需要时启动或停止加载,并可获得管辖的Loader的状态与Loader关联的数据。这意味着您无需与loaders直接交互,相反,多数情况下,当事件发生时,需使用LoaderManager.LoaderCallbacks中的回调方法管理加载过程( intervene in the loading process when particular events occur)。


重启Loader(Restarting a Loader)


就像上面提到的那样,调用initLoader()时,若传入的ID值已存在,则重用loader,若不存在才会创建新的loader。但有时,希望丢弃旧数据并重启(sometimes you want to discard your old data and start over)。


为了丢弃旧数据,您可以调用restartLoader()方法,比如,当用户查询的内容发生改变时,loader需重启,更新搜索过滤,并进行新的查询(can use the revised search filter to do a new query)。如下例所示:

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回调 (Using the LoaderManager Callbacks)


LoaderManager.LoaderCallbacks是一个回调接口,它可以使客户端与LoaderManager进行方便地交互( lets a client interact with the LoaderManager)。


当处于stop状态时,Loader(特别是CursorLoader)希望保持它们的数据不丢失。这需要通过Activity或Fragment的onStart()onStop()方法保持数据不丢失(keep their data across the activity or fragment’s onStop() and onStart() methods)。所以当用户返回应用时,不用等待数据从新加载。您可以通过LoaderManager.LoaderCallbacks来监听新loader被时被创建、或loader何时停止使用数据( when to create a new loader, and to tell the application when it is time to stop using a loader’s data)。


回调接口LoaderManager.LoaderCallbacks中包含如下方法:

  • onCreateLoader():初始化一个新的loader,并赋予一个ID;

  • onLoadFinished():当某个曾经创建的Loader停止加载时,该方法被回调;

  • onLoaderReset():当某个曾经创建的Loader重新启动时(这时数据不可获取),该方法被回调。


下面将详细介绍每个回调方法:


当您需要获取Loader实例时(如,通过initLoader()方法获取),该方法会查询新创建的Loader的ID是否与之前创建过的Loader重复,若未重复,则onCreateLoader()被回调,就是在这里创建新的Loader,这通常会是CursorLoader,当然也可以是其他定制的Loader子类。创建CursorLoader需要调用构造方法,其中参数需要使用ContentProvider的查询结果,而ContentProvider需要如下查询参数:

 1、Uri:检索内容的Uri地址

 2、projection:需要查询的列,若传入null则表示查询所有列,这样效率较低

 3、selection:需要查询的行,若传入null则表示查询所有行

 4、selectionArgs:需筛选的参数

 5、sortOrder:排序规则

举例:

 // 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():当之前已创建的Loader实例停止加载时,该方法被回调,该方法被系统回调的时机是:该loader实例将加载的最后一次数据释放掉之前(This method is guaranteed to be called prior to the release of the last data that was supplied for this loader)。此时,您应当清楚所有旧的数据,但不应手动释放数据,因为loader此时还持有该数据。

应用不再使用数据时,loader会将其释放。比如说 ,当您使用CursorLoader时,不应手动调用close()方法,当CursorAdapter持有了CursorLoader返回的Cursor对象的引用时,应调用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():当之前已创建的某个loader被重建时,该方法被回调。这时,数据不可用。该方法被回调时,数据即将被释放,所以您可以移除对该数据的引用( the data is about to be released so you can remove your reference to it)。

示例如下:

// 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的例子:

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

更多示例(More Examples)

更多有关Loader的示例程序,您可以参考下面这些链接:

Android官方文档之App Components(Loaders)

标签:

原文地址:http://blog.csdn.net/vanpersie_9987/article/details/51340413

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!