SQLite3 API 編程手冊(cè)

前序：... 1
一、 版本... 1
二、 基本編譯... 2
三、 SQLITE操作入門... 2
（1） 基本流程... 2
（2） SQL語(yǔ)句操作... 4
（3） 操作二進(jìn)制... 8
（4） 事務(wù)處理... 10
四、 給數(shù)據(jù)庫(kù)加密... 10
五、 后記... 25

前序：
Sqlite3 的確很好用。小巧、速度快。但是因?yàn)榉俏④浀漠a(chǎn)品，幫助文檔總覺(jué)得不夠。這些天再次研究它，又有一些收獲，這里把我對(duì) sqlite3 的研究列出來(lái)，以備忘記。

這里要注明，我是一個(gè)跨平臺(tái)專注者，并不喜歡只用 windows 平臺(tái)。我以前的工作就是為 unix 平臺(tái)寫(xiě)代碼。下面我所寫(xiě)的東西，雖然沒(méi)有驗(yàn)證，但是我已盡量不使用任何 windows 的東西，只使用標(biāo)準(zhǔn) C 或標(biāo)準(zhǔn)C++。但是，我沒(méi)有嘗試過(guò)在別的系統(tǒng)、別的編譯器下編譯，因此下面的敘述如果不正確，則留待以后修改。

下面我的代碼仍然用 VC 編寫(xiě)，因?yàn)槲矣X(jué)得VC是一個(gè)很不錯(cuò)的IDE，可以加快代碼編寫(xiě)速度（例如配合 Vassist ）。下面我所說(shuō)的編譯環(huán)境，是VC2003。如果讀者覺(jué)得自己習(xí)慣于 unix 下用 vi 編寫(xiě)代碼速度較快，可以不用管我的說(shuō)明，只需要符合自己習(xí)慣即可，因?yàn)槲矣玫氖菢?biāo)準(zhǔn) C 或 C++ 。不會(huì)給任何人帶來(lái)不便。

一、 版本
從 www.sqlite.org 網(wǎng)站可下載到最新的 sqlite 代碼和編譯版本。我寫(xiě)此文章時(shí)，最新代碼是 3.3.17 版本。

很久沒(méi)有去下載 sqlite 新代碼，因此也不知道 sqlite 變化這么大。以前很多文件，現(xiàn)在全部合并成一個(gè) sqlite3.c 文件。如果單獨(dú)用此文件，是挺好的，省去拷貝一堆文件還擔(dān)心有沒(méi)有遺漏。但是也帶來(lái)一個(gè)問(wèn)題：此文件太大，快接近7萬(wàn)行代碼，VC開(kāi)它整個(gè)機(jī)器都慢下來(lái)了。如果不需要改它代碼，也就不需要打開(kāi) sqlite3.c 文件，機(jī)器不會(huì)慢。但是，下面我要寫(xiě)通過(guò)修改 sqlite 代碼完成加密功能，那時(shí)候就比較痛苦了。如果個(gè)人水平較高，建議用些簡(jiǎn)單的編輯器來(lái)編輯，例如 UltraEdit 或 Notepad 。速度會(huì)快很多。

二、 基本編譯
這個(gè)不想多說(shuō)了，在 VC 里新建 dos 控制臺(tái)空白工程，把 sqlite3.c 和 sqlite3.h 添加到工程，再新建一個(gè) main.cpp 文件。在里面寫(xiě):

為什么要 extern “C” ？如果問(wèn)這個(gè)問(wèn)題，我不想說(shuō)太多，這是C++的基礎(chǔ)。要在 C++ 里使用一段 C 的代碼，必須要用 extern “C” 括起來(lái)。C++跟 C雖然語(yǔ)法上有重疊，但是它們是兩個(gè)不同的東西，內(nèi)存里的布局是完全不同的，在C++編譯器里不用extern “C”括起C代碼，會(huì)導(dǎo)致編譯器不知道該如何為 C 代碼描述內(nèi)存布局。

可能在 sqlite3.c 里人家已經(jīng)把整段代碼都 extern “C” 括起來(lái)了，但是你遇到一個(gè) .c 文件就自覺(jué)的再括一次，也沒(méi)什么不好。

基本工程就這樣建立起來(lái)了。編譯，可以通過(guò)。但是有一堆的 warning?？梢圆还芩?/P>

三、 SQLITE操作入門
sqlite提供的是一些C函數(shù)接口，你可以用這些函數(shù)操作數(shù)據(jù)庫(kù)。通過(guò)使用這些接口，傳遞一些標(biāo)準(zhǔn) sql 語(yǔ)句（以 char * 類型）給 sqlite 函數(shù)，sqlite 就會(huì)為你操作數(shù)據(jù)庫(kù)。

