[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进程初始化时调用的,后续孵化出来的进程不会再进行注册,因此可以采用如下两种方式设置:
- adb shell setprop persist.log.tag.SQLiteLog V并重启手机;
- 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会导致性能下降。