SQLite 加入自定义函数

简介：

SQLite 内置函数比较有限，有时通过添加自定义函数（User-Defined Fuctions）的方式可以实现一些通过普通 SQL 操作无法实现或者实现很麻烦的功能；也可以替换 SQLite 原有的内置函数，使其符合我们的要求。本文侧重说明在 Android 环境下的做法。

现在假设我们现在要在 Android 系统的视频播放器增加一个按照文件扩展名排序的功能，如果不是用自定义函数，就需要先从多媒体数据库中查询出来视频的路径，然后取出视频文件的扩展名并进行排序，因为查询得到的 Cursor 对象不可写，所以需要生成一个 MatrixCursor，把排序后的数据写入，最后返回这个 MatrixCursor。伪代码表示如下：

public Cursor getSortedByFileExtensionCursor() {
    Cursor rawCursor = queryVideoFileNameFromDb(); // 从数据库查询出 id 和路径
    HashMap idAndExtensionMap = getVideoFileExtension(rawCursor); // 获取 id 和扩展名的 HashMap
    Cursor result = sortAndCreateNewMatrixCursor(idAndExtensionMap); // 对扩展名进行排序，生成 MatrixCursor 作为结果
    return result;
}

而如果我们能够向 SQLite 注册一个自定义函数，很多类似问题就要简单不少。

1. 通过 C 语言接口添加自定义函数

如果使用的是 Android 提供的 sqlite 程序，需要修改 Android 源码目录下的 external/sqlite/android/sqlite3_android.cpp 文件。注册一个自定义函数，函数名称是 get_file_ext，在 SQL 语句中的函数名称是 "_GET_FILE_EXT"，简要代码如下：

extern "C" int register_android_functions(sqlite3 * handle, int utf16Storage)
{
    // ...
    
    // 注册自定义函数
    err = sqlite3_create_function(handle, "_GET_FILE_EXT", 1, SQLITE_UTF8, NULL, get_file_ext, NULL, NULL);
    if (err != SQLITE_OK) {
        return err;
    }
    
    // ...
}

// 返回文件扩展名函数的具体实现
static void get_file_ext(sqlite3_context * context, int argc, sqlite3_value ** argv) 
{
    // ...
}

然后编译 external/sqlite，把编译出来的 libsqlite.so 替换手机 /system/lib/ 下面的库。使用该自定义函数也很简单：

public Cursor getSortedByFileExtensionCursor() {
    // 在 sort by 那里使用我们的 SQLite 自定义函数
    Cursor result = query("SELECT * FROM video SORT BY _GET_FILE_EXT(_data)");
}

Note:如果不是在 Android 环境下，或者无法修改 Android 相关代码，则需要自行通过 c 语言的接口操作数据库，然后同样使用 sqlite3_create_function 这个函数注册自定义函数。如果使用的是 C#/Python/PHP 等语言，这些语言都有相应的 SQLite wrapper，可以类似的操作数据库并注册自定义函数。

2. 通过 Java 语言接口添加自定义函数

Android SQLiteDatabase 类里面有一个添加自定义函数的隐藏接口（@hide），在 Android 源码中编译的话可以使用该接口，使用方法大致如下：

public class DatabaseHelper extends SQLiteOpenHelper {
    public DatabaseHelper(Context context, String name, SQLiteDatabase.CursorFactory factory, int version) {
        super(context, name, factory, version);
    }
    
    @Override
    public void onOpen(SQLiteDatabase db) {
        db.addCustomFunction("_GET_FILE_EXT", 1, mGetFileExtension);
    }
    
    private final SQLiteDatabase.CustomFunction mGetFileExtension =
            new SQLiteDatabase.CustomFunction() {
        @Override
        public void callback(String[] args) {
            String file = args[0];
            int index = file.lastIndexOf(".");
            if (index != -1 && file.length() > index + 1) {
                return file.substring(index);
            }
            return null;
        }
    };
}

然后对这个数据库进行查询操作时，就可以使用我们添加的 _GET_FILE_EXT 函数了。Android 源码目录下的 pacakges/providers/MediaProvider 这个程序就使用了此接口，可以参考。

Note:对外发布的程序最好不要依赖隐藏的 Java 接口，兼容性难以保证。

扩展阅读：

• Create Or Redefine SQL Functions：创建自定义函数的解释。
• Quickstart：使用 c 语言接口打开 SQLite 数据库的简单示例代码。