sqlite 跟MS的access一樣是文件型數(shù)據(jù)庫(kù)，就是說(shuō)，一個(gè)數(shù)據(jù)庫(kù)就是一個(gè)文件，此數(shù)據(jù)庫(kù)里可以建立很多的表，可以建立索引、觸發(fā)器等等，但是，它實(shí)際上得到的就是一個(gè)文件。備份這個(gè)文件就備份了整個(gè)數(shù)據(jù)庫(kù)。

sqlite 不需要任何數(shù)據(jù)庫(kù)引擎，這意味著如果你需要 sqlite 來(lái)保存一些用戶數(shù)據(jù)，甚至都不需要安裝數(shù)據(jù)庫(kù)(如果你做個(gè)小軟件還要求人家必須裝了sqlserver 才能運(yùn)行，那也太黑心了)。

下面開(kāi)始介紹數(shù)據(jù)庫(kù)基本操作。

（1） 基本流程
i.1 關(guān)鍵數(shù)據(jù)結(jié)構(gòu)

sqlite 里最常用到的是 sqlite3 * 類型。從數(shù)據(jù)庫(kù)打開(kāi)開(kāi)始，sqlite就要為這個(gè)類型準(zhǔn)備好內(nèi)存，直到數(shù)據(jù)庫(kù)關(guān)閉，整個(gè)過(guò)程都需要用到這個(gè)類型。當(dāng)數(shù)據(jù)庫(kù)打開(kāi)時(shí)開(kāi)始，這個(gè)類型的變量就代表了你要操作的數(shù)據(jù)庫(kù)。下面再詳細(xì)介紹。

i.2 打開(kāi)數(shù)據(jù)庫(kù)

int sqlite3_open( 文件名, sqlite3 ** );

用這個(gè)函數(shù)開(kāi)始數(shù)據(jù)庫(kù)操作。

需要傳入兩個(gè)參數(shù)，一是數(shù)據(jù)庫(kù)文件名，比如：c://DongChunGuang_Database.db。

文件名不需要一定存在，如果此文件不存在，sqlite 會(huì)自動(dòng)建立它。如果它存在，就嘗試把它當(dāng)數(shù)據(jù)庫(kù)文件來(lái)打開(kāi)。

sqlite3 ** 參數(shù)即前面提到的關(guān)鍵數(shù)據(jù)結(jié)構(gòu)。這個(gè)結(jié)構(gòu)底層細(xì)節(jié)如何，你不要關(guān)它。

函數(shù)返回值表示操作是否正確，如果是 SQLITE_OK 則表示操作正常。相關(guān)的返回值sqlite定義了一些宏。具體這些宏的含義可以參考 sqlite3.h 文件。里面有詳細(xì)定義（順便說(shuō)一下，sqlite3 的代碼注釋率自稱是非常高的，實(shí)際上也的確很高。只要你會(huì)看英文，sqlite 可以讓你學(xué)到不少東西）。

下面介紹關(guān)閉數(shù)據(jù)庫(kù)后，再給一段參考代碼。

i.3 關(guān)閉數(shù)據(jù)庫(kù)

int sqlite3_close(sqlite3 *);

前面如果用 sqlite3_open 開(kāi)啟了一個(gè)數(shù)據(jù)庫(kù)，結(jié)尾時(shí)不要忘了用這個(gè)函數(shù)關(guān)閉數(shù)據(jù)庫(kù)。

下面給段簡(jiǎn)單的代碼：

這就是一次數(shù)據(jù)庫(kù)操作過(guò)程。

（2） SQL語(yǔ)句操作
本節(jié)介紹如何用sqlite 執(zhí)行標(biāo)準(zhǔn) sql 語(yǔ)法。

i.1 執(zhí)行sql語(yǔ)句
int sqlite3_exec(sqlite3*, const char *sql, sqlite3_callback, void *, char **errmsg );

這就是執(zhí)行一條 sql 語(yǔ)句的函數(shù)。

第1個(gè)參數(shù)不再說(shuō)了，是前面open函數(shù)得到的指針。說(shuō)了是關(guān)鍵數(shù)據(jù)結(jié)構(gòu)。

第2個(gè)參數(shù)const char *sql 是一條 sql 語(yǔ)句，以/0結(jié)尾。

第3個(gè)參數(shù)sqlite3_callback 是回調(diào)，當(dāng)這條語(yǔ)句執(zhí)行之后，sqlite3會(huì)去調(diào)用你提供的這個(gè)函數(shù)。（什么是回調(diào)函數(shù)，自己找別的資料學(xué)習(xí)）

