SQLite3 API編程手冊

前序：
Sqlite3 的確很好用。小巧、速度快。可是由於非微軟的產品，幫助文檔總以爲不夠。這些天再次研究它，又有一些收穫，這裏把我對 sqlite3 的研究列出來，以備忘記。

這 裏要註明，我是一個跨平臺專一者，並不喜歡只用 windows 平臺。我之前的工做就是爲 unix 平臺寫代碼。下面我所寫的東西，雖然沒有驗證，可是我已儘可能不使用任何 windows 的東西，只使用標準 C 或標準C++。可是，我沒有嘗試過在別的系統、別的編譯器下編譯，所以下面的敘述若是不正確，則留待之後修改。

下 面個人代碼仍然用 VC 編寫，由於我以爲VC是一個很不錯的IDE，能夠加快代碼編寫速度（例如配合 Vassist ）。下面我所說的編譯環境，是VC2003。若是讀者以爲本身習慣於 unix 下用 vi 編寫代碼速度較快，能夠不用管個人說明，只須要符合本身習慣便可，由於我用的是標準 C 或 C++ 。不會給任何人帶來不便。

1、 版本
從 www.sqlite.org 網站可下載到最新的 sqlite 代碼和編譯版本。我寫此文章時，最新代碼是 3.3.17 版本。

很 久沒有去下載 sqlite 新代碼，所以也不知道 sqlite 變化這麼大。之前不少文件，如今所有合併成一個 sqlite3.c 文件。若是單獨用此文件，是挺好的，省去拷貝一堆文件還擔憂有沒有遺漏。可是也帶來一個問題：此文件太大，快接近7萬行代碼，VC開它整個機器都慢下來 了。若是不須要改它代碼，也就不須要打開 sqlite3.c 文件，機器不會慢。可是，下面我要寫經過修改 sqlite 代碼完成加密功能，那時候就比較痛苦了。若是我的水平較高，建議用些簡單的編輯器來編輯，例如 UltraEdit 或 Notepad 。速度會快不少。

2、 基本編譯
這個不想多說了，在 VC 裏新建 dos 控制檯空白工程，把 sqlite3.c 和 sqlite3.h 添加到工程，再新建一個 main.cpp 文件。在裏面寫:

extern "C"
{
#include "./sqlite3.h"
};
int main( int , char** )
{
return 0;
}

爲 什麼要 extern 「C」 ？若是問這個問題，我不想說太多，這是C++的基礎。要在 C++ 裏使用一段 C 的代碼，必需要用 extern 「C」 括起來。C++跟 C雖然語法上有重疊，可是它們是兩個不一樣的東西，內存裏的佈局是徹底不一樣的，在C++編譯器裏不用extern 「C」括起C代碼，會致使編譯器不知道該如何爲 C 代碼描述內存佈局。

可能在 sqlite3.c 里人家已經把整段代碼都 extern 「C」 括起來了，可是你遇到一個 .c 文件就自覺的再括一次，也沒什麼很差。

基本工程就這樣創建起來了。編譯，能夠經過。可是有一堆的 warning。能夠無論它。

3、 SQLITE操做入門
sqlite提供的是一些C函數接口，你能夠用這些函數操做數據庫。經過使用這些接口，傳遞一些標準 sql 語句（以 char * 類型）給 sqlite 函數，sqlite 就會爲你操做數據庫。

sqlite 跟MS的access同樣是文件型數據庫，就是說，一個數據庫就是一個文件，此數據庫裏能夠創建不少的表，能夠創建索引、觸發器等等，可是，它實際上獲得的就是一個文件。備份這個文件就備份了整個數據庫。

sqlite 不須要任何數據庫引擎，這意味着若是你須要 sqlite 來保存一些用戶數據，甚至都不須要安裝數據庫(若是你作個小軟件還要求人家必須裝了sqlserver 才能運行，那也太黑心了)。

下面開始介紹數據庫基本操做。

（1） 基本流程
i.1 關鍵數據結構

sqlite 裏最經常使用到的是 sqlite3 * 類型。從數據庫打開開始，sqlite就要爲這個類型準備好內存，直到數據庫關閉，整個過程都須要用到這個類型。當數據庫打開時開始，這個類型的變量就表明了你要操做的數據庫。下面再詳細介紹。

i.2 打開數據庫

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

用這個函數開始數據庫操做。

須要傳入兩個參數，一是數據庫文件名，好比：c://DongChunGuang_Database.db。

文件名不須要必定存在，若是此文件不存在，sqlite 會自動創建它。若是它存在，就嘗試把它當數據庫文件來打開。

sqlite3 ** 參數即前面提到的關鍵數據結構。這個結構底層細節如何，你不要關它。

函 數返回值表示操做是否正確，若是是 SQLITE_OK 則表示操做正常。相關的返回值sqlite定義了一些宏。具體這些宏的含義能夠參考 sqlite3.h 文件。裏面有詳細定義（順便說一下，sqlite3 的代碼註釋率自稱是很是高的，實際上也的確很高。只要你會看英文，sqlite 可讓你學到很多東西）。

下面介紹關閉數據庫後，再給一段參考代碼。

i.3 關閉數據庫

int sqlite3_close(sqlite3 *);

前面若是用 sqlite3_open 開啓了一個數據庫，結尾時不要忘了用這個函數關閉數據庫。

下面給段簡單的代碼：

