Android Loader 机制

1 Loader介绍

Loader是Android3.0提供的新的异步api，Loader可用于进行异步操作，其实它内部采用的也是类似AsycnTask的异步任务机制，那么既然有了AsyncTask为什么还要有Loader呢？因为AysncTask有一个缺点，当Activity或者Fragment因为为屏幕旋转等因素被销毁重建后，如果处理不当就会造成任务和数据丢失，每次重建都要重新启动一个AsyncTask去执行异步任务。而使用Loader却可以解决这样的问题，Loader是Android框架中提供的在手机状态改变时不会被销毁的工具。Loader的生命周期是是由系统控制的，只有在向Loader请求数据的Activity/Fragment被永久销毁时才会被清除，所以通过Loader可以很好的解决因配置改变让Activity/Fragment销毁重建导致的任务或数据丢失等问题。

下面对Loader进行学习。

---

2 Loader的使用

通过几个例子来学习Loader的使用是最后的方式，不过需要先了解一下 Loader 相关的几个类。

• Loader：抽象出来的异步数据加载类
• AsyncTaskLoader：Loader的直接子类，完成了Loader的大部分逻辑，继承AsyncTaskLoader可以轻易实现异步数据加载
• CursorLoader：是AsyncTaskLoader的子类。它可以查询ContentResolver然后返回一个Cursor，同时CursorLoader内包含ContentObserver对象来监听Cursor数据的变化。
  • LoaderManager Loader管理器的抽象
  • LoaderManagerImpl LoaderManager的实现者
  • LoaderManager.LoaderCallbacks 提供LoaderManager与Fragment或Activity交互的回调，LoaderCallbacks有以下三个方法：
    1. onCreateLoader()：根据所给出的ID，初始化并返回一个新的加载器。
    2. onLoadFinished()：当一个先前被创建的加载器完成了它的加载过程时被调用。
    3. onLoaderReset()：当一个先前被创建的加载器被重置或者Activity或Fragment完全销毁时被调用，然后使加载器的数据无效。

---

2.1 示例，通过Loader获取系统联系人列表

例子很简单，其实是 ApiDemo 中的一个例子，主要的代码都在这里：

//创建一个适配器，由于使用的Cursor，所以这里使用ListView与SimpleCursorAdapter
      mAdapter = new SimpleCursorAdapter(this,
                    android.R.layout.simple_list_item_2, null,
                    new String[]{ContactsContract.Contacts.DISPLAY_NAME, ContactsContract.Contacts.CONTACT_STATUS},
                    new int[]{android.R.id.text1, android.R.id.text2}, 0);
    
     //然后再onCreate方法中通过Activity的getLoaderManager创建一个Loader，这里的this实现了LoaderCallbacks
    
     getLoaderManager().initLoader(1, null, this);
    
            
        // 联系人查询项
        static final String[] CONTACTS_SUMMARY_PROJECTION = new String[]{
                ContactsContract.Contacts._ID,
                ContactsContract.Contacts.DISPLAY_NAME,
                ContactsContract.Contacts.CONTACT_STATUS,
                ContactsContract.Contacts.CONTACT_PRESENCE,
                ContactsContract.Contacts.PHOTO_ID,
                ContactsContract.Contacts.LOOKUP_KEY,
        };
    
         //实现的回调
        @Override
        public Loader onCreateLoader(int id, Bundle args) {
            Log.d(TAG, "onCreateLoader() called with: " + "id = [" + id + "], args = [" + args + "]");
    
            Uri baseUri  = ContactsContract.Contacts.CONTENT_URI;
         
            //查询的条件语句，即sql
            String select = "((" + ContactsContract.Contacts.DISPLAY_NAME + " NOTNULL) AND ("
                    + ContactsContract.Contacts.HAS_PHONE_NUMBER + "=1) AND ("
                    + ContactsContract.Contacts.DISPLAY_NAME + " != '' ))";
    
            //返回一个Loader
            return new CursorLoader(
                    LoaderContactActivity.this,
                    baseUri,
                    CONTACTS_SUMMARY_PROJECTION,
                    select,
                    null,
                    ContactsContract.Contacts.DISPLAY_NAME + " COLLATE LOCALIZED ASC");
    
        }
    
        //当CursorLoader查询完数据之后
        @Override
        public void onLoadFinished(Loader loader, Cursor data) {
               mAdapter.swapCursor(data);
        }
    
         //当调用getLoaderManager().restartLoader(0, null, this);或者Activity/Fragmen完全销毁，我们应该在这里清除我们显示的数据。
        @Override
        public void onLoaderReset(Loader loader) {
            Log.d(TAG, "onLoaderReset() called with: " + "loader = [" + loader + "]");
            mAdapter.swapCursor(null);
        }

说明：

• id是Loader的唯一表示， 我们应对根据这个唯一的标识创建自己的Loader。
• Buldle是创建Loader的参数，没有参数传null即可
• onCreateLoader方法接受initLoader时传递的参数，我们需要在这里创建我们的Loader。
• onLoadFinished表示数据已经加载完毕
• onLoaderReset表示数据被重置，或者Activity/Fragment完全销毁

是不是感觉 Loader 的使用还是很简单的，现在来测试一下屏幕旋转对 Loader 的影响。

在第一次进入屏幕时打印一个getLoaderManager和LoaderCallbacks的三个方法：

     D/LoaderContactActivity: onCreateLoader() called with: id = [1], args = [null]
    
     D/LoaderContactActivity: getLoaderManager():LoaderManager{b33365 in HostCallbacks{b13d83a}}
    
     D/LoaderContactActivity: onLoadFinished() called with: loader = [CursorLoader{8573e06 id=1}], data = [android.content.ContentResolver$CursorWrapperInner@af6cc7]