第4個(gè)參數(shù)void * 是你所提供的指針，你可以傳遞任何一個(gè)指針參數(shù)到這里，這個(gè)參數(shù)最終會(huì)傳到回調(diào)函數(shù)里面，如果不需要傳遞指針給回調(diào)函數(shù)，可以填NULL。等下我們?cè)倏椿卣{(diào)函數(shù)的寫(xiě)法，以及這個(gè)參數(shù)的使用。

第5個(gè)參數(shù)char ** errmsg 是錯(cuò)誤信息。注意是指針的指針。sqlite3里面有很多固定的錯(cuò)誤信息。執(zhí)行 sqlite3_exec 之后，執(zhí)行失敗時(shí)可以查閱這個(gè)指針（直接 printf(“%s/n”,errmsg)）得到一串字符串信息，這串信息告訴你錯(cuò)在什么地方。sqlite3_exec函數(shù)通過(guò)修改你傳入的指針的指針，把你提供的指針指向錯(cuò)誤提示信息，這樣sqlite3_exec函數(shù)外面就可以通過(guò)這個(gè) char*得到具體錯(cuò)誤提示。

說(shuō)明：通常，sqlite3_callback 和它后面的 void * 這兩個(gè)位置都可以填 NULL。填NULL表示你不需要回調(diào)。比如你做 insert 操作，做 delete 操作，就沒(méi)有必要使用回調(diào)。而當(dāng)你做 select 時(shí)，就要使用回調(diào)，因?yàn)?sqlite3 把數(shù)據(jù)查出來(lái)，得通過(guò)回調(diào)告訴你查出了什么數(shù)據(jù)。

i.2 exec 的回調(diào)

typedef int (*sqlite3_callback)(void*,int,char**, char**);

你的回調(diào)函數(shù)必須定義成上面這個(gè)函數(shù)的類型。下面給個(gè)簡(jiǎn)單的例子：

通過(guò)上面的例子，應(yīng)該可以知道如何打開(kāi)一個(gè)數(shù)據(jù)庫(kù)，如何做數(shù)據(jù)庫(kù)基本操作。

有這些知識(shí)，基本上可以應(yīng)付很多數(shù)據(jù)庫(kù)操作了。

i.3 不使用回調(diào)查詢數(shù)據(jù)庫(kù)

上面介紹的 sqlite3_exec 是使用回調(diào)來(lái)執(zhí)行 select 操作。還有一個(gè)方法可以直接查詢而不需要回調(diào)。但是，我個(gè)人感覺(jué)還是回調(diào)好，因?yàn)榇a可以更加整齊，只不過(guò)用回調(diào)很麻煩，你得聲明一個(gè)函數(shù)，如果這個(gè)函數(shù)是類成員函數(shù)，你還不得不把它聲明成 static 的（要問(wèn)為什么？這又是C++基礎(chǔ)了。C++成員函數(shù)實(shí)際上隱藏了一個(gè)參數(shù)：this，C++調(diào)用類的成員函數(shù)的時(shí)候，隱含把類指針當(dāng)成函數(shù)的第一個(gè)參數(shù)傳遞進(jìn)去。結(jié)果，這造成跟前面說(shuō)的 sqlite 回調(diào)函數(shù)的參數(shù)不相符。只有當(dāng)把成員函數(shù)聲明成 static 時(shí)，它才沒(méi)有多余的隱含的this參數(shù)）。

雖然回調(diào)顯得代碼整齊，但有時(shí)候你還是想要非回調(diào)的 select 查詢。這可以通過(guò) sqlite3_get_table 函數(shù)做到。

int sqlite3_get_table(sqlite3*, const char *sql, char ***resultp, int *nrow, int *ncolumn, char **errmsg );

第1個(gè)參數(shù)不再多說(shuō)，看前面的例子。
第2個(gè)參數(shù)是 sql 語(yǔ)句，跟 sqlite3_exec 里的 sql 是一樣的。是一個(gè)很普通的以/0結(jié)尾的char *字符串。
第3個(gè)參數(shù)是查詢結(jié)果，它依然一維數(shù)組（不要以為是二維數(shù)組，更不要以為是三維數(shù)組）。它內(nèi)存布局是：第一行是字段名稱，后面是緊接著是每個(gè)字段的值。下面用例子來(lái)說(shuō)事。
第4個(gè)參數(shù)是查詢出多少條記錄（即查出多少行）。
第5個(gè)參數(shù)是多少個(gè)字段（多少列）。
第6個(gè)參數(shù)是錯(cuò)誤信息，跟前面一樣，這里不多說(shuō)了。

下面給個(gè)簡(jiǎn)單例子:

到這個(gè)例子為止，sqlite3 的常用用法都介紹完了。

用以上的方法，再配上 sql 語(yǔ)句，完全可以應(yīng)付絕大多數(shù)數(shù)據(jù)庫(kù)需求。

但有一種情況，用上面方法是無(wú)法實(shí)現(xiàn)的：需要insert、select 二進(jìn)制。當(dāng)需要處理二進(jìn)制數(shù)據(jù)時(shí)，上面的方法就沒(méi)辦法做到。下面這一節(jié)說(shuō)明如何插入二進(jìn)制數(shù)據(jù)