extern "C"
{
#include "./sqlite3.h"
};
int main( int , char** )
{
sqlite3 * db = NULL; //聲明sqlite關鍵結構指針
int result;
//打開數據庫
//須要傳入 db 這個指針的指針，由於 sqlite3_open 函數要爲這個指針分配內存，還要讓db指針指向這個內存區
result = sqlite3_open( 「c://Dcg_database.db」, &db );
if( result != SQLITE_OK )
{
//數據庫打開失敗
return -1;
}
//數據庫操做代碼
//…
//數據庫打開成功
//關閉數據庫
sqlite3_close( db );
return 0;
}

這就是一次數據庫操做過程。

（2） SQL語句操做
本節介紹如何用sqlite 執行標準 sql 語法。

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

這就是執行一條 sql 語句的函數。

第1個參數再也不說了，是前面open函數獲得的指針。說了是關鍵數據結構。

第2個參數const char *sql 是一條 sql 語句，以/0結尾。

第3個參數sqlite3_callback 是回調，當這條語句執行以後，sqlite3會去調用你提供的這個函數。（什麼是回調函數，本身找別的資料學習）

第4個參數void * 是你所提供的指針，你能夠傳遞任何一個指針參數到這裏，這個參數最終會傳到回調函數裏面，若是不須要傳遞指針給回調函數，能夠填NULL。等下咱們再看回調函數的寫法，以及這個參數的使用。

第 5個參數char ** errmsg 是錯誤信息。注意是指針的指針。sqlite3裏面有不少固定的錯誤信息。執行 sqlite3_exec 以後，執行失敗時能夠查閱這個指針（直接 printf(「%s/n」,errmsg)）獲得一串字符串信息，這串信息告訴你錯在什麼地方。sqlite3_exec函數經過修改你傳入的指針的指 針，把你提供的指針指向錯誤提示信息，這樣sqlite3_exec函數外面就能夠經過這個 char*獲得具體錯誤提示。

說 明：一般，sqlite3_callback 和它後面的 void * 這兩個位置均可以填 NULL。填NULL表示你不須要回調。好比你作 insert 操做，作 delete 操做，就沒有必要使用回調。而當你作 select 時，就要使用回調，由於 sqlite3 把數據查出來，得經過回調告訴你查出了什麼數據。

i.2 exec 的回調

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

你的回調函數必須定義成上面這個函數的類型。下面給個簡單的例子：

//sqlite3的回調函數
// sqlite 每查到一條記錄，就調用一次這個回調
int LoadMyInfo( void * para, int n_column, char ** column_value, char ** column_name )
{
//para是你在 sqlite3_exec 裏傳入的 void * 參數
//經過para參數，你能夠傳入一些特殊的指針（好比類指針、結構指針），而後在這裏面強制轉換成對應的類型（這裏面是void*類型，必須強制轉換成你的類型纔可用）。而後操做這些數據
//n_column是這一條記錄有多少個字段 (即這條記錄有多少列)
// char ** column_value 是個關鍵值，查出來的數據都保存在這裏，它其實是個1維數組（不要覺得是2維數組），每個元素都是一個 char * 值，是一個字段內容（用字符串來表示，以/0結尾）
//char ** column_name 跟 column_value是對應的，表示這個字段的字段名稱
//這裏，我不使用 para 參數。忽略它的存在.
int i;
printf( 「記錄包含 %d 個字段/n」, n_column );
for( i = 0 ; i < n_column; i ++ )
{
printf( 「字段名:%s ß> 字段值:%s/n」, column_name[i], column_value[i] );
}
printf( 「------------------/n「 );
return 0;
}
int main( int , char ** )
{
sqlite3 * db;
int result;
char * errmsg = NULL;
result = sqlite3_open( 「c://Dcg_database.db」, &db );
if( result != SQLITE_OK )
{
//數據庫打開失敗
return -1;
}

//數據庫操做代碼
//建立一個測試表，表名叫 MyTable_1，有2個字段： ID 和 name。其中ID是一個自動增長的類型，之後insert時能夠不去指定這個字段，它會本身從0開始增長
result = sqlite3_exec( db, 「create table MyTable_1( ID integer primary key autoincrement, name nvarchar(32) )」, NULL, NULL, errmsg );
if(result != SQLITE_OK )
{
printf( 「建立表失敗，錯誤碼:%d，錯誤緣由:%s/n」, result, errmsg );
}

//插入一些記錄
result = sqlite3_exec( db, 「insert into MyTable_1( name ) values ( ‘走路’ )」, 0, 0, errmsg );
if(result != SQLITE_OK )
{
printf( 「插入記錄失敗，錯誤碼:%d，錯誤緣由:%s/n」, result, errmsg );
}
result = sqlite3_exec( db, 「insert into MyTable_1( name ) values ( ‘騎單車’ )」, 0, 0, errmsg );
if(result != SQLITE_OK )
{
printf( 「插入記錄失敗，錯誤碼:%d，錯誤緣由:%s/n」, result, errmsg );
}
result = sqlite3_exec( db, 「insert into MyTable_1( name ) values ( ‘坐汽車’ )」, 0, 0, errmsg );
if(result != SQLITE_OK )
{
printf( 「插入記錄失敗，錯誤碼:%d，錯誤緣由:%s/n」, result, errmsg );
}

//開始查詢數據庫
result = sqlite3_exec( db, 「select * from MyTable_1」, LoadMyInfo, NULL, errmsg );

//關閉數據庫
sqlite3_close( db );
return 0;
}

經過上面的例子，應該能夠知道如何打開一個數據庫，如何作數據庫基本操做。

有這些知識，基本上能夠應付不少數據庫操做了。

i.3 不使用回調查詢數據庫

上 面介紹的 sqlite3_exec 是使用回調來執行 select 操做。還有一個方法能夠直接查詢而不須要回調。可是，我我的感受仍是回調好，由於代碼能夠更加整齊，只不過用回調很麻煩，你得聲明一個函數，若是這個函數 是類成員函數，你還不得不把它聲明成 static 的（要問爲何？這又是C++基礎了。C++成員函數實際上隱藏了一個參數：this，C++調用類的成員函數的時候，隱含把類指針當成函數的第一個參數 傳遞進去。結果，這形成跟前面說的 sqlite 回調函數的參數不相符。只有當把成員函數聲明成 static 時，它纔沒有多餘的隱含的this參數）。

雖然回調顯得代碼整齊，但有時候你仍是想要非回調的 select 查詢。這能夠經過 sqlite3_get_table 函數作到。

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

第1個參數再也不多說，看前面的例子。
第2個參數是 sql 語句，跟 sqlite3_exec 裏的 sql 是同樣的。是一個很普通的以/0結尾的char *字符串。
第3個參數是查詢結果，它依然一維數組（不要覺得是二維數組，更不要覺得是三維數組）。它內存佈局是：第一行是字段名稱，後面是緊接着是每一個字段的值。下面用例子來講事。
第4個參數是查詢出多少條記錄（即查出多少行）。
第5個參數是多少個字段（多少列）。
第6個參數是錯誤信息，跟前面同樣，這裏很少說了。

下面給個簡單例子:

int main( int , char ** )
{
sqlite3 * db;
int result;
char * errmsg = NULL;
char **dbResult; //是 char ** 類型，兩個*號
int nRow, nColumn;
int i , j;
int index;
result = sqlite3_open( 「c://Dcg_database.db」, &db );
if( result != SQLITE_OK )
{

//數據庫打開失敗
return -1;
}

//數據庫操做代碼
//假設前面已經建立了 MyTable_1 表
//開始查詢，傳入的 dbResult 已是 char **，這裏又加了一個 & 取地址符，傳遞進去的就成了 char ***
result = sqlite3_get_table( db, 「select * from MyTable_1」, &dbResult, &nRow, &nColumn, &errmsg );
if( SQLITE_OK == result )
{
//查詢成功

index = nColumn; //前面說過 dbResult 前面第一行數據是字段名稱，從 nColumn 索引開始纔是真正的數據
printf( 「查到%d條記錄/n」, nRow );
for( i = 0; i < nRow ; i++ )
{
printf( 「第 %d 條記錄/n」, i+1 );
for( j = 0 ; j < nColumn; j++ )
{
printf( 「字段名:%s ß> 字段值:%s/n」, dbResult[j], dbResult [index] );
++index; // dbResult 的字段值是連續的，從第0索引到第 nColumn - 1索引都是字段名稱，從第 nColumn 索引開始，後面都是字段值，它把一個二維的表（傳統的行列表示法）用一個扁平的形式來表示
}
printf( 「-------/n」 );
}
}
//到這裏，不論數據庫查詢是否成功，都釋放 char** 查詢結果，使用 sqlite 提供的功能來釋放
sqlite3_free_table( dbResult );

//關閉數據庫
sqlite3_close( db );
return 0;
}

到這個例子爲止，sqlite3 的經常使用用法都介紹完了。

用以上的方法，再配上 sql 語句，徹底能夠應付絕大多數數據庫需求。

但有一種狀況，用上面方法是沒法實現的：須要insert、select 二進制。當須要處理二進制數據時，上面的方法就沒辦法作到。下面這一節說明如何插入二進制數據

（2） 操做二進制
sqlite 操做二進制數據須要用一個輔助的數據類型：sqlite3_stmt * 。

這 個數據類型記錄了一個「sql語句」。爲何我把 「sql語句」 用雙引號引發來？由於你能夠把 sqlite3_stmt * 所表示的內容當作是 sql語句，可是實際上它不是咱們所熟知的sql語句。它是一個已經把sql語句解析了的、用sqlite本身標記記錄的內部數據結構。

正由於這個結構已經被解析了，因此你能夠往這個語句裏插入二進制數據。固然，把二進制數據插到 sqlite3_stmt 結構裏可不能直接 memcpy ，也不能像 std::string 那樣用 + 號。必須用 sqlite 提供的函數來插入。

 

i.1 寫入二進制

下面說寫二進制的步驟。

要插入二進制，前提是這個表的字段的類型是 blob 類型。我假設有這麼一張表：

create table Tbl_2( ID integer, file_content blob )

首先聲明

sqlite3_stmt * stat;

而後，把一個 sql 語句解析到 stat 結構裏去：

sqlite3_prepare( db, 「insert into Tbl_2( ID, file_content) values( 10, ? )」, -1, &stat, 0 );

上面的函數完成 sql 語句的解析。第一個參數跟前面同樣，是個 sqlite3 * 類型變量，第二個參數是一個 sql 語句。

這個 sql 語句特別之處在於 values 裏面有個 ? 號。在sqlite3_prepare函數裏，?號表示一個未定的值，它的值等下才插入。

第三個參數我寫的是-1，這個參數含義是前面 sql 語句的長度。若是小於0，sqlite會自動計算它的長度（把sql語句當成以/0結尾的字符串）。
第四個參數是 sqlite3_stmt 的指針的指針。解析之後的sql語句就放在這個結構裏。
第五個參數我也不知道是幹什麼的。爲0就能夠了。

若是這個函數執行成功（返回值是 SQLITE_OK 且 stat 不爲NULL ），那麼下面就能夠開始插入二進制數據。

sqlite3_bind_blob( stat, 1, pdata, (int)(length_of_data_in_bytes), NULL ); // pdata爲數據緩衝區，length_of_data_in_bytes爲數據大小，以字節爲單位

這個函數一共有5個參數。

第1個參數：是前面prepare獲得的 sqlite3_stmt * 類型變量。
第 2個參數：?號的索引。前面prepare的sql語句裏有一個?號，假若有多個?號怎麼插入？方法就是改變 bind_blob 函數第2個參數。這個參數我寫1，表示這裏插入的值要替換 stat 的第一個?號（這裏的索引從1開始計數，而非從0開始）。若是你有多個?號，就寫多個 bind_blob 語句，並改變它們的第2個參數就替換到不一樣的?號。若是有?號沒有替換，sqlite爲它取值null。
第3個參數：二進制數據起始指針。
第4個參數：二進制數據的長度，以字節爲單位。
第5個參數：是個析夠回調函數，告訴sqlite當把數據處理完後調用此函數來析夠你的數據。這個參數我尚未使用過，所以理解也不深入。可是通常都填NULL，須要釋放的內存本身用代碼來釋放。

bind完了以後，二進制數據就進入了你的「sql語句」裏了。你如今能夠把它保存到數據庫裏：

int result = sqlite3_step( stat );

經過這個語句，stat 表示的sql語句就被寫到了數據庫裏。

最後，要把 sqlite3_stmt 結構給釋放：

sqlite3_finalize( stat ); //把剛纔分配的內容析構掉

 

i.2 讀出二進制

下面說讀二進制的步驟。

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

sqlite3_stmt * stat;

而後，把一個 sql 語句解析到 stat 結構裏去：

sqlite3_prepare( db, 「select * from Tbl_2」, -1, &stat, 0 );

當 prepare 成功以後（返回值是 SQLITE_OK ），開始查詢數據。

int result = sqlite3_step( stat );

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

你能夠循環執行 sqlite3_step 函數，一次 step 查詢出一條記錄。直到返回值不爲 SQLITE_ROW 時表示查詢結束。

而後開始獲取第一個字段：ID 的值。ID是個整數，用下面這個語句獲取它的值：

int id = sqlite3_column_int( stat, 0 ); //第2個參數表示獲取第幾個字段內容，從0開始計算，由於個人表的ID字段是第一個字段，所以這裏我填0

下面開始獲取 file_content 的值，由於 file_content 是二進制，所以我須要獲得它的指針，還有它的長度：

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

int len = sqlite3_column_bytes( stat, 1 );

這樣就獲得了二進制的值。

把 pFileContent 的內容保存出來以後，不要忘了釋放 sqlite3_stmt 結構：

sqlite3_finalize( stat ); //把剛纔分配的內容析構掉

i.3 重複使用 sqlite3_stmt 結構

若是你須要重複使用 sqlite3_prepare 解析好的 sqlite3_stmt 結構，須要用函數： sqlite3_reset。

result = sqlite3_reset(stat);

這樣， stat 結構又成爲 sqlite3_prepare 完成時的狀態，你能夠從新爲它 bind 內容。

（4） 事務處理

sqlite 是支持事務處理的。若是你知道你要同步刪除不少數據，不仿把它們作成一個統一的事務。

一般一次 sqlite3_exec 就是一次事務，若是你要刪除1萬條數據，sqlite就作了1萬次：開始新事務->刪除一條數據->提交事務->開始新事務->… 的過程。這個操做是很慢的。由於時間都花在了開始事務、提交事務上。

你能夠把這些同類操做作成一個事務，這樣若是操做錯誤，還可以回滾事務。

事務的操做沒有特別的接口函數，它就是一個普通的 sql 語句而已：

分別以下：

int result;

result = sqlite3_exec( db, "begin transaction", 0, 0, &zErrorMsg ); //開始一個事務

result = sqlite3_exec( db, "commit transaction", 0, 0, &zErrorMsg ); //提交事務

result = sqlite3_exec( db, "rollback transaction", 0, 0, &zErrorMsg ); //回滾事務

1、 給數據庫加密

前面所說的內容網上已經有不少資料，雖然比較零散，可是花點時間也仍是能夠找到的。如今要說的這個——數據庫加密，資料就很難找。也多是我操做水平不夠，找不到對應資料。但無論這樣，我仍是經過網上能找到的頗有限的資料，探索出了給sqlite數據庫加密的完整步驟。

這 裏要提一下，雖然 sqlite 很好用，速度快、體積小巧。可是它保存的文件倒是明文的。若不信能夠用 NotePad 打開數據庫文件瞧瞧，裏面 insert 的內容幾乎盡收眼底。這樣赤裸裸的展示本身，可不是咱們的初衷。固然，若是你在嵌入式系統、智能手機上使用 sqlite，最好是不加密，由於這些系統運算能力有限，你作爲一個新功能提供者，不能把用戶有限的運算能力所有花掉。

Sqlite 爲了速度而誕生。所以Sqlite自己不對數據庫加密，要知道，若是你選擇標準AES算法加密，那麼必定有接近50%的時間消耗在加解密算法上，甚至更多 （性能主要取決於你算法編寫水平以及你是否能使用cpu提供的底層運算能力，好比MMX或sse系列指令能夠大幅度提高運算速度）。

Sqlite 免費版本是不提供加密功能的，固然你也能夠選擇他們的收費版本，那你得支付2000塊錢，並且是USD。我這裏也不是說支付錢很差，若是隻爲了數據庫加密 就去支付2000塊，我以爲划不來。由於下面我將要告訴你如何爲免費的Sqlite擴展出加密模塊——本身動手擴展，這是Sqlite容許，也是它提倡 的。

那麼，就讓咱們一塊兒開始爲 sqlite3.c 文件擴展出加密模塊。

i.1 必要的宏

經過閱讀 Sqlite 代碼（固然沒有所有閱讀完，6萬多行代碼，沒有一行是我習慣的風格，我可沒那麼多眼神去看），我搞清楚了兩件事：

Sqlite是支持加密擴展的；

須要 #define 一個宏才能使用加密擴展。

這個宏就是

SQLITE_HAS_CODEC。

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

#ifndef SQLITE_HAS_CODEC

#define SQLITE_HAS_CODEC

#endif

如 果你在代碼裏定義了此宏，可是還可以正常編譯，那麼應該是操做沒有成功。由於你應該會被編譯器提示有一些函數沒法連接纔對。若是你用的是 VC 2003，你能夠在「解決方案」裏右鍵點擊你的工程，而後選「屬性」，找到「C/C 」，再找到「命令行」，在裏面手工添加「/D "SQLITE_HAS_CODEC"」。

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

嘗試編譯，vc會提示你有一些函數沒法連接，由於找不到他們的實現。

若是你也用的是VC2003，那麼會獲得下面的提示：

error LNK2019: 沒法解析的外部符號 _sqlite3CodecGetKey ，該符號在函數 _attachFunc 中被引用

error LNK2019: 沒法解析的外部符號 _sqlite3CodecAttach ，該符號在函數 _attachFunc 中被引用

error LNK2019: 沒法解析的外部符號 _sqlite3_activate_see，該符號在函數 _sqlite3Pragma 中被引用

error LNK2019: 沒法解析的外部符號 _sqlite3_key ，該符號在函數 _sqlite3Pragma 中被引用

fatal error LNK1120: 4 個沒法解析的外部命令

這是正常的，由於Sqlite只留了接口而已，並無給出實現。

下面就讓我來實現這些接口。

i.2 本身實現加解密接口函數

若是真要我從一份 www.sqlite.org 網上down下來的 sqlite3.c 文件，直接摸索出這些接口的實現，我認爲我尚未這個能力。

好在網上還有一些代碼已經實現了這個功能。經過參照他們的代碼以及不斷編譯中vc給出的錯誤提示，最終我把整個接口整理出來。

實現這些預留接口不是那麼容易，要重頭說一次怎麼回事很困難。我把代碼都寫好了，直接把他們按我下面的說明拷貝到 sqlite3.c 文件對應地方便可。我在下面也提供了sqlite3.c 文件，能夠直接參考或取下來使用。

這裏要說一點的是，我另外新建了兩個文件：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;

}

這個文件很容易看，就兩函數，一個加密一個解密。傳進來的參數分別是待處理的數據、數據長度、密鑰、密鑰長度。

處理時直接把結果做用於 pData 指針指向的內容。

你須要定義本身的加解密過程，就改動這兩個函數，其它部分不用動。擴展起來很簡單。

這 裏有個特色，data_len 通常老是 1024 字節。正由於如此，你能夠在你的算法裏使用一些特定長度的加密算法，好比AES要求被加密數據必定是128位（16字節）長。這個1024不是碰巧，而是 Sqlite 的頁定義是1024字節，在sqlite3.c文件裏有定義:

# define SQLITE_DEFAULT_PAGE_SIZE 1024

你能夠改動這個值，不過仍是建議沒有必要不要去改它。

上面寫了兩個擴展函數，如何把擴展函數跟 Sqlite 掛接起來，這個過程提及來比較麻煩。我直接貼代碼。

分3個步驟。

首先，在 sqlite3.c 文件頂部，添加下面內容：

#ifdef SQLITE_HAS_CODEC

#include "./crypt.h"

void sqlite3pager_free_codecarg(void *pArg);

#endif

這個函數之因此要在 sqlite3.c 開頭聲明，是由於下面在 sqlite3.c 裏面某些函數裏要插入這個函數調用。因此要提早聲明。

其次，在sqlite3.c文件裏搜索「sqlite3PagerClose」函數，要找到它的實現代碼（而不是聲明代碼）。

實現代碼裏一開始是：

#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 函數大概也是 3.3.17版本左右才更名的，之前版本里是叫 「sqlite3pager_close」。所以你在老版本sqlite代碼裏搜索「sqlite3PagerClose」是搜不到的。

類 似的還有「sqlite3pager_get」、「sqlite3pager_unref」、「sqlite3pager_write」、 「sqlite3pager_pagecount」等都是老版本函數，它們在 pager.h 文件裏定義。新版本對應函數是在 sqlite3.h 裏定義（由於都合併到 sqlite3.c和sqlite3.h兩文件了）。因此，若是你在使用老版本的sqlite，先看看 pager.h 文件，這些函數不是消失了，也不是新蹦出來的，而是老版本函數更名獲得的。

 

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

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

這些代碼很長，我再也不解釋，直接接上去就得了。

惟一要提的是 DeriveKey 函數。這個函數是對密鑰的擴展。好比，你要求密鑰是128位，便是16字節，可是若是用戶只輸入 1個字節呢？2個字節呢？或輸入50個字節呢？你得對密鑰進行擴展，使之符合16字節的要求。

DeriveKey 函數就是作這個擴展的。有人把接收到的密鑰求md5，這也是一個辦法，由於md5運算結果固定16字節，不論你有多少字符，最後就是16字節。這是md5 算法的特色。可是我不想用md5，由於還得爲它添加包含一些 md5 的.c或.cpp文件。我不想這麼作。我本身寫了一個算法來擴展密鑰，很簡單的算法。固然，你也可使用你的擴展方法，也而可使用 md5 算法。只要修改 DeriveKey 函數就能夠了。

在 DeriveKey 函數裏，只管申請空間構造所須要的密鑰，不須要釋放，由於在另外一個函數裏有釋放過程，而那個函數會在數據庫關閉時被調用。參考個人 DeriveKey 函數來申請內存。

這裏我給出我已經修改好的 sqlite3.c 和 sqlite3.h 文件。

若是太懶，就直接使用這兩個文件，編譯確定能經過，運行也正常。固然，你必須按我前面提的，新建 crypt.h 和 crypt.c 文件，並且函數要按我前面定義的要求來作。

i.3 加密使用方法：

如今，你代碼已經有了加密功能。

你要把加密功能給用上，除了改 sqlite3.c 文件、給你工程添加 SQLITE_HAS_CODEC 宏，還得修改你的數據庫調用函數。

前面提到過，要開始一個數據庫操做，必須先 sqlite3_open 。

加解密過程就在 sqlite3_open 後面操做。

假設你已經 sqlite3_open 成功了，緊接着寫下面的代碼：

int i;

//添加、使用密碼

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

//修改密碼

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

用 sqlite3_key 函數來提交密碼。

第1個參數是 sqlite3 * 類型變量，表明着用 sqlite3_open 打開的數據庫（或新建數據庫）。

第2個參數是密鑰。

第3個參數是密鑰長度。

用 sqlite3_rekey 來修改密碼。參數含義同 sqlite3_key。

實際上，你能夠在sqlite3_open函數以後，到 sqlite3_close 函數以前任意位置調用 sqlite3_key 來設置密碼。

可是若是你沒有設置密碼，而數據庫以前是有密碼的，那麼你作任何操做都會獲得一個返回值：SQLITE_NOTADB，而且獲得錯誤提示：「file is encrypted or is not a database」。

只有當你用 sqlite3_key 設置了正確的密碼，數據庫纔會正常工做。

若是你要修改密碼，前提是你必須先 sqlite3_open 打開數據庫成功，而後 sqlite3_key 設置密鑰成功，以後才能用 sqlite3_rekey 來修改密碼。

若是數據庫有密碼，但你沒有用 sqlite3_key 設置密碼，那麼當你嘗試用 sqlite3_rekey 來修改密碼時會獲得 SQLITE_NOTADB 返回值。

若是你須要清空密碼，可使用：

//修改密碼

i = sqlite3_rekey( db, NULL, 0 );

來完成密碼清空功能。

 

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

 

#ifdef SQLITE_HAS_CODEC

#define CRYPT_OFFSET 8

typedef struct _CryptBlock

{

BYTE* ReadKey; // 讀數據庫和寫入事務的密鑰

BYTE* WriteKey; // 寫入數據庫的密鑰

int PageSize; // 頁的大小

BYTE* Data;

} CryptBlock, *LPCryptBlock;

#ifndef DB_KEY_LENGTH_BYTE

#define DB_KEY_LENGTH_BYTE 16

#endif

#ifndef DB_KEY_PADDING

#define DB_KEY_PADDING 0x33

#endif

void sqlite3CodecGetKey(sqlite3* db, int nDB, void** Key, int* nKey)

{

return ;

}

int sqlite3CodecAttach(sqlite3 *db, int nDb, const void *pKey, int nKeyLen);

void sqlite3_activate_see(const char* right )

{

return;

}

int sqlite3_key(sqlite3 *db, const void *pKey, int nKey);

int sqlite3_rekey(sqlite3 *db, const void *pKey, int nKey);

 

// 從用戶提供的緩衝區中獲得一個加密密鑰

// 用戶提供的密鑰可能位數上知足不了要求，使用這個函數來完成密鑰擴展

static unsigned char * DeriveKey(const void *pKey, int nKeyLen);

//建立或更新一個頁的加密算法索引.此函數會申請緩衝區.

static LPCryptBlock CreateCryptBlock(unsigned char* hKey, Pager *pager, LPCryptBlock pExisting);

//加密/解密函數, 被pager調用

void * sqlite3Codec(void *pArg, unsigned char *data, Pgno nPageNum, int nMode);

//設置密碼函數

int __stdcall sqlite3_key_interop(sqlite3 *db, const void *pKey, int nKeySize);

// 修改密碼函數

int __stdcall sqlite3_rekey_interop(sqlite3 *db, const void *pKey, int nKeySize);

//銷燬一個加密塊及相關的緩衝區,密鑰.

static void DestroyCryptBlock(LPCryptBlock pBlock);

static void * sqlite3pager_get_codecarg(Pager *pPager);

void sqlite3pager_set_codec(Pager *pPager,void *(*xCodec)(void*,void*,Pgno,int),void *pCodecArg );

 

//加密/解密函數, 被pager調用

void * sqlite3Codec(void *pArg, unsigned char *data, Pgno nPageNum, int nMode)

{

LPCryptBlock pBlock = (LPCryptBlock)pArg;

unsigned int dwPageSize = 0;

if (!pBlock) return data;

// 確保pager的頁長度和加密塊的頁長度相等.若是改變,就須要調整.

if (nMode != 2)

{

PgHdr *pageHeader;

pageHeader = DATA_TO_PGHDR(data);

if (pageHeader->pPager->pageSize != pBlock->PageSize)

{

CreateCryptBlock(0, pageHeader->pPager, pBlock);

}

}

 

switch(nMode)

{

case 0: // Undo a "case 7" journal file encryption

case 2: //重載一個頁

case 3: //載入一個頁

if (!pBlock->ReadKey) break;

 

dwPageSize = pBlock->PageSize;

My_DeEncrypt_Func(data, dwPageSize, pBlock->ReadKey, DB_KEY_LENGTH_BYTE );

 

break;

case 6: //加密一個主數據庫文件的頁

if (!pBlock->WriteKey) break;

memcpy(pBlock->Data CRYPT_OFFSET, data, pBlock->PageSize);

data = pBlock->Data CRYPT_OFFSET;

 

dwPageSize = pBlock->PageSize;

My_Encrypt_Func(data , dwPageSize, pBlock->WriteKey, DB_KEY_LENGTH_BYTE );

break;

case 7: //加密事務文件的頁

if (!pBlock->ReadKey) break;

memcpy(pBlock->Data CRYPT_OFFSET, data, pBlock->PageSize);

data = pBlock->Data CRYPT_OFFSET;

dwPageSize = pBlock->PageSize;

My_Encrypt_Func( data, dwPageSize, pBlock->ReadKey, DB_KEY_LENGTH_BYTE );

break;

}

return data;

}

 

//

銷燬一個加密塊及相關的緩衝區,密鑰.

static void DestroyCryptBlock(LPCryptBlock pBlock)

{

//銷燬讀密鑰.

if (pBlock->ReadKey){

sqliteFree(pBlock->ReadKey);

}

//若是寫密鑰存在而且不等於讀密鑰,也銷燬.

if (pBlock->WriteKey && pBlock->WriteKey != pBlock->ReadKey){

sqliteFree(pBlock->WriteKey);

}

if(pBlock->Data){

sqliteFree(pBlock->Data);

}

//釋放加密塊.

sqliteFree(pBlock);

}

static void * sqlite3pager_get_codecarg(Pager *pPager)

{

return (pPager->xCodec) ? pPager->pCodecArg: NULL;

}

// 從用戶提供的緩衝區中獲得一個加密密鑰

static unsigned char * DeriveKey(const void *pKey, int nKeyLen)

{

unsigned char * hKey = NULL;

int j;

if( pKey == NULL || nKeyLen == 0 )

{

return NULL;

}

hKey = sqliteMalloc( DB_KEY_LENGTH_BYTE 1 );

if( hKey == NULL )

{

return NULL;

}

hKey[ DB_KEY_LENGTH_BYTE ] = 0;

if( nKeyLen < DB_KEY_LENGTH_BYTE )

{

memcpy( hKey, pKey, nKeyLen ); //先拷貝獲得密鑰前面的部分

j = DB_KEY_LENGTH_BYTE - nKeyLen;

//補充密鑰後面的部分

memset( hKey nKeyLen, DB_KEY_PADDING, j );

}

else

{ //密鑰位數已經足夠,直接把密鑰取過來

memcpy( hKey, pKey, DB_KEY_LENGTH_BYTE );

}

return hKey;

}

 

//建立或更新一個頁的加密算法索引.此函數會申請緩衝區.

static LPCryptBlock CreateCryptBlock(unsigned char* hKey, Pager *pager, LPCryptBlock pExisting)

{

LPCryptBlock pBlock;

 

if (!pExisting) //建立新加密塊

{

pBlock = sqliteMalloc(sizeof(CryptBlock));

memset(pBlock, 0, sizeof(CryptBlock));

pBlock->ReadKey = hKey;

pBlock->WriteKey = hKey;

pBlock->PageSize = pager->pageSize;

pBlock->Data = (unsigned char*)sqliteMalloc(pBlock->PageSize CRYPT_OFFSET);

}

else //更新存在的加密塊

{

pBlock = pExisting;

if ( pBlock->PageSize != pager->pageSize && !pBlock->Data){

sqliteFree(pBlock->Data);

pBlock->PageSize = pager->pageSize;

pBlock->Data = (unsigned char*)sqliteMalloc(pBlock->PageSize CRYPT_OFFSET);

}

}

 

memset(pBlock->Data, 0, pBlock->PageSize CRYPT_OFFSET);

return pBlock;

}

 

void sqlite3pager_set_codec(

Pager *pPager,

void *(*xCodec)(void*,void*,Pgno,int),

void *pCodecArg

)

{

pPager->xCodec = xCodec;

pPager->pCodecArg = pCodecArg;

}

int sqlite3_key(sqlite3 *db, const void *pKey, int nKey)

{

return sqlite3_key_interop(db, pKey, nKey);

}

int sqlite3_rekey(sqlite3 *db, const void *pKey, int nKey)

{

return sqlite3_rekey_interop(db, pKey, nKey);

}

int sqlite3CodecAttach(sqlite3 *db, int nDb, const void *pKey, int nKeyLen)

{

int rc = SQLITE_ERROR;

unsigned char* hKey = 0;

//若是沒有指定密匙,可能標識用了主數據庫的加密或沒加密.

if (!pKey || !nKeyLen)

{

if (!nDb)

{

return SQLITE_OK; //主數據庫, 沒有指定密鑰因此沒有加密.

}

else //附加數據庫,使用主數據庫的密鑰.

{

//獲取主數據庫的加密塊並複製密鑰給附加數據庫使用

LPCryptBlock pBlock = (LPCryptBlock)sqlite3pager_get_codecarg(sqlite3BtreePager(db->aDb[0].pBt));

if (!pBlock) return SQLITE_OK; //主數據庫沒有加密

if (!pBlock->ReadKey) return SQLITE_OK; //沒有加密

memcpy(pBlock->ReadKey, &hKey, 16);

}

}

else //用戶提供了密碼,從中建立密鑰.

{

hKey = DeriveKey(pKey, nKeyLen);

}

//建立一個新的加密塊,並將解碼器指向新的附加數據庫.

if (hKey)

{

LPCryptBlock pBlock = CreateCryptBlock(hKey, sqlite3BtreePager(db->aDb[nDb].pBt), NULL);

sqlite3pager_set_codec(sqlite3BtreePager(db->aDb[nDb].pBt), sqlite3Codec, pBlock);

rc = SQLITE_OK;

}

return rc;

}

// Changes the encryption key for an existing database.

int __stdcall sqlite3_rekey_interop(sqlite3 *db, const void *pKey, int nKeySize)

{

Btree *pbt = db->aDb[0].pBt;

Pager *p = sqlite3BtreePager(pbt);

LPCryptBlock pBlock = (LPCryptBlock)sqlite3pager_get_codecarg(p);

unsigned char * hKey = DeriveKey(pKey, nKeySize);

int rc = SQLITE_ERROR;

if (!pBlock && !hKey) return SQLITE_OK;

//從新加密一個數據庫,改變pager的寫密鑰, 讀密鑰依舊保留.

if (!pBlock) //加密一個未加密的數據庫

{

pBlock = CreateCryptBlock(hKey, p, NULL);

pBlock->ReadKey = 0; // 原始數據庫未加密

sqlite3pager_set_codec(sqlite3BtreePager(pbt), sqlite3Codec, pBlock);

}

else // 改變已加密數據庫的寫密鑰

{

pBlock->WriteKey = hKey;

}

// 開始一個事務

rc = sqlite3BtreeBeginTrans(pbt, 1);

if (!rc)

{

// 用新密鑰重寫全部的頁到數據庫。

Pgno nPage = sqlite3PagerPagecount(p);

Pgno nSkip = PAGER_MJ_PGNO(p);

void *pPage;

Pgno n;

for(n = 1; rc == SQLITE_OK && n <= nPage; n )

{

if (n == nSkip) continue;

rc = sqlite3PagerGet(p, n, &pPage);

if(!rc)

{

rc = sqlite3PagerWrite(pPage);

sqlite3PagerUnref(pPage);

}

}

}

// 若是成功，提交事務。

if (!rc)

{

rc = sqlite3BtreeCommit(pbt);

}

// 若是失敗，回滾。

if (rc)

{

sqlite3BtreeRollback(pbt);

}

 

 

// 若是成功，銷燬先前的讀密鑰。並使讀密鑰等於當前的寫密鑰。

if (!rc)

{

if (pBlock->ReadKey)

{

sqliteFree(pBlock->ReadKey);

}

pBlock->ReadKey = pBlock->WriteKey;

}

else// 若是失敗，銷燬當前的寫密鑰，並恢復爲當前的讀密鑰。

{

if (pBlock->WriteKey)

{

sqliteFree(pBlock->WriteKey);

}

pBlock->WriteKey = pBlock->ReadKey;

}

 

// 若是讀密鑰和寫密鑰皆爲空，就不須要再對頁進行編解碼。

// 銷燬加密塊並移除頁的編解碼器

if (!pBlock->ReadKey && !pBlock->WriteKey)

{

sqlite3pager_set_codec(p, NULL, NULL);

DestroyCryptBlock(pBlock);

}

return rc;

}

int __stdcall sqlite3_key_interop(sqlite3 *db, const void *pKey, int nKeySize)

{

return sqlite3CodecAttach(db, 0, pKey, nKeySize);

}

 

// 釋放與一個頁相關的加密塊

void sqlite3pager_free_codecarg(void *pArg)

{

if (pArg)

DestroyCryptBlock((LPCryptBlock)pArg);

}

#endif //#ifdef SQLITE_HAS_CODEC