概述SQLITE3
基础教程 sqlite 常量的定义: const SQLITE_OK = 0; 返回成功 SQLITE_ERROR = 1; SQL 错误或错误的数据库 SQLITE_INTERNAL = 2; An internal logic error in SQLite SQLITE_PERM = 3; 拒绝访问 SQLITE_ABORT = 4; 回调函数请求中断 SQLITE_BUSY sqlite3 基础教程 sqlite 常量的定义: const sqlITE_OK = 0; 返回成功 sqlITE_ERROR = 1; sql 错误或错误的数据库 sqlITE_INTERNAL = 2; An internal logic error in sqlite sqlITE_PERM = 3; 拒绝访问 sqlITE_ABORT = 4; 回调函数请求中断 sqlITE_BUSY = 5; 数据库文件被锁 sqlITE_LOCKED = 6; 数据库中的一个表被锁 sqlITE_NOMEM = 7; 内存分配失败 sqlITE_Readonly = 8; 试图对一个只读数据库进行写 *** 作 sqlITE_INTERRUPT = 9; 由sqlite_interrupt()结束 *** 作 sqlITE_IOERR = 10; 磁盘I/O 发生错误 sqlITE_CORRUPT = 11; 数据库磁盘镜像畸形 sqlITE_NOTFOUND = 12; (Internal Only)表或记录不存在 sqlITE_FulL = 13; 数据库满插入失败 sqlITE_CANtopEN = 14; 不能打开数据库文件 sqlITE_PROTOCol = 15; 数据库锁定协议错误 sqlITE_EMPTY = 16; (Internal Only)数据库表为空 sqlITE_SCHEMA = 17; 数据库模式改变 sqlITE_TOOBIG = 18; 对一个表数据行过多 sqlITE_CONSTRAINT = 19; 由于约束冲突而中止 sqlITE_MISMATCH = 20; 数据类型不匹配 sqlITE_MISUSE = 21; 数据库错误使用 sqlITE_NolFS = 22; 使用主机 *** 作系统不支持的特性 sqlITE_AUTH = 23; 非法授权 sqlITE_FORMAT = 24; 辅助数据库格式错误 sqlITE_RANGE = 25; 2nd parameter to sqlite_bind out of range sqlITE_NOTADB = 26; 打开的不是一个数据库文件 sqlITE_ROW = 100; sqlite_step() has another row ready sqlITE_DONE = 101; sqlite_step() has finished executing 前序 sqlite3 的确很好用。小巧、速度快。但是因为非微软的产品,帮助文档总觉得不够。这些天再 次研究它,又有一些收获,这里把我对sqlite3 的研究列出来,以备忘记。这里要注明,我是一个跨 平台专注者,并不喜欢只用windows 平台。我以前的工作就是为unix 平台写代码。下面我所写的 东西,虽然没有验证,但是我已尽量不使用任何windows 的东西,只使用标准C 或标准C++。但 是,我没有尝试过在别的系统、别的编译器下编译,因此下面的叙述如果不正确,则留待以后修改。 下面我的代码仍然用VC 编写,因为我觉得VC 是一个很不错的IDE,可以加快代码编写速度 (例如配合Vassist )。下面我所说的编译环境,是VC2003。如果读者觉得自己习惯于unix 下用vi 2 编写代码速度较快,可以不用管我的说明,只需要符合自己习惯即可,因为我用的是标准C 或 C++ 。不会给任何人带来不便。 一、版本 从www.sqlite.org 网站可下载到最新的sqlite 代码和编译版本。我写此文章时,最新代码是 3.3.17 版本。很久没有去下载sqlite 新代码,因此也不知道sqlite 变化这么大。以前很多文件,现 在全部合并成一个sqlite3.c 文件。如果单独用此文件,是挺好的,省去拷贝一堆文件还担心有没有 遗漏。但是也带来一个问题:此文件太大,快接近7 万行代码,VC 开它整个机器都慢下来了。如果 不需要改它代码,也就不需要打开sqlite3.c 文件,机器不会慢。但是,下面我要写通过修改sqlite 代 码完成加密功能,那时候就比较痛苦了。如果个人水平较高,建议用些简单的编辑器来编辑,例如 ultraEdit 或Notepad 。速度会快很多。 二、基本编译 这个不想多说了,在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。可以不管它。 三、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 会自动建立它。 3 如果它存在,就尝试把它当数据库文件来打开。二是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 第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 ) { 5 //数据库打开失败 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,errmsg ); if(result != sqlITE_OK ) { printf( “创建表失败,错误码:%d,错误原因:%s\n”,result,errmsg ); } //插入一些记录 result = sqlite3_exec( db,“insert into Mytable_1( name ) values ( ‘走路’ )”,errmsg ); if(result != sqlITE_OK ) { printf( “插入记录失败,错误码:%d,错误原因:%s\n”,errmsg ); } result = sqlite3_exec( db,“insert into Mytable_1( name ) values ( ‘骑单车’)”,“insert into Mytable_1( name ) values ( ‘坐汽车’)”,errmsg ); } //开始查询数据库 result = sqlite3_exec( db,“select * from Mytable_1”,LoadMyInfo,errmsg ); //关闭数据库 sqlite3_close( db ); return 0; } 通过上面的例子,应该可以知道如何打开一个数据库,如何做数据库基本 *** 作。有这些知识, 基本上可以应付很多数据库 *** 作了。 i.3 不使用回调查询数据库 上面介绍的sqlite3_exec 是使用回调来执行select *** 作。还有一个方法可以直接查询而不需要 回调。但是,我个人感觉还是回调好,因为代码可以更加整齐,只不过用回调很麻烦,你得声明一 个函数,如果这个函数是类成员函数,你还不得不把它声明成static 的(要问为什么?这又是C++ 基础了。C++成员函数实际上隐藏了一个参数:this,C++调用类的成员函数的时候,隐含把类指针 当成函数的第一个参数传递进去。结果,这造成跟前面说的sqlite 回调函数的参数不相符。只有当 把成员函数声明成static 时,它才没有多余的隐含的this 参数)。 虽然回调显得代码整齐, 但有时候你还是想要非回调的select 查询。这可以通过 6 sqlite3_get_table 函数做到。 int sqlite3_get_table(sqlite3*,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,&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++ ) { 7 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 个参数。 8 第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”,0 ); 当prepare 成功之后(返回值是sqlITE_OK ),开始查询数据。 int result = sqlite3_step( stat ); 这一句的返回值是sqlITE_ROW 时表示成功(不是sqlITE_OK )。 你可以循环执行sqlite3_step 函数,一次step 查询出一条记录。直到返回值不为sqlITE_ROW 时表示查询结束。然后开始获取第一个字段:ID 的值。ID 是个整数,用下面这个语句获取它的值: 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 内容。 www.sqlite.org 网上down 下来的sqlite3.c 文件,直接摸索出这些接口的实现,我认为我还没有这个 能力。好在网上还有一些代码已经实现了这个功能。通过参照他们的代码以及不断编译中vc 给出的 错误提示,最终我把整个接口整理出来。 实现这些预留接口不是那么容易,要重头说一次怎么回事很困难。我把代码都写好了,直接把 他们按我下面的说明拷贝到sqlite3.c 文件对应地方即可。我在下面也提供了sqlite3.c 文件,可以直 接参考或取下来使用。 这里要说一点的是,我另外新建了两个文件:crypt.c 和crypt.h。 其中crypt.h 如此定义: 9 #ifndef DCG_sqlITE_CRYPT_FUNC_ #define DCG_sqlITE_CRYPT_FUNC_ /***********董淳光写的sqlITE 加密关键函数库***********/ /***********关键加密函数***********/ int My_Encrypt_Func( unsigned char * pData,unsigned int data_len,const char* key,unsigned int len_of_key ); /***********关键解密函数***********/ int My_DeEncrypt_Func( unsigned char * pData,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 len_of_key ) { return 0; } /***********关键解密函数***********/ int My_DeEncrypt_Func( unsigned char * pData,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" /***********用于在sqlite3 最后关闭时释放一些内存***********/ voID sqlite3pager_free_codecarg(voID *pArg); #endif 这个函数之所以要在sqlite3.c 开头声明,是因为下面在sqlite3.c 里面某些函数里要插入这个 函数调用。所以要提前声明。其次,在sqlite3.c 文件里搜索“sqlite3PagerClose”函数,要找到它的 实现代码(而不是声明代码)。实现代码里一开始是: 10 #ifdef sqlITE_ENABLE_MEMORY_MANAGEMENT /* A malloc() cannot fail in sqlite3ThreadData() as one or more calls to ** malloc() must have already been made by this thread before it gets ** to this point. This means the ThreadData must have been allocated already ** so that ThreadData.nAlloc can be set. */ 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 文件下找。找到最后一行: /************** End of main.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 ); 11 //修改密码 i = sqlite3_rekey( db,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,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 /*** 下面是编译时提示缺少的函数***/ /** 这个函数不需要做任何处理,获取密钥的部分在下面DeriveKey 函数里实现**/ voID sqlite3CodecGetKey(sqlite3* db,int nDB,voID** Key,int* nKey) { return ; } /*被sqlite 和sqlite3_key_interop 调用,附加密钥到数据库.*/ int sqlite3CodecAttach(sqlite3 *db,int nDb,const voID *pKey,int nKeyLen); /** 12 这个函数好像是sqlite 3.3.17 前不久才加的,以前版本的sqlite 里没有看到这个函数 这个函数我还没有搞清楚是做什么的,它里面什么都不做直接返回,对加解密没有影响 **/ voID sqlite3_activate_see(const char* right ) { return; } int sqlite3_key(sqlite3 *db,int nKey); int sqlite3_rekey(sqlite3 *db,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,int nKeySize); // 修改密码函数 int __stdcall sqlite3_rekey_interop(sqlite3 *db,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 ); //加密/解密函数,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); } 13 } 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,pBlock->WriteKey,DB_KEY_LENGTH_BYTE ) ; /*调用我的加密函数*/ break; case 7: //加密事务文件的页 /*在正常环境下,读密钥和写密钥相同. 当数据库是被重新加密的,读密钥和写密钥未必相同.回 滚事务必要用数据库文件的原始密钥写入.因此,当一次回滚被写入,总是用数据库的读密钥,这是为了 保证与读取原始数据的密钥相同。 */ if (!pBlock->ReadKey) break; memcpy(pBlock->Data + CRYPT_OFFSET,pBlock->PageSize); data = pBlock->Data + CRYPT_OFFSET; DWPageSize = pBlock->PageSize; My_Encrypt_Func( data,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); 14 } 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,DB_KEY_LENGTH_BYTE ); } return hKey; } //创建或更新一个页的加密算法索引.此函数会申请缓冲区。 static LPCryptBlock CreateCryptBlock(unsigned char* hKey,LPCryp tBlock pExisting) { LPCryptBlock pBlock; 15 if (!pExisting) //创建新加密块 { pBlock = sqliteMalloc(sizeof(CryptBlock)); memset(pBlock,sizeof(CryptBlock)); pBlock->ReadKey = hKey; pBlock->WriteKey = hKey; pBlock->PageSize = pager->pageSize; pBlock->Data = (unsigned char*)sqliteMalloc(pBlock->PageSize + CRYPT_OFFS ET); } 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,pBlock->PageSize + CRYPT_OFFSET); return pBlock; } /* ** Set the codec for this pager */ voID sqlite3pager_set_codec( Pager *pPager,voID *pCodecArg ) { pPager->xCodec = xCodec; pPager->pCodecArg = pCodecArg; } int sqlite3_key(sqlite3 *db,int nKey) { return sqlite3_key_interop(db,nKey); } int sqlite3_rekey(sqlite3 *db,int nKey) { return sqlite3_rekey_interop(db,nKey); } /*被sqlite 和sqlite3_key_interop 调用,附加密钥到数据库.*/ 16 int sqlite3CodecAttach(sqlite3 *db,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(sqli te3BtreePager(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),sqlite3Cod ec,pBlock); rc = sqlITE_OK; } return rc; } // Changes the encryption key for an existing database. int __stdcall sqlite3_rekey_interop(sqlite3 *db,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; 17 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) 18 { 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); DestroyCryptBlock(pBlock); } return rc; } /*** 下面是加密函数的主体 ***/ int __stdcall sqlite3_key_interop(sqlite3 *db,int nKeySize) { return sqlite3CodecAttach(db,nKeySize); } // 释放与一个页相关的加密块 voID sqlite3pager_free_codecarg(voID *pArg) { if (pArg) DestroyCryptBlock((LPCryptBlock)pArg); } #endif //#ifdef sqlITE_HAS_CODEC 五、后记 写此教程,可不是一个累字能解释。但是我还是觉得欣慰的,因为我很久以前就想写sqlite 的 教程,一来自己备忘,二而已造福大众,大家不用再走弯路。本人第一次写教程,不足的地方请大 家指出。 本文可随意转载、修改、引用。但无论是转载、修改、引用,都请附带我的名字:董淳光。以 示对我劳动的肯定 总结
以上是内存溢出为你收集整理的sqlite基础教程全部内容,希望文章能够帮你解决sqlite基础教程所遇到的程序开发问题。
如果觉得内存溢出网站内容还不错,欢迎将内存溢出网站推荐给程序员好友。
评论列表(0条)