（2） 操作二進(jìn)制
sqlite 操作二進(jìn)制數(shù)據(jù)需要用一個(gè)輔助的數(shù)據(jù)類型：sqlite3_stmt * 。

這個(gè)數(shù)據(jù)類型記錄了一個(gè)“sql語(yǔ)句”。為什么我把 “sql語(yǔ)句” 用雙引號(hào)引起來(lái)？因?yàn)槟憧梢园?sqlite3_stmt * 所表示的內(nèi)容看成是 sql語(yǔ)句，但是實(shí)際上它不是我們所熟知的sql語(yǔ)句。它是一個(gè)已經(jīng)把sql語(yǔ)句解析了的、用sqlite自己標(biāo)記記錄的內(nèi)部數(shù)據(jù)結(jié)構(gòu)。

正因?yàn)檫@個(gè)結(jié)構(gòu)已經(jīng)被解析了，所以你可以往這個(gè)語(yǔ)句里插入二進(jìn)制數(shù)據(jù)。當(dāng)然，把二進(jìn)制數(shù)據(jù)插到 sqlite3_stmt 結(jié)構(gòu)里可不能直接 memcpy ，也不能像 std::string 那樣用 + 號(hào)。必須用 sqlite 提供的函數(shù)來(lái)插入。

i.1 寫(xiě)入二進(jìn)制

下面說(shuō)寫(xiě)二進(jìn)制的步驟。

要插入二進(jìn)制，前提是這個(gè)表的字段的類型是 blob 類型。我假設(shè)有這么一張表：

create table Tbl_2( ID integer, file_content blob )

首先聲明

sqlite3_stmt * stat;

然后，把一個(gè) sql 語(yǔ)句解析到 stat 結(jié)構(gòu)里去：

sqlite3_prepare( db, “insert into Tbl_2( ID, file_content) values( 10, ? )”, -1, stat, 0 );

上面的函數(shù)完成 sql 語(yǔ)句的解析。第一個(gè)參數(shù)跟前面一樣，是個(gè) sqlite3 * 類型變量，第二個(gè)參數(shù)是一個(gè) sql 語(yǔ)句。

這個(gè) sql 語(yǔ)句特別之處在于 values 里面有個(gè) ? 號(hào)。在sqlite3_prepare函數(shù)里，?號(hào)表示一個(gè)未定的值，它的值等下才插入。

第三個(gè)參數(shù)我寫(xiě)的是-1，這個(gè)參數(shù)含義是前面 sql 語(yǔ)句的長(zhǎng)度。如果小于0，sqlite會(huì)自動(dòng)計(jì)算它的長(zhǎng)度（把sql語(yǔ)句當(dāng)成以/0結(jié)尾的字符串）。
第四個(gè)參數(shù)是 sqlite3_stmt 的指針的指針。解析以后的sql語(yǔ)句就放在這個(gè)結(jié)構(gòu)里。
第五個(gè)參數(shù)我也不知道是干什么的。為0就可以了。

如果這個(gè)函數(shù)執(zhí)行成功（返回值是 SQLITE_OK 且 stat 不為NULL ），那么下面就可以開(kāi)始插入二進(jìn)制數(shù)據(jù)。

sqlite3_bind_blob( stat, 1, pdata, (int)(length_of_data_in_bytes), NULL ); // pdata為數(shù)據(jù)緩沖區(qū)，length_of_data_in_bytes為數(shù)據(jù)大小，以字節(jié)為單位

這個(gè)函數(shù)一共有5個(gè)參數(shù)。

第1個(gè)參數(shù)：是前面prepare得到的 sqlite3_stmt * 類型變量。
第2個(gè)參數(shù)：?號(hào)的索引。前面prepare的sql語(yǔ)句里有一個(gè)?號(hào)，假如有多個(gè)?號(hào)怎么插入？方法就是改變 bind_blob 函數(shù)第2個(gè)參數(shù)。這個(gè)參數(shù)我寫(xiě)1，表示這里插入的值要替換 stat 的第一個(gè)?號(hào)（這里的索引從1開(kāi)始計(jì)數(shù)，而非從0開(kāi)始）。如果你有多個(gè)?號(hào)，就寫(xiě)多個(gè) bind_blob 語(yǔ)句，并改變它們的第2個(gè)參數(shù)就替換到不同的?號(hào)。如果有?號(hào)沒(méi)有替換，sqlite為它取值null。
第3個(gè)參數(shù)：二進(jìn)制數(shù)據(jù)起始指針。
第4個(gè)參數(shù)：二進(jìn)制數(shù)據(jù)的長(zhǎng)度，以字節(jié)為單位。
第5個(gè)參數(shù)：是個(gè)析夠回調(diào)函數(shù)，告訴sqlite當(dāng)把數(shù)據(jù)處理完后調(diào)用此函數(shù)來(lái)析夠你的數(shù)據(jù)。這個(gè)參數(shù)我還沒(méi)有使用過(guò)，因此理解也不深刻。但是一般都填NULL，需要釋放的內(nèi)存自己用代碼來(lái)釋放。

