[Android][SQLite]sqlite打log方法

[Android][SQLite]sqlite打log方法

最近開始研究SQLite，首先解決的一個難點居然是打log調試的方法，現記錄如下：
由於sqlite的基礎庫在external/sqlite/dist下，屬於第三方獨立模塊，原則上是不允許依賴Android實現庫的，而直接使用Android native的liblog（ALOG）是無法編譯通過的
（頭鐵想強行加的，可以試試，我覺得比較費神，而且沒必要）

而作爲第三方框架，SQLite肯定也是不可能不存在打log的方法，根據跟代碼（沒錯，就是那30w行的sqlite3.c）發現，sqlite3.c有提供一個名爲sqlite3_log這個函數，讓調用方可以通過回調函數方式在自己的環境下自行選擇log輸出方式，而Android則是在frameworks JNI部分註冊回調，通過ALOG最後輸出日誌信息。

考慮到SQLite的使用頻度，不加以限制的話，log吐出量會非常驚人；
因此這個回調有諸多限制，因此默認調試信息是打不出來的，要輸出log最好的方法還是將log級別提高到W(ARNNING)級別：

邏輯

代碼：frameworks/base/core/jni/android_database_SQLiteGlobal.cpp

// Called each time a message is logged.
static void sqliteLogCallback(void* data, int err, const char* msg) {
    bool verboseLog = !!data;
    int errType = err & 255;
    if (errType == 0 || errType == SQLITE_CONSTRAINT || errType == SQLITE_SCHEMA
            || errType == SQLITE_NOTICE || err == SQLITE_WARNING_AUTOINDEX) {
        //這裏默認是0，具體取值來源於android_util_Log_isVerboseLogEnabled(SQLITE_LOG_TAG);
        if (verboseLog) {
            ALOG(LOG_VERBOSE, SQLITE_LOG_TAG, "(%d) %s\n", err, msg);
        }
    } else if (errType == SQLITE_WARNING) {
        ALOG(LOG_WARN, SQLITE_LOG_TAG, "(%d) %s\n", err, msg);
    } else {
        ALOG(LOG_ERROR, SQLITE_LOG_TAG, "(%d) %s\n", err, msg);
    }
}

// Sets the global SQLite configuration.
// This must be called before any other SQLite functions are called.
static void sqliteInitialize() {
    // Enable multi-threaded mode.  In this mode, SQLite is safe to use by multiple
    // threads as long as no two threads use the same database connection at the same
    // time (which we guarantee in the SQLite database wrappers).
    sqlite3_config(SQLITE_CONFIG_MULTITHREAD);

    // Redirect SQLite log messages to the Android log.
    bool verboseLog = android_util_Log_isVerboseLogEnabled(SQLITE_LOG_TAG);
	//註冊回調
    sqlite3_config(SQLITE_CONFIG_LOG, &sqliteLogCallback, verboseLog ? (void*)1 : NULL);

    // The soft heap limit prevents the page cache allocations from growing
    // beyond the given limit, no matter what the max page cache sizes are
    // set to. The limit does not, as of 3.5.0, affect any other allocations.
    sqlite3_soft_heap_limit(SOFT_HEAP_LIMIT);

    // Initialize SQLite.
    sqlite3_initialize();
}

理論上可以使用adb shell setprop log.tag.SQLiteLog V來打開verbose log的限制，實測沒有生效，究其原因是因爲這個函數是在zygote進程初始化時調用的，後續孵化出來的進程不會再進行註冊，因此可以採用如下兩種方式設置：

1. adb shell setprop persist.log.tag.SQLiteLog V並重啓手機；
2. adb shell setprop log.tag.SQLiteLog V並通過stop; start重啓上層；

無論哪種方法都需要root權限，但帶root的軟件不好衡量性能指標，因此最好使用如下方案：

方案

因此比較穩妥的方法是使用WARNING級別的log：
從上方回調函數可以看到，當errType == SQLITE_WARNING時是無條件輸出的，因此可以直接使用：

sqlite3_log(SQLITE_WARNING, "SQLITE_WARNING:ZSUI:-->sqlite3_open-->zFilename=%s", zFilename);

即可；

後記

log僅僅是調試用，實際生產環境切記要刪除，SQLite的API是高密度操作，掛log會導致性能下降。