文档章节

Loader用法

Gnepux
 Gnepux
发布于 2017/01/13 18:28
字数 2492
阅读 18
收藏 0

1. Loader简介

从3.0开始,Android引入了Loader API。它可以帮我我们从content provider或其他数据源获取数据并显示在UI界面上。

如果没有Loader API:

  • 我们在UI线程中获取数据,如果耗时则界面会卡顿。
  • 我们在非UI线程中获取数据,比如通过AsycTask,那么我们需要处理activity或fragment生命周期所触发的event,比如onDestory()和configuration changes。非UI线程和UI线程我们都需要做处理。

Loader可以帮助我们解决上面的问题:

  • Loader运行在非UI线程。
  • Loader提供了回调方法,用以应对event的发生,简化了线程的管理。
  • Loader在configuration changes时会对数据进行保存和缓存,防止重复的获取。
  • Loader实现了对数据源的监控(观察者)。比如CursorLoader会注册一个ContentObserver,在数据发生改变的时候会自动触发重加载。

2. Loader API概述

Class/Interface Description
LoaderManager

一个Activity或Fragment可能有多个Loader实例。但只能有一个LoaderManager,它能管理多个Loader。通过getLoaderManager()获取LoaderMananger实例。

从loader中获取数据,可以调用initLoader()restartLoader()。系统会自动判断包含相同ID的loader是否已经存在,从而重新创建或者复用已有的loader。

LoaderManager.LoaderCallbacks

这个接口里的回调方法会在loader events触发时调用。定义了三个回调方法:

  • onCreateLoader(int, Bundle) - 当系统需要创建一个新的loader时被调用。我们需要在这个方法中创建一个Loader对象并返回给系统。
  • onLoadFinished(Loader<D>, D) - 当loader加载数据完成时被调用。通常我们需要在这个方法中将数据展示给用户。
  • onLoaderReset(Loader<D>) - 当一个已存在的loader被reset时被调用(当我们调用了destroyLoader(int) 或 当前的activity/fragment被销毁,这会导致当前的数据不能用)。我们需要在这个方法中去掉这个loader的所有引用。

通常这个接口我们需要在activitiy/fragment中实现,并在调用initLoader()restartLoader()之前注册。

Loader

Loders负责加载数据。这是个抽象类,同时也是所有类型loader的基类。我们可以自己继承Loader 或者 直接使用系统的Loader子类:

下面会讨论如何使用这些类。

3. Using Loaders in an Application

本节会讨论如何使用loaders。步骤如下:

3.1 Starting a Loader

LoaderManager在Activity或Fragment中管理一个或多个Loader的实例。一个Activity或Fragment中只能有一个LoaderMananger。

通常我们在onCreate()/onActivityCreated()中初始化一个Loader。

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

initLoder()方法有两个参数:

  • 唯一的ID用来标记标记loader。
  • 可选的参数,在loader构造时会使用。没有传null。
  • LoaderManager.LoaderCallbacks的实现,LoaderManager会负责进行回调。

调用initLoader()之后,一个loader被初始化并且可用。存在两种可能的返回值:

  • 如果指定ID对应的loader已经存在,则返回这个loader。
  • 如果指定ID对应的loader不存在,initLoader()方法会触发callback中的onCreateLoader()回调。前面提到,我们会在这个回调中自己创建loader的方法。更详细的介绍可以参考onCreateLoader章节。

同时,返回的loader会跟LoaderMananger.LoaderCallbacks绑定,在这个loader有状态改变的时候回调都会被触发。如果在请求创建过程中,请求的loader已经存在同时产生了数据,回调onLoadFinish()会立刻被创建(还在initLoader()的过程中),所以我们需要考虑这种情况的判断。更详细的介绍可以参考onLoaderFinished章节。

需要注意的是,虽然initLoader()方法会返回一个Loader实例,但我们不用去引用它。LoaderManager会自动地在loader的生命周期中对它进行管理。LoaderMananger会自动在适当时机开始或停止loader,并保存loader的状态和它关联的数据。这意味着,我们不用直接对Loader进行操作(除非我们需要额外地管理loader的行为,可以参考例子LoaderThrottle)。我们只需要在LoaderManager.LoaderCallbacks的回调方法中进行处理。更详细的介绍可以参考Using the LoadManager Callbacks章节。

3.2 Restarting a Loader

正如前面介绍的,initLoader()在我们制定ID对应的Loader不存在时才会创建一个新的,如果存在则直接复用。但有的时候,我们需要丢弃旧的数据,使用新的。这时候我们可以使用restartLoader()方法。

比如,我们在实现SearchView.OnQueryTextListener的时候,当我们需要查询数据的条件发生改变时,我们需要改变search filter之后restart 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;
}

3.3 Using the LoaderMananger Callbacks

我们可以通过LoaderMananger.LoaderCallbacks的回调方法与LoaderManager进行交互。这可以使我们知道loader什么时候被创建、什么时候被停止,进而对我们的UI进行更新。