bind完了之后，二進(jìn)制數(shù)據(jù)就進(jìn)入了你的“sql語(yǔ)句”里了。你現(xiàn)在可以把它保存到數(shù)據(jù)庫(kù)里：

int result = sqlite3_step( stat );

通過(guò)這個(gè)語(yǔ)句，stat 表示的sql語(yǔ)句就被寫(xiě)到了數(shù)據(jù)庫(kù)里。

最后，要把 sqlite3_stmt 結(jié)構(gòu)給釋放：

sqlite3_finalize( stat ); //把剛才分配的內(nèi)容析構(gòu)掉

i.2 讀出二進(jìn)制

下面說(shuō)讀二進(jìn)制的步驟。

跟前面一樣，先聲明 sqlite3_stmt * 類型變量：

sqlite3_stmt * stat;

然后，把一個(gè) sql 語(yǔ)句解析到 stat 結(jié)構(gòu)里去：

sqlite3_prepare( db, “select * from Tbl_2”, -1, stat, 0 );

當(dāng) prepare 成功之后（返回值是 SQLITE_OK ），開(kāi)始查詢數(shù)據(jù)。

int result = sqlite3_step( stat );

這一句的返回值是 SQLITE_ROW 時(shí)表示成功（不是 SQLITE_OK ）。

你可以循環(huán)執(zhí)行 sqlite3_step 函數(shù)，一次 step 查詢出一條記錄。直到返回值不為 SQLITE_ROW 時(shí)表示查詢結(jié)束。

然后開(kāi)始獲取第一個(gè)字段：ID 的值。ID是個(gè)整數(shù)，用下面這個(gè)語(yǔ)句獲取它的值：

int id = sqlite3_column_int( stat, 0 ); //第2個(gè)參數(shù)表示獲取第幾個(gè)字段內(nèi)容，從0開(kāi)始計(jì)算，因?yàn)槲业谋淼腎D字段是第一個(gè)字段，因此這里我填0

下面開(kāi)始獲取 file_content 的值，因?yàn)?file_content 是二進(jìn)制，因此我需要得到它的指針，還有它的長(zhǎng)度：

const void * pFileContent = sqlite3_column_blob( stat, 1 );

int len = sqlite3_column_bytes( stat, 1 );

這樣就得到了二進(jìn)制的值。

把 pFileContent 的內(nèi)容保存出來(lái)之后，不要忘了釋放 sqlite3_stmt 結(jié)構(gòu)：

sqlite3_finalize( stat ); //把剛才分配的內(nèi)容析構(gòu)掉

i.3 重復(fù)使用 sqlite3_stmt 結(jié)構(gòu)

如果你需要重復(fù)使用 sqlite3_prepare 解析好的 sqlite3_stmt 結(jié)構(gòu)，需要用函數(shù)： sqlite3_reset。

result = sqlite3_reset(stat);

這樣， stat 結(jié)構(gòu)又成為 sqlite3_prepare 完成時(shí)的狀態(tài)，你可以重新為它 bind 內(nèi)容。

（4） 事務(wù)處理

sqlite 是支持事務(wù)處理的。如果你知道你要同步刪除很多數(shù)據(jù)，不仿把它們做成一個(gè)統(tǒng)一的事務(wù)。

通常一次 sqlite3_exec 就是一次事務(wù)，如果你要?jiǎng)h除1萬(wàn)條數(shù)據(jù)，sqlite就做了1萬(wàn)次：開(kāi)始新事務(wù)->刪除一條數(shù)據(jù)->提交事務(wù)->開(kāi)始新事務(wù)->… 的過(guò)程。這個(gè)操作是很慢的。因?yàn)闀r(shí)間都花在了開(kāi)始事務(wù)、提交事務(wù)上。

你可以把這些同類操作做成一個(gè)事務(wù)，這樣如果操作錯(cuò)誤，還能夠回滾事務(wù)。

事務(wù)的操作沒(méi)有特別的接口函數(shù)，它就是一個(gè)普通的 sql 語(yǔ)句而已：

分別如下：

一、 給數(shù)據(jù)庫(kù)加密

前面所說(shuō)的內(nèi)容網(wǎng)上已經(jīng)有很多資料，雖然比較零散，但是花點(diǎn)時(shí)間也還是可以找到的?，F(xiàn)在要說(shuō)的這個(gè)——數(shù)據(jù)庫(kù)加密，資料就很難找。也可能是我操作水平不夠，找不到對(duì)應(yīng)資料。但不管這樣，我還是通過(guò)網(wǎng)上能找到的很有限的資料，探索出了給sqlite數(shù)據(jù)庫(kù)加密的完整步驟。