然后旋转屏幕：

     getLoaderManager():LoaderManager{b33365 in HostCallbacks{a0715b7}}
     onLoadFinished() called with: loader = [CursorLoader{8573e06 id=1}], data = [android.content.ContentResolver$CursorWrapperInner@af6cc7]

可以看到虽然LoaderManager重建创建了，但是onCreateLoader并没有再次调用，而是直接调用了onLoadFinished，并且返回了内存地址一样的CursorLoader和数据源Cursor，当我们主动退出Activity后，onLoaderReset()才会被调用。现在可以感觉到Loader的强大之处了，而且CursorLoader可以监听数据源的变化，比如这里的联系人列表，当有联系人信息被修改时，Cursor会自定监听并同步到列表。

---

3 Loader的部分源码解析

要了解 loader 是怎么运作的，只能从其源码了解，所以接下来对Loader相关源码进行分析：

3.1 LoaderManager的创建

获取LoaderManager的代码在Activity中：

        FragmentController mFragments = FragmentController.createController(new HostCallbacks());
        public LoaderManager getLoaderManager() {
            return mFragments.getLoaderManager();
        }

可以看到通过mFragments获取到了LoaderManager，而mFragments是由FragmentController创建的，其实mFragments最终是调用的它内部的mHost的getLoaderManager()方法，也就是这里传入的HostCallbacks。而HostCallbacks的继承链如下：

FragmentContainer：定义Fragment的容器的的抽象
       |
FragmentHostCallback：定义了Fragment所依附对象(Activity)的，作为宿主的Activity需要实现FragmentHostCallback相关方法
       |
HostCallbacks

而主要的逻辑实现都在FragmentHostCallback里面，可以看一下：

    public abstract class FragmentHostCallback extends FragmentContainer {
        private final Activity mActivity;
        final Context mContext;
        private final Handler mHandler;
        final int mWindowAnimations;
        final FragmentManagerImpl mFragmentManager = new FragmentManagerImpl();
        private ArrayMap mAllLoaderManagers;
        private LoaderManagerImpl mLoaderManager;
        private boolean mCheckedForLoaderManager;
        private boolean mLoadersStarted;
    .......}

包括fragmentManager，LoaderManager都在FragmentHostCallback被创建。而LoaderManager的实现者就是LoaderManagerImpl了，看一下mLoaderManager是怎么创建的

LoaderManagerImpl getLoaderManagerImpl() {
            if (mLoaderManager != null) {
                return mLoaderManager;
            }
            mCheckedForLoaderManager = true;
            mLoaderManager = getLoaderManager("(root)", mLoadersStarted, true /*create*/);
            return mLoaderManager;
        }
        
        LoaderManagerImpl getLoaderManager(String who, boolean started, boolean create) {
            if (mAllLoaderManagers == null) {
                mAllLoaderManagers = new ArrayMap();
            }
            LoaderManagerImpl lm = (LoaderManagerImpl) mAllLoaderManagers.get(who);
            if (lm == null) {
                if (create) {
                    lm = new LoaderManagerImpl(who, this, started);
                    mAllLoaderManagers.put(who, lm);
                }
            } else {
                lm.updateHostController(this);
            }
            return lm;
        }

这里有一个容器ArrayMap用于存储LoaderManager，而从FragmentHostCallback获取LoaderManager是传入的"(root)"，如果容器中没有根据"(root)"找到才会创建。

3.2 LoaderManger的运行

        LoaderManagerImpl(String who, FragmentHostCallback host, boolean started) {
            mWho = who;
            mHost = host;
            mStarted = started;
        }

LoaderManagerImpl的创建需要三层参数，who是LoaderManagerImpl的标识，可能属于Activity也可能是Fragment的，mStarted表示是否已经开始，当Activity执行onStart方法时，mStarted被置为true

        @CallSuper
        protected void onStart() {
            mCalled = true;
            mFragments.doLoaderStart();
            getApplication().dispatchActivityStarted(this);
        }

而doLoaderStart会执行下面逻辑：

        void doLoaderStart() {
            if (mLoadersStarted) {
                return;
            }
            mLoadersStarted = true;
    
            if (mLoaderManager != null) {
                mLoaderManager.doStart();
            } else if (!mCheckedForLoaderManager) {
                mLoaderManager = getLoaderManager("(root)", mLoadersStarted, false);
            }
            mCheckedForLoaderManager = true;
        }

这里又调用了LoaderManagerImpl的doStart方法

        final SparseArray mLoaders = new SparseArray(0);

        void doStart() {
            if (DEBUG) Log.v(TAG, "Starting in " + this);
            if (mStarted) {
                RuntimeException e = new RuntimeException("here");
                e.fillInStackTrace();
                Log.w(TAG, "Called doStart when already started: " + this, e);
                return;
            }
            
            mStarted = true;
    
            // 在这里调用所有Loader的start方法，
            // Let the existing loaders know that we want to be notified when a load is complete
            for (int i = mLoaders.size()-1; i >= 0; i--) {
                mLoaders.valueAt(i).start();
            }
        }

而mLoaders就是一个存储LoaderInfo的SparseArray，LoaderInfo用于描述一个Loader的所有信息：

 final class LoaderInfo implements Loader.OnLoadCompleteListener