簡(jiǎn)介：
本文介紹如何在 Android 檢測(cè) Cursor 泄漏的原理以及使用方法，還指出幾種常見的出錯(cuò)示例。有一些泄漏在代碼中難以察覺，但程序長時(shí)間運(yùn)行后必然會(huì)出現(xiàn)異常。同時(shí)該方法同樣適合于其他需要檢測(cè)資源泄露的情況。
最近發(fā)現(xiàn)某蔬菜手機(jī)連接程序在查詢媒體存儲(chǔ)（MediaProvider）數(shù)據(jù)庫時(shí)出現(xiàn)嚴(yán)重 Cursor 泄漏現(xiàn)象，運(yùn)行一段時(shí)間后會(huì)導(dǎo)致系統(tǒng)中所有使用到該數(shù)據(jù)庫的程序無法使用。另外在工作中也常發(fā)現(xiàn)有些應(yīng)用有 Cursor 泄漏現(xiàn)象，由于需要長時(shí)間運(yùn)行才會(huì)出現(xiàn)異常，所以有的此類 bug 很長時(shí)間都沒被發(fā)現(xiàn)。
但是一旦 Cursor 泄漏累計(jì)到一定數(shù)目（通常為數(shù)百個(gè)）必然會(huì)出現(xiàn)無法查詢數(shù)據(jù)庫的情況，只有等數(shù)據(jù)庫服務(wù)所在進(jìn)程死掉重啟才能恢復(fù)正常。通常的出錯(cuò)信息如下，指出某 pid 的程序打開了 866 個(gè) Cursor 沒有關(guān)閉，導(dǎo)致了 exception：
3634 3644 E JavaBinder: *** Uncaught remote exception! (Exceptions are not yet supported across processes.)
3634 3644 E JavaBinder: android.database.CursorWindowAllocationException: Cursor window allocation of 2048 kb failed. # Open Cursors=866 (# cursors opened by pid 1565=866)
3634 3644 E JavaBinder: at android.database.CursorWindow.(CursorWindow.java:104)
3634 3644 E JavaBinder: at android.database.AbstractWindowedCursor.clearOrCreateWindow(AbstractWindowedCursor.java:198)
3634 3644 E JavaBinder: at android.database.sqlite.SQLiteCursor.fillWindow(SQLiteCursor.java:147)
3634 3644 E JavaBinder: at android.database.sqlite.SQLiteCursor.getCount(SQLiteCursor.java:141)
3634 3644 E JavaBinder: at android.database.CursorToBulkCursorAdaptor.getBulkCursorDescriptor(CursorToBulkCursorAdaptor.java:143)
3634 3644 E JavaBinder: at android.content.ContentProviderNative.onTransact(ContentProviderNative.java:118)
3634 3644 E JavaBinder: at android.os.Binder.execTransact(Binder.java:367)
3634 3644 E JavaBinder: at dalvik.system.NativeStart.run(Native Method)
1. Cursor 檢測(cè)原理
在 Cursor 對(duì)象被 JVM 回收運(yùn)行到 finalize() 方法的時(shí)候，檢測(cè) close() 方法有沒有被調(diào)用，此辦法在 ContentResolver 里面也得到應(yīng)用。簡(jiǎn)化后的示例代碼如下：
import android.database.Cursor;
import android.database.CursorWrapper;
import android.util.Log;
public class TestCursor extends CursorWrapper {
private static final String TAG = "TestCursor";
private boolean mIsClosed = false;
private Throwable mTrace;
public TestCursor(Cursor c) {
super(c);
mTrace = new Throwable("Explicit termination method 'close()' not called");
}
@Override
public void close() {
mIsClosed = true;
}
@Override
public void finalize() throws Throwable {
try {
if (mIsClosed != true) {
Log.e(TAG, "Cursor leaks", mTrace);
}
} finally {
super.finalize();
}
}
}
然后查詢的時(shí)候，把 TestCursor 作為查詢結(jié)果返回給 APP：
1 return new TestCursor(cursor); // cursor 是普通查詢得到的結(jié)果，例如從 ContentProvider.query()
該方法同樣適合于所有需要檢測(cè)顯式釋放資源方法沒有被調(diào)用的情形，是一種通用方法。但在 finalize() 方法里檢測(cè)需要注意
優(yōu)點(diǎn)：準(zhǔn)確。因?yàn)樵撡Y源在 Cursor 對(duì)象被回收時(shí)仍沒被釋放，肯定是發(fā)生了資源泄露。
缺點(diǎn)：依賴于 finalize() 方法，也就依賴于 JVM 的垃圾回收策略。例如某 APP 現(xiàn)在有 10 個(gè) Cursor 對(duì)象泄露，并且這 10 個(gè)對(duì)象已經(jīng)不再被任何引用指向處于可回收狀態(tài)，但是 JVM 可能并不會(huì)馬上回收（時(shí)間不可預(yù)測(cè)），如果你現(xiàn)在檢查不能夠發(fā)現(xiàn)問題。另外，在某些情況下就算對(duì)象被回收 finalize() 可能也不會(huì)執(zhí)行，也就是不能保證檢測(cè)出所有問題。關(guān)于 finalize() 更多信息可以參考《Effective Java 2nd Edition》的 Item 7： Avoid Finalizers
2. 使用方法
對(duì)于 APP 開發(fā)人員
從 GINGERBREAD 開始 Android 就提供了 StrictMode 工具協(xié)助開發(fā)人員檢查是否不小心地做了一些不該有的操作。使用方法是在 Activity 里面設(shè)置 StrictMode，下面的例子是打開了檢查泄漏的 SQLite 對(duì)象以及 Closeable 對(duì)象（普通 Cursor/FileInputStream 等）的功能，發(fā)現(xiàn)有違規(guī)情況則記錄 log 并使程序強(qiáng)行退出。
import android.os.StrictMode;
public class TestActivity extends Activity {
private static final boolean DEVELOPER_MODE = true;
public void onCreate() {
if (DEVELOPER_MODE) {
StrictMode.setVMPolicy(new StrictMode.VMPolicy.Builder()
.detectLeakedSqlLiteObjects()
.detectLeakedClosableObjects()
.penaltyLog()
.penaltyDeath()
.build());
}
super.onCreate();
}
}
對(duì)于 framework 開發(fā)人員
如果是通過 ContentProvider 提供數(shù)據(jù)庫數(shù)據(jù)，在 ContentResolver 里面已有 CloseGuard 類實(shí)行類似檢測(cè)，但需要自行打開（上例也是打開 CloseGuard）：
1 CloseGuard.setEnabled(true);更值得推薦的辦法是按照本文第一節(jié)中的檢測(cè)原理，在 ContentResolver 內(nèi)部類 CursorWrapperInner 里面加入。其他需要檢測(cè)類似于資源泄漏的，同樣可以使用該檢測(cè)原理。
3. 容易出錯(cuò)的地方
忘記調(diào)用 close() 這種低級(jí)錯(cuò)誤沒什么好說的，這種應(yīng)該也占不小的比例。下面說說不太明顯的例子。
提前返回
有時(shí)候粗心會(huì)犯這種錯(cuò)誤，在 close() 調(diào)用之前就 return 了，特別是函數(shù)比較大邏輯比較復(fù)雜時(shí)更容易犯錯(cuò)。這種情況可以通過把 close() 放在 finally 代碼塊解決
private void method() {
Cursor cursor = query(); // 假設(shè) query() 是一個(gè)查詢數(shù)據(jù)庫返回 Cursor 結(jié)果的函數(shù)
if (flag == false) { // ！！提前返回
return;
}
cursor.close();
}
類的成員變量
假設(shè)類里面有一個(gè)在類全局有效的成員變量，在方法 A 獲取了查詢結(jié)果，后面在其他地方又獲取了一次查詢結(jié)果，那么第二次查詢的時(shí)候就應(yīng)該先把前面一個(gè) Cursor 對(duì)象關(guān)閉。
public class TestCursor {
private Cursor mCursor;
private void methodA() {
mCursor = query();
}
private void methodB() {
// ！！必須先關(guān)閉上一個(gè) cursor 對(duì)象
mCursor = query();
}
}
注意：曾經(jīng)遇到過有人對(duì) mCursor 感到疑惑，明明是同一個(gè)變量為什么還需要先關(guān)閉？首先 mCursor 是一個(gè) Cursor 對(duì)象的引用，在 methodA 時(shí) mCursor 指向了 query() 返回的一個(gè) Cursor 對(duì)象 1；在 methodB() 時(shí)它又指向了返回的另外一個(gè) Cursor 對(duì)象 2。在指向 Cursor 對(duì)象 2 之前必須先關(guān)閉 Cursor 對(duì)象 1，否則就出現(xiàn)了 Cursor 對(duì)象 1 在 finalize() 之前沒有調(diào)用 close() 的情況。
異常處理
打開和關(guān)閉 Cursor 之間的代碼出現(xiàn) exception，導(dǎo)致沒有跑到關(guān)閉的地方：
try {
Cursor cursor = query();
// 中間省略某些出現(xiàn)異常的代碼
cursor.close();
} catch (Exception e) {
// ！！出現(xiàn)異常沒跑到 cursor.close()
}
這種情況應(yīng)該把 close() 放到 finally 代碼塊里面：
Cursor cursor = null;
try {
cursor = query();
// 中間省略某些出現(xiàn)異常的代碼
} catch (Exception e) {
// 出現(xiàn)異常
} finally {
if (cursor != null)
cursor.close();
}
4. 總結(jié)思考
在 finalize() 里面檢測(cè)是可行的，且基本可以滿足需要。針對(duì) finalize() 執(zhí)行時(shí)間不確定以及可能不執(zhí)行的問題，可以通過記錄目前打開沒關(guān)閉的 Cursor 數(shù)量來部分解決，超過一定數(shù)目發(fā)出警告，兩種手段相結(jié)合。
還有沒有其他檢測(cè)辦法呢？有，在 Cursor 構(gòu)造方法以及 close() 方法添加 log，運(yùn)行一段時(shí)間后檢查 log 看哪個(gè)地方?jīng)]有關(guān)閉。簡(jiǎn)化代碼如下：
import android.database.Cursor;
import android.database.CursorWrapper;
import android.util.Log;
public class TestCursor extends CursorWrapper {
private static final String TAG = "TestCursor";
private Throwable mTrace;
public TestCursor(Cursor c) {
super(c);
mTrace = new Throwable("cusor opened here");
Log.d(TAG, "Cursor " + this.hashCode() + " opened, stacktrace is: ", mTrace);
}
@Override
public void close() {
mIsClosed = true;
Log.d(TAG, "Cursor " + this.hashCode() + " closed.");
}
}
檢查時(shí)看某個(gè) hashCode() 的 Cursor 有沒有調(diào)用過 close() 方法，沒有的話說明資源有泄露。這種方法優(yōu)點(diǎn)是同樣準(zhǔn)確，且更可靠。缺點(diǎn)是需要檢查大量 log，且打開/關(guān)閉的地方可能相距較遠(yuǎn)，如果不寫個(gè)小腳本分析人工看的話會(huì)比較痛苦；另外必須 APP 完全退出后才能檢查，因?yàn)楹笈_(tái)運(yùn)行時(shí)某些 Cursor 還在正常使用。