這里要提一下，雖然 sqlite 很好用，速度快、體積小巧。但是它保存的文件卻是明文的。若不信可以用 NotePad 打開(kāi)數(shù)據(jù)庫(kù)文件瞧瞧，里面 insert 的內(nèi)容幾乎一覽無(wú)余。這樣赤裸裸的展現(xiàn)自己，可不是我們的初衷。當(dāng)然，如果你在嵌入式系統(tǒng)、智能手機(jī)上使用 sqlite，最好是不加密，因?yàn)檫@些系統(tǒng)運(yùn)算能力有限，你做為一個(gè)新功能提供者，不能把用戶有限的運(yùn)算能力全部花掉。

Sqlite為了速度而誕生。因此Sqlite本身不對(duì)數(shù)據(jù)庫(kù)加密，要知道，如果你選擇標(biāo)準(zhǔn)AES算法加密，那么一定有接近50%的時(shí)間消耗在加解密算法上，甚至更多（性能主要取決于你算法編寫(xiě)水平以及你是否能使用cpu提供的底層運(yùn)算能力，比如MMX或sse系列指令可以大幅度提升運(yùn)算速度）。

Sqlite免費(fèi)版本是不提供加密功能的，當(dāng)然你也可以選擇他們的收費(fèi)版本，那你得支付2000塊錢，而且是USD。我這里也不是說(shuō)支付錢不好，如果只為了數(shù)據(jù)庫(kù)加密就去支付2000塊，我覺(jué)得劃不來(lái)。因?yàn)橄旅嫖覍⒁嬖V你如何為免費(fèi)的Sqlite擴(kuò)展出加密模塊——自己動(dòng)手?jǐn)U展，這是Sqlite允許，也是它提倡的。

那么，就讓我們一起開(kāi)始為 sqlite3.c 文件擴(kuò)展出加密模塊。

i.1 必要的宏

通過(guò)閱讀 Sqlite 代碼（當(dāng)然沒(méi)有全部閱讀完，6萬(wàn)多行代碼，沒(méi)有一行是我習(xí)慣的風(fēng)格，我可沒(méi)那么多眼神去看），我搞清楚了兩件事：

Sqlite是支持加密擴(kuò)展的；

需要 #define 一個(gè)宏才能使用加密擴(kuò)展。

這個(gè)宏就是

SQLITE_HAS_CODEC。

你在代碼最前面（也可以在 sqlite3.h 文件第一行）定義：

#ifndef SQLITE_HAS_CODEC

#define SQLITE_HAS_CODEC

#endif

如果你在代碼里定義了此宏，但是還能夠正常編譯，那么應(yīng)該是操作沒(méi)有成功。因?yàn)槟銘?yīng)該會(huì)被編譯器提示有一些函數(shù)無(wú)法鏈接才對(duì)。如果你用的是 VC 2003，你可以在“解決方案”里右鍵點(diǎn)擊你的工程，然后選“屬性”，找到“C/C ”，再找到“命令行”，在里面手工添加“/D "SQLITE_HAS_CODEC"”。

定義了這個(gè)宏，一些被 Sqlite 故意屏蔽掉的代碼就被使用了。這些代碼就是加解密的接口。

嘗試編譯，vc會(huì)提示你有一些函數(shù)無(wú)法鏈接，因?yàn)檎也坏剿麄兊膶?shí)現(xiàn)。

如果你也用的是VC2003，那么會(huì)得到下面的提示：

error LNK2019: 無(wú)法解析的外部符號(hào) _sqlite3CodecGetKey ，該符號(hào)在函數(shù) _attachFunc 中被引用

error LNK2019: 無(wú)法解析的外部符號(hào) _sqlite3CodecAttach ，該符號(hào)在函數(shù) _attachFunc 中被引用

error LNK2019: 無(wú)法解析的外部符號(hào) _sqlite3_activate_see，該符號(hào)在函數(shù) _sqlite3Pragma 中被引用

error LNK2019: 無(wú)法解析的外部符號(hào) _sqlite3_key ，該符號(hào)在函數(shù) _sqlite3Pragma 中被引用

fatal error LNK1120: 4 個(gè)無(wú)法解析的外部命令

這是正常的，因?yàn)镾qlite只留了接口而已，并沒(méi)有給出實(shí)現(xiàn)。

下面就讓我來(lái)實(shí)現(xiàn)這些接口。

i.2 自己實(shí)現(xiàn)加解密接口函數(shù)

如果真要我從一份 www.sqlite.org 網(wǎng)上down下來(lái)的 sqlite3.c 文件，直接摸索出這些接口的實(shí)現(xiàn)，我認(rèn)為我還沒(méi)有這個(gè)能力。

好在網(wǎng)上還有一些代碼已經(jīng)實(shí)現(xiàn)了這個(gè)功能。通過(guò)參照他們的代碼以及不斷編譯中vc給出的錯(cuò)誤提示，最終我把整個(gè)接口整理出來(lái)。

