SQLite3基础教程(二)

［接上篇 http://blog.csdn.net/guochuanqi/article/details/17410545］

（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语句当成以结尾的字符串）；

第四个参数是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 *类型变量：

当prepare成功之后（返回值是SQLITE_OK），开始查询数据。

这一句的返回值是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,102)">这样就得到了二进制的值。

把pFileContent的内容保存出来之后，不要忘了释放sqlite3_stmt结构：

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如此定义：

#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,102)">#endif

其中的crypt.c如此定义：

#include "./crypt.h"

#include "memory.h"

{

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

/***********用于在sqlite3最后关闭时释放一些内存***********/

void sqlite3pager_free_codecarg(void *pArg);

这个函数之所以要在sqlite3.c开头声明，是因为下面在sqlite3.c里面某些函数里要插入这个函数调用。所以要提前声明。其次，在sqlite3.c文件里搜索“sqlite3PagerClose”函数，要找到它的实现代码（而不是声明代码）。实现代码里一开始是：

#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 );

需要在这部分后面紧接着插入：

sqlite3pager_free_codecarg(pPager->pCodecArg);

这里要注意，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 );

//修改密码

i = sqlite3_rekey( db,102)">用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.4 sqlite3.c最后添加代码段

/***董淳光定义的加密函数***/

/***加密结构***/

#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 /*密钥长度*/

#ifndef DB_KEY_PADDING /*密钥位数不足时补充的字符*/

#define DB_KEY_PADDING 0x33 /*密钥位数不足时补充的字符*/

/***下面是编译时提示缺少的函数***/

/**这个函数不需要做任何处理，获取密钥的部分在下面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);

/**

这个函数好像是sqlite3.3.17前不久才加的，以前版本的sqlite里没有看到这个函数

这个函数我还没有搞清楚是做什么的，它里面什么都不做直接返回，对加解密没有影响

**/

void sqlite3_activate_see(const char* right )

return;

int sqlite3_key(sqlite3 *db,int nKey);

int sqlite3_rekey(sqlite3 *db,102)">/***

下面是上面的函数的辅助处理函数

***/

//从用户提供的缓冲区中得到一个加密密钥

//用户提供的密钥可能位数上满足不了要求，使用这个函数来完成密钥扩展

static unsigned char * DeriveKey(const void *pKey,102)">//创建或更新一个页的加密算法索引.此函数会申请缓冲区。

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,102)">//销毁一个加密块及相关的缓冲区,密钥.

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 );

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;

My_Encrypt_Func(data,pBlock->WriteKey,DB_KEY_LENGTH_BYTE )

; /*调用我的加密函数*/

case 7: //加密事务文件的页

/*在正常环境下,读密钥和写密钥相同.当数据库是被重新加密的,读密钥和写密钥未必相同.回滚事务必要用数据库文件的原始密钥写入.因此,当一次回滚被写入,总是用数据库的读密钥,这是为了保证与读取原始数据的密钥相同。

My_Encrypt_Func( data,DB_KEY_LENGTH_BYTE );

/*调用我的加密函数*/

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;

unsigned char * hKey = NULL;

int j;

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

return NULL;

hKey = sqliteMalloc( DB_KEY_LENGTH_BYTE + 1 );

if( hKey == 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

{ //密钥位数已经足够,直接把密钥取过来

return hKey;

tBlock pExisting)

LPCryptBlock pBlock;

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){

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 *(*xCodec)(void*,102)">void *pCodecArg

)

pPager->xCodec = xCodec;

pPager->pCodecArg = pCodecArg;

return sqlite3_key_interop(db,nKey);

return sqlite3_rekey_interop(db,102)">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,102)">rc = SQLITE_OK;

return rc;

// Changes the encryption key for an existing database.

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

Pager *p = sqlite3BtreePager(pbt);

LPCryptBlock pBlock = (LPCryptBlock)sqlite3pager_get_codecarg(p);

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

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

//重新加密一个数据库,改变pager的写密钥,读密钥依旧保留.

if (!pBlock) //加密一个未加密的数据库

pBlock = CreateCryptBlock(hKey,p,102)">pBlock->ReadKey = 0; //原始数据库未加密

sqlite3pager_set_codec(sqlite3BtreePager(pbt),sqlite3Codec,102)">else //改变已加密数据库的写密钥

//开始一个事务

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);

//如果成功，提交事务。

rc = sqlite3BtreeCommit(pbt);

//如果失败，回滚。

if (rc)

sqlite3BtreeRollback(pbt);

//如果成功，销毁先前的读密钥。并使读密钥等于当前的写密钥。

if (pBlock->ReadKey)

pBlock->ReadKey = pBlock->WriteKey;

else//如果失败，销毁当前的写密钥，并恢复为当前的读密钥。

if (pBlock->WriteKey)

pBlock->WriteKey = pBlock->ReadKey;

//如果读密钥和写密钥皆为空，就不需要再对页进行编解码。

//销毁加密块并移除页的编解码器

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

sqlite3pager_set_codec(p,102)">DestroyCryptBlock(pBlock);

下面是加密函数的主体

return sqlite3CodecAttach(db,102)">//释放与一个页相关的加密块

void sqlite3pager_free_codecarg(void *pArg)

if (pArg)

DestroyCryptBlock((LPCryptBlock)pArg);

#endif //#ifdef SQLITE_HAS_CODEC

五、后记

写此教程，可不是一个累字能解释。但是我还是觉得欣慰的，因为我很久以前就想写sqlite的教程，一来自己备忘，二而已造福大众，大家不用再走弯路。本人第一次写教程，不足的地方请大家指出。

本文可随意转载、修改、引用。但无论是转载、修改、引用，都请附带我的名字：董淳光。以示对我劳动的肯定

［注：原文地址 http://blog.chinaunix.net/uid-9255716-id-107973.html］

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!