Loader用法

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子類： AsyncTaskLoader - 一個抽象類，內部經過AsyncTask實現異步加載數據。 CursorLoader - AsyncTaskLoader的實體子類，實現異步地從ContentProvider加載數據。它查詢ContentResolver，返回一個Cursor對象。

下面會討論如何使用這些類。

3. Using Loaders in an Application

本節會討論如何使用loaders。步驟以下：

• 在Activity或Fragment中。
• 聲明一個LoaderManager實例。
• 一個CursorLoader用來從ContentProvider中獲取數據。若是咱們須要從其餘的數據源獲取數據，咱們能夠本身實現Loader或AsyncTaskLoader的子類。
• 實現LoaderManager.LoaderCallbacks。咱們在回調中建立並管理loaders。
• 選擇一個展現loader數據的方式，好比SimpleCursorAdapter。
• 選擇數據源，好比ContentProvider，咱們使用CursorLoader來獲取數據。

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的場景：

• LoaderCursor - 如上面的例子。
• Retrieving a List of Contacts
• LoaderThrottle
• AsyncTaskLoader - 經過AsyncTaskLoader從package manager中獲取已安裝的app信息。

參考資料

筆記: Loader 加載器