實(shí)現(xiàn)這些預(yù)留接口不是那么容易，要重頭說(shuō)一次怎么回事很困難。我把代碼都寫(xiě)好了，直接把他們按我下面的說(shuō)明拷貝到 sqlite3.c 文件對(duì)應(yīng)地方即可。我在下面也提供了sqlite3.c 文件，可以直接參考或取下來(lái)使用。

這里要說(shuō)一點(diǎn)的是，我另外新建了兩個(gè)文件：crypt.c和crypt.h。

其中crypt.h如此定義：

#ifndef DCG_SQLITE_CRYPT_FUNC_

#define DCG_SQLITE_CRYPT_FUNC_

***********/

int My_DeEncrypt_Func( unsigned char * pData, unsigned int data_len, const char * key, unsigned int len_of_key );

#endif

其中的 crypt.c 如此定義：

#include "./crypt.h"

#include "memory.h"

int My_Encrypt_Func( unsigned char * pData, unsigned int data_len, const char * key, unsigned int len_of_key )

{

return 0;

}

int My_DeEncrypt_Func( unsigned char * pData, unsigned int data_len, const char * key, unsigned int len_of_key )

{

return 0;

}

這個(gè)文件很容易看，就兩函數(shù)，一個(gè)加密一個(gè)解密。傳進(jìn)來(lái)的參數(shù)分別是待處理的數(shù)據(jù)、數(shù)據(jù)長(zhǎng)度、密鑰、密鑰長(zhǎng)度。

處理時(shí)直接把結(jié)果作用于 pData 指針指向的內(nèi)容。

你需要定義自己的加解密過(guò)程，就改動(dòng)這兩個(gè)函數(shù)，其它部分不用動(dòng)。擴(kuò)展起來(lái)很簡(jiǎn)單。

這里有個(gè)特點(diǎn)，data_len 一般總是 1024 字節(jié)。正因?yàn)槿绱耍憧梢栽谀愕乃惴ɡ锸褂靡恍┨囟ㄩL(zhǎng)度的加密算法，比如AES要求被加密數(shù)據(jù)一定是128位（16字節(jié)）長(zhǎng)。這個(gè)1024不是碰巧，而是 Sqlite 的頁(yè)定義是1024字節(jié)，在sqlite3.c文件里有定義:

# define SQLITE_DEFAULT_PAGE_SIZE 1024

你可以改動(dòng)這個(gè)值，不過(guò)還是建議沒(méi)有必要不要去改它。

上面寫(xiě)了兩個(gè)擴(kuò)展函數(shù)，如何把擴(kuò)展函數(shù)跟 Sqlite 掛接起來(lái)，這個(gè)過(guò)程說(shuō)起來(lái)比較麻煩。我直接貼代碼。

分3個(gè)步驟。

首先，在 sqlite3.c 文件頂部，添加下面內(nèi)容：

#ifdef SQLITE_HAS_CODEC

#include "./crypt.h"

void sqlite3pager_free_codecarg(void *pArg);

#endif

這個(gè)函數(shù)之所以要在 sqlite3.c 開(kāi)頭聲明，是因?yàn)橄旅嬖?sqlite3.c 里面某些函數(shù)里要插入這個(gè)函數(shù)調(diào)用。所以要提前聲明。

其次，在sqlite3.c文件里搜索“sqlite3PagerClose”函數(shù)，要找到它的實(shí)現(xiàn)代碼（而不是聲明代碼）。

實(shí)現(xiàn)代碼里一開(kāi)始是：

#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT

ThreadData *pTsd = sqlite3ThreadData();

assert( pPager );

assert( pTsd pTsd->nAlloc );

#endif

需要在這部分后面緊接著插入：

#ifdef SQLITE_HAS_CODEC

sqlite3pager_free_codecarg(pPager->pCodecArg);

#endif

這里要注意，sqlite3PagerClose 函數(shù)大概也是 3.3.17版本左右才改名的，以前版本里是叫 “sqlite3pager_close”。因此你在老版本sqlite代碼里搜索“sqlite3PagerClose”是搜不到的。

類似的還有“sqlite3pager_get”、“sqlite3pager_unref”、“sqlite3pager_write”、“sqlite3pager_pagecount”等都是老版本函數(shù)，它們?cè)?pager.h 文件里定義。新版本對(duì)應(yīng)函數(shù)是在 sqlite3.h 里定義（因?yàn)槎己喜⒌?sqlite3.c和sqlite3.h兩文件了）。所以，如果你在使用老版本的sqlite，先看看 pager.h 文件，這些函數(shù)不是消失了，也不是新蹦出來(lái)的，而是老版本函數(shù)改名得到的。

最后，往sqlite3.c 文件下找。找到最后一行：

在這一行后面，接上本文最下面的代碼段。

