sqlite3-基础教程
SQLITE3基础教程
sqlite常量的定义:
const
SQLITE_OK=0;返回成功
SQLITE_ERROR=1;SQL错误或错误的数据库
SQLITE_INTERNAL=2;AninternallogicerrorinSQLite
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;(InternalOnly)表或记录不存在
SQLITE_FULL=13;数据库满插入失败
SQLITE_CANTOPEN=14;不能打开数据库文件
SQLITE_PROTOCOL=15;数据库锁定协议错误
SQLITE_EMPTY=16;(InternalOnly)数据库表为空
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;2ndparametertosqlite_bindoutofrange
SQLITE_NOTADB=26;打开的不是一个数据库文件
SQLITE_ROW=100;sqlite_step()hasanotherrowready
SQLITE_DONE=101;sqlite_step()hasfinishedexecuting
前序
Sqlite3的确很好用。小巧、速度快。但是因为非微软的产品,帮助文档总觉得不够。这些天再次研究它,又有一些收获,这里把我对sqlite3的研究列出来,以备忘记。这里要注明,我是一个跨平台专注者,并不喜欢只用windows平台。我以前的工作就是为unix平台写代码。下面我所写的东西,虽然没有验证,但是我已尽量不使用任何windows的东西,只使用标准C或标准C++。但是,我没有尝试过在别的系统、别的编译器下编译,因此下面的叙述如果不正确,则留待以后修改。下面我的代码仍然用VC编写,因为我觉得VC是一个很不错的IDE,可以加快代码编写速度(例如配合Vassist)。下面我所说的编译环境,是VC2003。如果读者觉得自己习惯于unix下用vi
编写代码速度较快,可以不用管我的说明,只需要符合自己习惯即可,因为我用的是标准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"
};
intmain(int,char**)
{
return0;
}
为什么要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打开数据库
intsqlite3_open(文件名,sqlite3**);
用这个函数开始数据库操作。需要传入两个参数,一是数据库文件名,比如:c:\\DongChunGuang_Database.db。文件名不需要一定存在,如果此文件不存在,sqlite会自动建立它。
如果它存在,就尝试把它当数据库文件来打开。二是sqlite3**,即前面提到的关键数据结构。这个结构底层细节如何,你不要关它。
函数返回值表示操作是否正确,如果是SQLITE_OK则表示操作正常。相关的返回值sqlite定义了一些宏。具体这些宏的含义可以参考sqlite3.h文件。里面有详细定义(顺便说一下,sqlite3的代码注释率自称是非常高的,实际上也的确很高。只要你会看英文,sqlite可以让你学到不少东西)。
下面介绍关闭数据库后,再给一段参考代码。
i.3关闭数据库
intsqlite3_close(sqlite3*);
前面如果用sqlite3_open开启了一个数据库,结尾时不要忘了用这个函数关闭数据库。下面给段简单的代码:
extern"C"
{
#include"./sqlite3.h"
};
intmain(int,char**)
{
sqlite3*db=NULL;//声明sqlite关键结构指针
intresult;
//打开数据库
//需要传入db这个指针的指针,因为sqlite3_open函数要为这个指针分配内存,还要让db指针指向这个内存区
result=sqlite3_open(“c:\\Dcg_database.db”,&db);
if(result!=SQLITE_OK)
{
//数据库打开失败
return-1;
}
//数据库操作代码
//…
//数据库打开成功
//关闭数据库
sqlite3_close(db);
return0;
}
这就是一次数据库操作过程。
(2)SQL语句操作
本节介绍如何用sqlite执行标准sql语法。
i.1执行sql语句
intsqlite3_exec(sqlite3*,constchar*sql,sqlite3_callback,void*,char**errmsg);
这就是执行一条sql语句的函数。
第1个参数不再说了,是前面open函数得到的指针。说了是关键数据结构。
第2个参数constchar*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.2exec的回调
typedefint(*sqlite3_callback)(void*,int,char**,char**);
你的回调函数必须定义成上面这个函数的类型。下面给个简单的例子:
//sqlite3的回调函数
//sqlite每查到一条记录,就调用一次这个回调
intLoadMyInfo(void*para,intn_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参数。忽略它的存在.
inti;
printf(“记录包含%d个字段\n”,n_column);
for(i=0;i
{
printf(“字段名:%sß>字段值:%s\n”,column_name[i],column_value[i]);
}
printf(“------------------\n“);
return0;
}
intmain(int,char**)
{
sqlite3*db;
intresult;
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,“createtableMyTable_1(IDintegerprimarykeyautoincrement,namenvarchar(32))”,NULL,NULL,errmsg);
if(result!=SQLITE_OK)
{
printf(“创建表失败,错误码:%d,错误原因:%s\n”,result,errmsg);
}
//插入一些记录
result=sqlite3_exec(db,“insertintoMyTable_1(name)values(‘走路’)”,0,0,errmsg);if(result!=SQLITE_OK)
{
printf(“插入记录失败,错误码:%d,错误原因:%s\n”,result,errmsg);
}
result=sqlite3_exec(db,“insertintoMyTable_1(name)values(‘骑单车’)”,0,0,errmsg);if(result!=SQLITE_OK)
{
printf(“插入记录失败,错误码:%d,错误原因:%s\n”,result,errmsg);
}
result=sqlite3_exec(db,“insertintoMyTable_1(name)values(‘坐汽车’)”,0,0,errmsg);if(result!=SQLITE_OK)
{
printf(“插入记录失败,错误码:%d,错误原因:%s\n”,result,errmsg);
}
//开始查询数据库
result=sqlite3_exec(db,“select*fromMyTable_1”,LoadMyInfo,NULL,errmsg);
//关闭数据库
sqlite3_close(db);
return0;
}
通过上面的例子,应该可以知道如何打开一个数据库,如何做数据库基本操作。有这些知识,基本上可以应付很多数据库操作了。
i.3不使用回调查询数据库
上面介绍的sqlite3_exec是使用回调来执行select操作。还有一个方法可以直接查询而不需要回调。但是,我个人感觉还是回调好,因为代码可以更加整齐,只不过用回调很麻烦,你得声明一个函数,如果这个函数是类成员函数,你还不得不把它声明成static的(要问为什么?这又是C++基础了。C++成员函数实际上隐藏了一个参数:this,C++调用类的成员函数的时候,隐含把类指针当成函数的第一个参数传递进去。结果,这造成跟前面说的sqlite回调函数的参数不相符。只有当把成员函数声明成static时,它才没有多余的隐含的this参数)。
虽然回调显得代码整齐,但有时候你还是想要非回调的select查询。这可以通过
sqlite3_get_table函数做到。
intsqlite3_get_table(sqlite3*,constchar*sql,char***resultp,int*nrow,int*ncolumn,char**errmsg);
第1个参数不再多说,看前面的例子。
第2个参数是sql语句,跟sqlite3_exec里的sql是一样的。是一个很普通的以\0结尾的char*字符串。
第3个参数是查询结果,它依然一维数组(不要以为是二维数组,更不要以为是三维数组)。它内存布局是:第一行是字段名称,后面是紧接着是每个字段的值。下面用例子来说事。
第4个参数是查询出多少条记录(即查出多少行)。
第5个参数是多少个字段(多少列)。
第6个参数是错误信息,跟前面一样,这里不多说了。
下面给个简单例子:
intmain(int,char**)
{
sqlite3*db;
intresult;
char*errmsg=NULL;
char**dbResult;//是char**类型,两个*号
intnRow,nColumn;
inti,j;
intindex;
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*fromMyTable_1”,&dbResult,&nRow,&nColumn,&errmsg);
if(SQLITE_OK==result)
{
//查询成功
index=nColumn;//前面说过dbResult前面第一行数据是字段名称,从nColumn索引开始才是真正的数据
printf(“查到%d条记录\n”,nRow);
for(i=0;i
{
printf(“第%d条记录\n”,i+1);
for(j=0;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);
return0;
}
到这个例子为止,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类型。我假设有这么一张表:
createtableTbl_2(IDinteger,file_contentblob)
首先声明
sqlite3_stmt*stat;
然后,把一个sql语句解析到stat结构里去:
sqlite3_prepare(db,“insertintoTbl_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语句”里了。你现在可以把它保存到数据库里:
intresult=sqlite3_step(stat);
通过这个语句,stat表示的sql语句就被写到了数据库里。最后,要把sqlite3_stmt结构给释放:sqlite3_finalize(stat);//把刚才分配的内容析构掉
i.2读出二进制
下面说读二进制的步骤。跟前面一样,先声明sqlite3_stmt*类型变量:
sqlite3_stmt*stat;
然后,把一个sql语句解析到stat结构里去:
sqlite3_prepare(db,“select*fromTbl_2”,-1,&stat,0);
当prepare成功之后(返回值是SQLITE_OK),开始查询数据。
intresult=sqlite3_step(stat);
这一句的返回值是SQLITE_ROW时表示成功(不是SQLITE_OK)。
你可以循环执行sqlite3_step函数,一次step查询出一条记录。直到返回值不为SQLITE_ROW时表示查询结束。然后开始获取第一个字段:ID的值。ID是个整数,用下面这个语句获取它的值:intstat,0);//第2个参数表示获取第几个字段内容,从0开始计算,因为我的表的ID字段是第一个字段,因此这里我填0
下面开始获取file_content的值,因为file_content是二进制,因此我需要得到它的指针,还有它的长度:
constvoid*pFileContent=sqlite3_column_blob(stat,1);
intlen=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如此定义:
#ifndefDCG_SQLITE_CRYPT_FUNC_
#defineDCG_SQLITE_CRYPT_FUNC_
/***********董淳光写的SQLITE加密关键函数库***********/
/***********关键加密函数***********/
intMy_Encrypt_Func(unsignedchar*pData,unsignedintdata_len,constchar*key,unsignedintlen_of_key);
/***********关键解密函数***********/
intMy_DeEncrypt_Func(unsignedchar*pData,unsignedintdata_len,constchar*key,unsignedintlen_of_key);
#endif
其中的crypt.c如此定义:
#include"./crypt.h"
#include"memory.h"
/***********关键加密函数***********/
intMy_Encrypt_Func(unsignedchar*pData,unsignedintdata_len,constchar*key,unsignedintlen_of_key)
{
return0;
}
/***********关键解密函数***********/
intMy_DeEncrypt_Func(unsignedchar*pData,unsignedintdata_len,constchar*key,unsignedintlen_of_key)
{
return0;
}
这个文件很容易看,就两函数,一个加密一个解密。传进来的参数分别是待处理的数据、数据长度、密钥、密钥长度。处理时直接把结果作用于pData指针指向的内容。你需要定义自己的加解密过程,就改动这两个函数,其它部分不用动。扩展起来很简单。
这里有个特点,data_len一般总是1024字节。正因为如此,你可以在你的算法里使用一些特定长度的加密算法,比如AES要求被加密数据一定是128位(16字节)长。这个1024不是碰巧,而是Sqlite的页定义是1024字节,在sqlite3.c文件里有定义:
#defineSQLITE_DEFAULT_PAGE_SIZE1024
你可以改动这个值,不过还是建议没有必要不要去改它。上面写了两个扩展函数,如何把扩展函数跟Sqlite挂接起来,这个过程说起来比较麻烦。我直接贴代码。
分3个步骤。
首先,在sqlite3.c文件顶部,添加下面内容:
#ifdefSQLITE_HAS_CODEC
#include"./crypt.h"
/***********用于在sqlite3最后关闭时释放一些内存***********/
voidsqlite3pager_free_codecarg(void*pArg);
#endif
这个函数之所以要在sqlite3.c开头声明,是因为下面在sqlite3.c里面某些函数里要插入这个函数调用。所以要提前声明。其次,在sqlite3.c文件里搜索“sqlite3PagerClose”函数,要找到它的实现代码(而不是声明代码)。实现代码里一开始是:
#ifdefSQLITE_ENABLE_MEMORY_MANAGEMENT
/*Amalloc()cannotfailinsqlite3ThreadData()asoneormorecallsto
**malloc()musthavealreadybeenmadebythisthreadbeforeitgets
**tothispoint.ThismeanstheThreadDatamusthavebeenallocatedalready
**sothatThreadData.nAlloccanbeset.
*/
ThreadData*pTsd=sqlite3ThreadData();
assert(pPager);
assert(pTsd&&pTsd->nAlloc);
#endif
需要在这部分后面紧接着插入:
#ifdefSQLITE_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文件下找。找到最后一行:
/**************Endofmain.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成功了,紧接着写下面的代码:
inti;
//添加、使用密码
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,并且得到错误提示:“fileisencryptedorisnotadatabase”。
只有当你用sqlite3_key设置了正确的密码,数据库才会正常工作。如果你要修改密码,前提是你必须先sqlite3_open打开数据库成功,然后sqlite3_key设置密钥成功,之后才能用sqlite3_rekey来修改密码。如果数据库有密码,但你没有用sqlite3_key设置密码,那么当你尝试用sqlite3_rekey来修改密码时会得到SQLITE_NOTADB返回值。如果你需要清空密码,可以使用:
//修改密码
i=sqlite3_rekey(db,NULL,0);
来完成密码清空功能。
i.4sqlite3.c最后添加代码段
/***董淳光定义的加密函数***/
#ifdefSQLITE_HAS_CODEC
/***加密结构***/
#defineCRYPT_OFFSET8
typedefstruct_CryptBlock
{
BYTE*ReadKey;//读数据库和写入事务的密钥
BYTE*WriteKey;//写入数据库的密钥
intPageSize;//页的大小
BYTE*Data;
}CryptBlock,*LPCryptBlock;
#ifndefDB_KEY_LENGTH_BYTE/*密钥长度*/
#defineDB_KEY_LENGTH_BYTE16/*密钥长度*/
#endif
#ifndefDB_KEY_PADDING/*密钥位数不足时补充的字符*/
#defineDB_KEY_PADDING0x33/*密钥位数不足时补充的字符*/
#endif
/***下面是编译时提示缺少的函数***/
/**这个函数不需要做任何处理,获取密钥的部分在下面DeriveKey函数里实现**/
voidsqlite3CodecGetKey(sqlite3*db,intnDB,void**Key,int*nKey)
{
return;
}
/*被sqlite和sqlite3_key_interop调用,附加密钥到数据库.*/
intsqlite3CodecAttach(sqlite3*db,intnDb,constvoid*pKey,intnKeyLen);
/**
这个函数好像是sqlite3.3.17前不久才加的,以前版本的sqlite里没有看到这个函数
这个函数我还没有搞清楚是做什么的,它里面什么都不做直接返回,对加解密没有影响
**/
voidsqlite3_activate_see(constchar*right)
{
return;
}
intsqlite3_key(sqlite3*db,constvoid*pKey,intnKey);
intsqlite3_rekey(sqlite3*db,constvoid*pKey,intnKey);
/***
下面是上面的函数的辅助处理函数
***/
//从用户提供的缓冲区中得到一个加密密钥
//用户提供的密钥可能位数上满足不了要求,使用这个函数来完成密钥扩展
staticunsignedchar*DeriveKey(constvoid*pKey,intnKeyLen);
//创建或更新一个页的加密算法索引.此函数会申请缓冲区。
staticLPCryptBlockCreateCryptBlock(unsignedchar*hKey,Pager*pager,LPCryptBlockpExisting);
//加密/解密函数,被pager调用
void*sqlite3Codec(void*pArg,unsignedchar*data,PgnonPageNum,intnMode);
//设置密码函数
int__stdcallsqlite3_key_interop(sqlite3*db,constvoid*pKey,intnKeySize);
//修改密码函数
int__stdcallsqlite3_rekey_interop(sqlite3*db,constvoid*pKey,intnKeySize);
//销毁一个加密块及相关的缓冲区,密钥.
staticvoidDestroyCryptBlock(LPCryptBlockpBlock);
staticvoid*sqlite3pager_get_codecarg(Pager*pPager);
voidsqlite3pager_set_codec(Pager*pPager,void*(*xCodec)(void*,void*,Pgno,int),void*pCodecArg);
//加密/解密函数,被pager调用
void*sqlite3Codec(void*pArg,unsignedchar*data,PgnonPageNum,intnMode)
{
LPCryptBlockpBlock=(LPCryptBlock)pArg;
unsignedintdwPageSize=0;
if(!pBlock)returndata;
//确保pager的页长度和加密块的页长度相等.如果改变,就需要调整。
if(nMode!=2)
{
PgHdr*pageHeader;
pageHeader=DATA_TO_PGHDR(data);
if(pageHeader->pPager->pageSize!=pBlock->PageSize)
{
CreateCryptBlock(0,pageHeader->pPager,pBlock);
}
switch(nMode)
{
case0://Undoa"case7"journalfileencryption
case2://重载一个页
case3://载入一个页
if(!pBlock->ReadKey)break;
dwPageSize=pBlock->PageSize;
My_DeEncrypt_Func(data,dwPageSize,pBlock->ReadKey,DB_KEY_LENGTH_BYTE);/*调用我的解密函数*/
break;
case6://加密一个主数据库文件的页
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;
case7://加密事务文件的页
/*在正常环境下,读密钥和写密钥相同.当数据库是被重新加密的,读密钥和写密钥未必相同.回滚事务必要用数据库文件的原始密钥写入.因此,当一次回滚被写入,总是用数据库的读密钥,这是为了保证与读取原始数据的密钥相同。
*/
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;
}
returndata;
}
//销毁一个加密块及相关的缓冲区,密钥.
staticvoidDestroyCryptBlock(LPCryptBlockpBlock)
{
//销毁读密钥.
if(pBlock->ReadKey){
sqliteFree(pBlock->ReadKey);
}
//如果写密钥存在并且不等于读密钥,也销毁.
if(pBlock->WriteKey&&pBlock->WriteKey!=pBlock->ReadKey){
sqliteFree(pBlock->WriteKey);
if(pBlock->Data){
sqliteFree(pBlock->Data);
}
//释放加密块.
sqliteFree(pBlock);
}
staticvoid*sqlite3pager_get_codecarg(Pager*pPager)
{
return(pPager->xCodec)?pPager->pCodecArg:NULL;
}
//从用户提供的缓冲区中得到一个加密密钥
staticunsignedchar*DeriveKey(constvoid*pKey,intnKeyLen)
{
unsignedchar*hKey=NULL;
intj;
if(pKey==NULL||nKeyLen==0)
{
returnNULL;
}
hKey=sqliteMalloc(DB_KEY_LENGTH_BYTE+1);
if(hKey==NULL)
{
returnNULL;
}
hKey[DB_KEY_LENGTH_BYTE]=0;
if(nKeyLen
{
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);
}
returnhKey;
}
//创建或更新一个页的加密算法索引.此函数会申请缓冲区。
staticLPCryptBlockCreateCryptBlock(unsignedchar*hKey,Pager*pager,LPCryp
tBlockpExisting)
{
LPCryptBlockpBlock;
if(!pExisting)//创建新加密块
{
pBlock=sqliteMalloc(sizeof(CryptBlock));
memset(pBlock,0,sizeof(CryptBlock));
pBlock->ReadKey=hKey;
pBlock->WriteKey=hKey;
pBlock->PageSize=pager->pageSize;
pBlock->Data=(unsignedchar*)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=(unsignedchar*)sqliteMalloc(pBlock->PageSize+CRYPT
_OFFSET);
}
}
memset(pBlock->Data,0,pBlock->PageSize+CRYPT_OFFSET);
returnpBlock;
}
/*
**Setthecodecforthispager
*/
voidsqlite3pager_set_codec(
Pager*pPager,
void*(*xCodec)(void*,void*,Pgno,int),
void*pCodecArg
)
{
pPager->xCodec=xCodec;
pPager->pCodecArg=pCodecArg;
}
intsqlite3_key(sqlite3*db,constvoid*pKey,intnKey)
{
returnsqlite3_key_interop(db,pKey,nKey);
}
intsqlite3_rekey(sqlite3*db,constvoid*pKey,intnKey)
{
returnsqlite3_rekey_interop(db,pKey,nKey);
}
/*被sqlite和sqlite3_key_interop调用,附加密钥到数据库.*/
intsqlite3CodecAttach(sqlite3*db,intnDb,constvoid*pKey,intnKeyLen)
{
intrc=SQLITE_ERROR;
unsignedchar*hKey=0;
//如果没有指定密匙,可能标识用了主数据库的加密或没加密.
if(!pKey||!nKeyLen)
{
if(!nDb)
{
returnSQLITE_OK;//主数据库,没有指定密钥所以没有加密.
}
else//附加数据库,使用主数据库的密钥.
{
//获取主数据库的加密块并复制密钥给附加数据库使用
LPCryptBlockpBlock=(LPCryptBlock)sqlite3pager_get_codecarg(sqli
te3BtreePager(db->aDb[0].pBt));
if(!pBlock)returnSQLITE_OK;//主数据库没有加密
if(!pBlock->ReadKey)returnSQLITE_OK;//没有加密
memcpy(pBlock->ReadKey,&hKey,16);
}
}
else//用户提供了密码,从中创建密钥.
{
hKey=DeriveKey(pKey,nKeyLen);
}
//创建一个新的加密块,并将解码器指向新的附加数据库.
if(hKey)
{
LPCryptBlockpBlock=CreateCryptBlock(hKey,sqlite3BtreePager(db->aDb
[nDb].pBt),NULL);
sqlite3pager_set_codec(sqlite3BtreePager(db->aDb[nDb].pBt),sqlite3Cod
ec,pBlock);
rc=SQLITE_OK;
}
returnrc;
}
//Changestheencryptionkeyforanexistingdatabase.
int__stdcallsqlite3_rekey_interop(sqlite3*db,constvoid*pKey,intnKeySize)
{
Btree*pbt=db->aDb[0].pBt;
Pager*p=sqlite3BtreePager(pbt);
LPCryptBlockpBlock=(LPCryptBlock)sqlite3pager_get_codecarg(p);
unsignedchar*hKey=DeriveKey(pKey,nKeySize);
intrc=SQLITE_ERROR;
if(!pBlock&&!hKey)returnSQLITE_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)
{
//用新密钥重写所有的页到数据库。
PgnonPage=sqlite3PagerPagecount(p);
PgnonSkip=PAGER_MJ_PGNO(p);
void*pPage;
Pgnon;
for(n=1;rc==SQLITE_OK&&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);
}
returnrc;
}
/***
下面是加密函数的主体
***/
int__stdcallsqlite3_key_interop(sqlite3*db,constvoid*pKey,intnKeySize)
{
returnsqlite3CodecAttach(db,0,pKey,nKeySize);
}
//释放与一个页相关的加密块
voidsqlite3pager_free_codecarg(void*pArg)
{
if(pArg)
DestroyCryptBlock((LPCryptBlock)pArg);
}
#endif//#ifdefSQLITE_HAS_CODEC
五、后记
写此教程,可不是一个累字能解释。但是我还是觉得欣慰的,因为我很久以前就想写sqlite的教程,一来自己备忘,二而已造福大众,大家不用再走弯路。本人第一次写教程,不足的地方请大家指出。
本文可随意转载、修改、引用。但无论是转载、修改、引用,都请附带我的名字:董淳光。以示对我劳动的肯定