LoaderMananger.LoaderCallbacks包含了3个回调方法:

  • onCreateLoader() - 初始化并返回指定ID对应的Loader。
  • onLoadFinished() - 当loader完成数据加载会被调用。
  • onLoaderReset() - 当loader被reset时调用,这会导致数据无法使用。

3.3.1 onCreateLoader

当我们尝试访问loader,比如initLoader(),它会检查ID对应的loader是否存在。如果不存在,则触发LoaderManager.LoaderCallbacks的onCreateLoader()。我们在这个回调里创建loader。通常是CursorLoader,也可以自己实现Loader的子类。

举个例子,如果我们创建CursorLoader。我们需要构造函数创建CursorLoader,如果用它查询ContentProvider,我们需要:

  • uri - 查询数据的URI。
  • projection - 指定会返回哪些columns。传递null会返回所有的columns,不过这样效率很低。
  • selection - 指定会返回哪些rows,格式是WHERE SQL语句。传递null会返回所有的rows。
  • selectionArgs - 我们可以在selection中使用通配符?,它会被selectionArgs中的值代替。格式是Strings。
  • sortOrder - 设置查询顺序,格式是ORDER BY SQL语句。传递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");
}

3.3.2 onLoadFinished

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

3.3.3 onLoaderReset

这个回调可以帮助我们知道什么时候数据被释放,我们可以释放对数据的引用。

比如在下面的例子,我们调用swapCursor()并传null:

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

4. Example

下面是在Fragment中使用listview展示从contacts content provider获取到的数据。使用CursorLoader管理数据。

因为这个例子需要访问联系人信息,所以我们需要在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);
    }
}

4.1 More Examples

其他使用loader的场景:

参考资料

笔记: Loader 加载器

© 著作权归作者所有

Gnepux
粉丝 3
博文 96
码字总数 77557
作品 0
南京
私信 提问
webpack插件【cdn-loader】

新出炉的 webpack插件--cdn-loader(https://github.com/jso0/cdn-loader) 项目首页:https://github.com/jso0/cdn-loader 基本用法 (Usage) 在入口文件中require("cdn-loader + ? + ModuleNam......

我是李达康
2016/09/11
297
0
用 C/C++ 写一个 16 位的虚拟内核

前言 在前一篇文档,我只是简要地介绍了如何编写引导装载程序。做这件事令人开心,同时也具有挑战性。我非常乐意做这件事。在我了解了如何编写引导装载程序后,我想编写更好的功能,比如向引...

oschina
2014/03/04
1K
1
利用HappyPack优化webpack打包速度

由于运行在 Node.js 之上的 Webpack 是单线程模型的,所以Webpack 需要处理的事情需要一件一件的做,不能多件事一起做。我们需要Webpack 能同一时间处理多个任务,发挥多核 CPU 电脑的威力,...

violinux666
01/14
44
0
Sql Loader的简单使用

之前总结的关于SQL*Loader的用法,今天又用到,又翻出来看看 SQL*Loader 可将外部文件中的数据加载到Oracle DB 的表中。它具有一个功能强大的数据分析引擎,因此对数据文件中数据的格式没有什...

青苗飞扬
2017/12/05
0
0
从搭建vue-脚手架到掌握webpack配置(一.基础配置)

前言 学习vue的过程肯定会接触到vue的单文件组件,进而接触到vue-cli(vue工程构建的脚手架工具),但是vue-cli创建的工程对初学者很不友好,创建的项目又太过简单和片面。 本教程会分几篇文章...

JasonWild
2018/01/08
0
0

没有更多内容

加载失败,请刷新页面

加载更多

规则引擎

解决问题 版本迭代速度更不上业务变化,但是若多个业务同时变化,除了为每个业务设计专属配置项也不利于操作。就想服务接口单纯化,将复杂多变的业务逻辑交给规则引擎,让用户在web端或cs端自...

无极之岚
29分钟前
4
0
OSChina 周三乱弹 —— 欢迎你来做产品经理

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @巴拉迪维 :10多次劲歌金曲获奖,更多叱咤歌坛排名,黎明才应该是四大天王之首,只可惜拍的电影太少。单曲循环一个多月的歌,力荐 《无名份的...

小小编辑
今天
233
9
500行代码,教你用python写个微信飞机大战

这几天在重温微信小游戏的飞机大战,玩着玩着就在思考人生了,这飞机大战怎么就可以做的那么好,操作简单,简单上手。 帮助蹲厕族、YP族、饭圈女孩在无聊之余可以有一样东西让他们振作起来!...

上海小胖
今天
10
0
关于AsyncTask的onPostExcute方法是否会在Activity重建过程中调用的问题

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。 本文链接:https://blog.csdn.net/XG1057415595/article/details/86774575 假设下面一种情况...

shzwork
今天
7
0
object 类中有哪些方法?

getClass(): 获取运行时类的对象 equals():判断其他对象是否与此对象相等 hashcode():返回该对象的哈希码值 toString():返回该对象的字符串表示 clone(): 创建并返此对象的一个副本 wait...

happywe
今天
7
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部