這些代碼很長(zhǎng)，我不再解釋，直接接上去就得了。

唯一要提的是 DeriveKey 函數(shù)。這個(gè)函數(shù)是對(duì)密鑰的擴(kuò)展。比如，你要求密鑰是128位，即是16字節(jié)，但是如果用戶只輸入 1個(gè)字節(jié)呢？2個(gè)字節(jié)呢？或輸入50個(gè)字節(jié)呢？你得對(duì)密鑰進(jìn)行擴(kuò)展，使之符合16字節(jié)的要求。

DeriveKey 函數(shù)就是做這個(gè)擴(kuò)展的。有人把接收到的密鑰求md5，這也是一個(gè)辦法，因?yàn)閙d5運(yùn)算結(jié)果固定16字節(jié)，不論你有多少字符，最后就是16字節(jié)。這是md5算法的特點(diǎn)。但是我不想用md5，因?yàn)檫€得為它添加包含一些 md5 的.c或.cpp文件。我不想這么做。我自己寫(xiě)了一個(gè)算法來(lái)擴(kuò)展密鑰，很簡(jiǎn)單的算法。當(dāng)然，你也可以使用你的擴(kuò)展方法，也而可以使用 md5 算法。只要修改 DeriveKey 函數(shù)就可以了。

在 DeriveKey 函數(shù)里，只管申請(qǐng)空間構(gòu)造所需要的密鑰，不需要釋放，因?yàn)樵诹硪粋€(gè)函數(shù)里有釋放過(guò)程，而那個(gè)函數(shù)會(huì)在數(shù)據(jù)庫(kù)關(guān)閉時(shí)被調(diào)用。參考我的 DeriveKey 函數(shù)來(lái)申請(qǐng)內(nèi)存。

這里我給出我已經(jīng)修改好的 sqlite3.c 和 sqlite3.h 文件。

如果太懶，就直接使用這兩個(gè)文件，編譯肯定能通過(guò)，運(yùn)行也正常。當(dāng)然，你必須按我前面提的，新建 crypt.h 和 crypt.c 文件，而且函數(shù)要按我前面定義的要求來(lái)做。

i.3 加密使用方法：

現(xiàn)在，你代碼已經(jīng)有了加密功能。

你要把加密功能給用上，除了改 sqlite3.c 文件、給你工程添加 SQLITE_HAS_CODEC 宏，還得修改你的數(shù)據(jù)庫(kù)調(diào)用函數(shù)。

前面提到過(guò)，要開(kāi)始一個(gè)數(shù)據(jù)庫(kù)操作，必須先 sqlite3_open 。

加解密過(guò)程就在 sqlite3_open 后面操作。

假設(shè)你已經(jīng) sqlite3_open 成功了，緊接著寫(xiě)下面的代碼：

int i;

//添加、使用密碼

i = sqlite3_key( db, "dcg", 3 );

//修改密碼

i = sqlite3_rekey( db, "dcg", 0 );

用 sqlite3_key 函數(shù)來(lái)提交密碼。

第1個(gè)參數(shù)是 sqlite3 * 類型變量，代表著用 sqlite3_open 打開(kāi)的數(shù)據(jù)庫(kù)（或新建數(shù)據(jù)庫(kù)）。

第2個(gè)參數(shù)是密鑰。

第3個(gè)參數(shù)是密鑰長(zhǎng)度。

用 sqlite3_rekey 來(lái)修改密碼。參數(shù)含義同 sqlite3_key。

實(shí)際上，你可以在sqlite3_open函數(shù)之后，到 sqlite3_close 函數(shù)之前任意位置調(diào)用 sqlite3_key 來(lái)設(shè)置密碼。

但是如果你沒(méi)有設(shè)置密碼，而數(shù)據(jù)庫(kù)之前是有密碼的，那么你做任何操作都會(huì)得到一個(gè)返回值：SQLITE_NOTADB，并且得到錯(cuò)誤提示：“file is encrypted or is not a database”。

只有當(dāng)你用 sqlite3_key 設(shè)置了正確的密碼，數(shù)據(jù)庫(kù)才會(huì)正常工作。

如果你要修改密碼，前提是你必須先 sqlite3_open 打開(kāi)數(shù)據(jù)庫(kù)成功，然后 sqlite3_key 設(shè)置密鑰成功，之后才能用 sqlite3_rekey 來(lái)修改密碼。

如果數(shù)據(jù)庫(kù)有密碼，但你沒(méi)有用 sqlite3_key 設(shè)置密碼，那么當(dāng)你嘗試用 sqlite3_rekey 來(lái)修改密碼時(shí)會(huì)得到 SQLITE_NOTADB 返回值。

如果你需要清空密碼，可以使用：

//修改密碼

i = sqlite3_rekey( db, NULL, 0 );

來(lái)完成密碼清空功能。

i.4 sqlite3.c 最后添加代碼段