設(shè)計(jì)目的
為了在Activity和Fragment中更加方便地異步加載數(shù)據(jù).
注意: 實(shí)際上
Loader類(lèi)并不提供異步功能, 真正提供異步加載功能的是它的直接子類(lèi)AsyncTaskLoader.
而AsyncTaskLoader是一個(gè)抽象類(lèi), 并不能直接使用, 官方僅提供了一個(gè)查詢數(shù)據(jù)庫(kù)或者ContentProvider的類(lèi), 就是CursorLoader類(lèi), 它直接繼承了AsyncTaskLoader.
因此, 實(shí)際使用中, 如果你想實(shí)現(xiàn)異步加載數(shù)據(jù), 一般是繼承
AsyncTaskLoader, 然后在AsyncTaskLoader#loadInBackground()中查詢數(shù)據(jù).
特點(diǎn)
1. 在Activity和Fragment中使用, 綁定生命周期
在Activity和Fragment中都有getLoaderManager()方法返回一個(gè)LoaderManager, 需要注意的是, Activity自己?jiǎn)为?dú)持有一個(gè)LoaderManager實(shí)例, 而每一個(gè)Fragment都會(huì)持有一個(gè)實(shí)例. 而這些實(shí)例會(huì)保存在一個(gè)ArrayMap<String, LoaderManager>中.
綁定生命周期的是LoaderManager的實(shí)現(xiàn)類(lèi)LoaderManagerImpl, 它有一系列對(duì)應(yīng)生命周期的方法, 例如在Activity#onStart()會(huì)間接調(diào)用LoaderManagerImpl#doStart(), 在這些方法中還會(huì)調(diào)用LoaderInfo的對(duì)應(yīng)方法, 然后LoaderInfo根據(jù)當(dāng)前的狀態(tài)來(lái)調(diào)用Loader的方法或者回調(diào)接口.
2. 異步加載數(shù)據(jù)
上面已經(jīng)說(shuō)過(guò), 異步加載數(shù)據(jù)是AsyncTaskLoader的特性, 如果你直接繼承Loader是不能異步加載數(shù)據(jù)的.
3. 監(jiān)控?cái)?shù)據(jù)源
監(jiān)控?cái)?shù)據(jù)源是由LoaderManagerImpl$ForceLoadContentObserver實(shí)現(xiàn)的.
注意: 這個(gè)類(lèi)沒(méi)有在
Loader和AsyncTaskLoader中使用, 而是在CursorLoader中用到因此這個(gè)特點(diǎn)僅僅屬于CursorLoader.
這里個(gè)人覺(jué)得是一個(gè)奇怪的設(shè)計(jì), ForceLoadContentObserver繼承的是android.database.ContentObserver, 而Loader明顯不是僅僅針對(duì)數(shù)據(jù)庫(kù)的, 或者這個(gè)類(lèi)放在CursorLoader中更加合適.
4. 重建加載器時(shí)避免重新查詢已經(jīng)加載的數(shù)據(jù)
因?yàn)?code>Loader的實(shí)例是單獨(dú)存放在LoaderManager中了, 當(dāng)Activity或者Fragment在因系統(tǒng)設(shè)置改變而重創(chuàng)建的時(shí)候LoaderManager不會(huì)被回收, 因此Loader也能夠被重復(fù)利用.
注意, 如果是
Activity被回收的情況, 那么LoaderManager也會(huì)被回收.
LoaderManager
作用是在
Activity/Fragment和Loader之間建立聯(lián)系, 跟隨Activity/Fragment的生命周期會(huì)有相關(guān)方法被調(diào)用, 因此Loader具有綁定聲明周期的特點(diǎn).
獲取實(shí)例
直接通過(guò)getLoaderManager()獲取實(shí)例, Activity和Fragment獲取的過(guò)程稍有不同, 但是最后都會(huì)得到一個(gè)LoaderManagerImpl實(shí)例.
LoaderManagerImpl是LoaderManager的唯一子類(lèi),Activity和Fragment中持有的都是LoaderManagerImpl引用而不是LoaderManager,LoaderManager更多的意義是提供給使用者的接口.
創(chuàng)建Loader
通過(guò)LoaderManager#initLoader()申請(qǐng)創(chuàng)建一個(gè)Loader, 內(nèi)部會(huì)根據(jù)ID判斷加載器是否已經(jīng)存在, 如果存在則會(huì)重復(fù)使用, 如果不存在就會(huì)觸發(fā)調(diào)用LoaderManager.LoaderCallbacks#onCreateLoader()方法創(chuàng)建加載器.
LoaderManager不是直接引用Loader的, 而是通過(guò)LoaderInfo包裝Loader,LoaderInfo同時(shí)負(fù)責(zé)保存LoaderManager.LoaderCallbacks回調(diào)接口和當(dāng)前Loader的狀態(tài)和數(shù)據(jù).
LoaderInfo負(fù)責(zé)根據(jù)當(dāng)前狀態(tài)調(diào)用LoaderManager.LoaderCallbacks中合適的回調(diào)方法.
如果是在Activity#onStart()之前創(chuàng)建的Loader會(huì)等到該方法的時(shí)候統(tǒng)一啟動(dòng), 即間接調(diào)用Loader#start(). 如果是在之后創(chuàng)建, 則會(huì)馬上啟動(dòng).
創(chuàng)建的Loader之后就會(huì)和Activity/Fragment的生命周期關(guān)聯(lián)起來(lái).
LoaderManager的實(shí)際作用就是把當(dāng)前的生命周期傳遞給LoaderInfo,Loader的狀態(tài)判斷邏輯和接口回調(diào)都是由LoaderInfo決定.
LoaderInfo
負(fù)責(zé)保存Loader狀態(tài)和直接處理LoaderManager.LoaderCallbacks.
start()
啟動(dòng)方法, 會(huì)在Activity#onStart()時(shí)被調(diào)用, 或者當(dāng)Loader在onStart()之后初始化, 那么初始化時(shí)也會(huì)被被調(diào)用.
關(guān)鍵工作:
- 如果
Loader還未創(chuàng)建, 那么會(huì)調(diào)用LoaderCallbacks#onCreateLoader()創(chuàng)建實(shí)例 - 給
Loader注冊(cè)接口, 讓Loader在加載數(shù)據(jù)完成或者取消加載時(shí)可以通知LoaderInfo - 調(diào)用了
Loader#startLoading(), 通知Loader開(kāi)始加載數(shù)據(jù)
stop()
在LoaderManagerImpl#doStop()中被調(diào)用, 應(yīng)該會(huì)被Activity#onStop間接調(diào)用.
關(guān)鍵工作:
- 重置了
mStarted標(biāo)志位 - 取消在
start()中給Loader注冊(cè)的接口 - 調(diào)用了
Loader#stopLoading, 通知Loader停止加載數(shù)據(jù)
remain(), reportStart(), finishRetain()
根據(jù)生命周期處理Loader狀態(tài)和回調(diào)接口, 暫略過(guò).
destroy()
主要工作:
- 如果
Loader已經(jīng)傳遞過(guò)數(shù)據(jù), 那么調(diào)用LoaderCallbacks#onLoaderReset()來(lái)通知client數(shù)據(jù)失效 - 取消在
start()中給Loader注冊(cè)的接口 - 調(diào)用了
Loader#reset, 通知Loader重置數(shù)據(jù)
onLoadCanceled
在start()中給Loader注冊(cè)的OnLoadCanceledListener接口方法.
Loader加載過(guò)程中被取消時(shí)通過(guò)注冊(cè)的接口方法通知LoaderInfo.
對(duì)于
AsyncTaskLoader來(lái)說(shuō)就是在AsyncTask#onCancelled()中調(diào)用該方法.
在LoaderInfo中, Loader被取消時(shí), 如果mPendingLoader不為null的話, 會(huì)把LoaderInfo實(shí)例移出集合, 然后destroy()自己, 接著開(kāi)始加載mPendingLoader
mPendingLoader: 當(dāng)外部調(diào)用LoaderManager#restartLoader()的時(shí)候, 如果當(dāng)前指定的Loader仍在加載數(shù)據(jù), 那么就會(huì)創(chuàng)建一個(gè)新的Loader賦值給mPendingLoader, 而不會(huì)再次啟動(dòng)這個(gè)Loader.
onLoadComplete
在start()中給Loader注冊(cè)的OnLoadCompleteListener接口方法.
當(dāng)Loader加載完成的時(shí)候通過(guò)這個(gè)方法通知LoaderInfo
同上, 如果mPendingLoader不為null的話, 會(huì)把LoaderInfo實(shí)例移出集合, 然后destroy()自己, 接著開(kāi)始加載mPendingLoader.
另外如果Loader從未加載數(shù)據(jù)或者加載了新數(shù)據(jù), 那么最后會(huì)調(diào)用LoaderCallbacks.onLoadFinished(), 把數(shù)據(jù)傳遞給client.
自定義Loader
LoaderInfo直接操作的是Loader, 會(huì)在生命周期的不同階段調(diào)用Loader中的對(duì)應(yīng)方法, 例如startLoading(), reset(), stopLoading()等等.
在這些方法里面都會(huì)有對(duì)應(yīng)的protect void onXXX()方法, 例如onStartLoading(), Loader的子類(lèi)就是通過(guò)重寫(xiě)這些方法來(lái)進(jìn)行特定的邏輯.
因此, 自定義
Loader需要重寫(xiě)其中的onXXXX()方法. 各個(gè)方法代表的含義建議查看源碼注釋.
另外, 在上面已經(jīng)提到, LoaderInfo會(huì)給Loader注冊(cè)兩個(gè)接口, Loader應(yīng)該在完成加載或者取消加載數(shù)據(jù)時(shí)通過(guò)這兩個(gè)接口通知LoaderInfo.
因此, 自定義
Loader還需要在完成加載時(shí)調(diào)用OnLoadCompleteListener#onLoadComplete, 在取消加載時(shí)調(diào)用OnLoadCanceledListener#onLoadCanceled.
AsyncTaskLoader
在實(shí)際使用中, 我們不太可能直接繼承Loader, 而是繼承AsyncTaskLoader. 因?yàn)樗呀?jīng)實(shí)現(xiàn)了異步加載, 同時(shí)也處理了上述提到的兩點(diǎn), 這可以簡(jiǎn)化自定義Loader的代碼.
現(xiàn)在對(duì)AsyncTaskLoader稍作分析:
onForceLoad()
AsyncTaskLoader重寫(xiě)了Loader#onForceLoad(), 看注釋可以知道:
onForceLoad()會(huì)被forceLoad()調(diào)用, 后者會(huì)在請(qǐng)求異步加載數(shù)據(jù)時(shí)調(diào)用, 和startLoading()的區(qū)別在于, 無(wú)論有無(wú)舊數(shù)據(jù),forceLoad()都會(huì)加載數(shù)據(jù). 這個(gè)方法會(huì)在主線程被調(diào)用
上面的分析我們可以知道onStartLoading()才是數(shù)據(jù)加載的發(fā)起點(diǎn), 所以在這里我們可以知道
AsyncTaskLoader自身沒(méi)有發(fā)起加載數(shù)據(jù), 因?yàn)樗鼪](méi)有重寫(xiě)onStartLoading()方法. 因此子類(lèi)需要重寫(xiě)onStartLoading()來(lái)啟動(dòng)加載數(shù)據(jù).
在onForceLoad中, AsyncTaskLoader會(huì)執(zhí)行一個(gè)AsyncTask, 因此
AsyncTaskLoader是通過(guò)AsyncTask實(shí)現(xiàn)異步加載的.
在AsyncTask中AsyncTaskLoader會(huì)根據(jù)加載數(shù)據(jù)的情況調(diào)用OnLoadCompleteListener#onLoadComplete或者OnLoadCanceledListener#onLoadCanceled, 因此通知LoaderInfo的工作AsyncTaskLoader已經(jīng)幫我們處理好了.
對(duì)應(yīng)AsyncTask, AsyncTaskLoader提供了loadInBackground()和onCanceled()方法來(lái)讓子類(lèi)可以在后臺(tái)線程加載數(shù)據(jù)和在任務(wù)被取消時(shí)作處理.
onCancelLoad()
AsyncTaskLoader還重寫(xiě)了Loader#onCancelLoad(), 看方法名就知道在這里應(yīng)該取消加載數(shù)據(jù).
在這個(gè)方法里面, 主要就是處理AsyncTask, 根據(jù)AsyncTask所處的不同狀態(tài)處理, 如果AsyncTask正在運(yùn)行, 那么AsyncTaskLoader#cancelLoadInBackground()會(huì)被調(diào)用.
這是因?yàn)閷?duì)于AsyncTaskLoader, 啟動(dòng)加載數(shù)據(jù)的工作是交給子類(lèi)的, 而子類(lèi)應(yīng)該在后臺(tái)線程中加載數(shù)據(jù), 也就是AsyncTaskLoader#loadInBackground()中加載, 那意味著AsyncTaskLoader并不知道自己?jiǎn)?dòng)的后臺(tái)線程做了什么, 所以提供這個(gè)方法來(lái)讓子類(lèi)可以取消在后臺(tái)進(jìn)行的工作.
因此,
AsyncTaskLoader的子類(lèi)需要在loadInBackground()中加載數(shù)據(jù), 另外還需要在cancelLoadInBackground()中進(jìn)行對(duì)應(yīng)的操作來(lái)取消加載數(shù)據(jù).
注意在子類(lèi)中區(qū)分onCanceled()和cancelLoadInBackground().
onCanceled()是AsyncTask被取消時(shí)被調(diào)用的, 只是取消了某一個(gè)Task, 有可能是子類(lèi)發(fā)起了另一個(gè)Task.
cancelLoadInBackground()是系統(tǒng)想取消加載數(shù)據(jù)時(shí)用來(lái)取消loadInBackground()中的操作的, 此時(shí)整個(gè)Loader都會(huì)停止加載數(shù)據(jù).
CursorLoader
CursorLoader是AsyncTaskLoader的直接子類(lèi), 期望返回一個(gè)Cursor實(shí)例.
因?yàn)?code>AsyncTaskLoader僅負(fù)責(zé)處理后臺(tái)線程和回調(diào)LoaderInfo注冊(cè)的接口, 所以CursorLoader實(shí)現(xiàn)了onReset(), onStartLoading()和onStopLoading()來(lái)啟動(dòng)/停止/重置加載數(shù)據(jù).
另外還實(shí)現(xiàn)了AsyncTaskLoader的loadInBackground, cancelLoadInBackground和onCanceled().
loadInBackground()
在后臺(tái)線程中, 主要工作是通過(guò)ContentResolver來(lái)獲取Cursor實(shí)例.
因此,
CursorLoader是通過(guò)ContentResolver#query來(lái)獲取Cursor實(shí)例的.
注意: query()可以通過(guò)一個(gè)CancellationSignal實(shí)例來(lái)取消操作.
cancelLoadInBackground()
因?yàn)樵?code>loadInBackground()中啟動(dòng)了一個(gè)query()操作, 所以在這里需要取消這個(gè)query()操作, CursorLoader是通過(guò)CancellationSignal實(shí)例來(lái)實(shí)現(xiàn)的.
onCanceled(Cursor)
簡(jiǎn)單的調(diào)用Cursor#close關(guān)閉.
總結(jié)
- 主要還是關(guān)注
LoaderManager和Loader和生命周期的關(guān)系 -
LoaderInfo是直接管理Loader的類(lèi), 負(fù)責(zé)根據(jù)狀態(tài)調(diào)用Loader的方法. - 如果希望實(shí)現(xiàn)異步加載則繼承
AsyncTaskLoader而不是直接繼承Loader. 注意AsyncTaskLoader不會(huì)啟動(dòng)加載數(shù)據(jù). - 對(duì)于
CursorLoader, 這是一個(gè)專(zhuān)門(mén)用作獲取Cursor的類(lèi), 用來(lái)配合ContentProvider使用, 在我們自定義異步加載Loader的時(shí)候可以參考這個(gè)類(lèi)的實(shí)現(xiàn)方式.
