全部产品

DAO 存储

更新时间:2020-06-18 16:58:06

普通 KV 存储只能存储简单数据类型或封装好的 OC 对象,且不支持搜索。当业务有 sqlite 访问需求时,可由统一存储的 DAO 功能进行简化和封装。基本工作原理如下:

DAO

  1. 定义一个 xml 格式的配置文件,描述各 sqlite 操作的函数,返回的数据类型,需要加密的字段等。
  2. 定义一个 DAO 对象的接口 DAOInterface(@protocol),接口方法名、参数与配置文件里的描述一致。
  3. 业务将 xml 配置文件传给 APDataCenter 的 daoWithPath 方法,生成 DAO 访问对象。该对象直接强转为 id<DAOInterface>
  4. 接下来业务就可以直接调用 DAO 对象的方法,统一存储会将该方法转换为配置文件里描述的数据库操作。

示例

  • 配置文件第一行定义了默认表名和数据库版本,以及初始化方法。
  • insertItemgetItem 是插入和读取数据的两个方法,接收参数并格式化到 sql 表达式里。
  • createTable 方法会在底层被默认调用一次。

    1. <module name="Demo" initializer="createTable" tableName="demoTable" version="1.0">
    2. <update id="createTable">
    3. create table if not exists ${T} (index integer primary key, content text)
    4. </update>
    5. <insert id="insertItem" arguments="content">
    6. insert into ${T} (content) values(#{content})
    7. </insert>
    8. <select id="getItem" arguments="index" result="string">
    9. select * from ${T} where index = #{index}
    10. </select>
    11. </module>
  • DAO 接口定义:
    1. @protocol DemoProtocol <APDAOProtocol>
    2. - (APDAOResult*)insertItem:(NSString*)content;
    3. - (NSString*)getItem:(NSNumber*)index;
    4. @end
  • 创建 DAO 代理对象,假设配置文件名为 demo_config.xml,在 Main Bundle 中。
  • insertItem 方法写入一个数据,获取它的索引,再用该索引把写入的数据读出来。
    1. NSString* filePath = [[NSBundle mainBundle] pathForResource:@"demo_config" ofType:@"xml"];
    2. id<DemoProtocol> proxy = [[APDataCenter defaultDataCenter] daoWithPath:filePath userDependent:YES];
    3. [proxy insertItem:@"something"];
    4. long long lastIndex = [proxy lastInsertRowId];
    5. NSString* content = [proxy getItem:[NSNumber numberWithInteger:lastIndex]];
    6. NSLog(@"content %@", content);
  • 其中 lastInsertRowIdAPDAOProtocol 的一个方法,用来取最后插入的行的 rowId。想让 DAO 对象支持该方法,只要在声明 DemoProtocol 时继承自 APDAOProtocol 即可。

关键字

module

  1. <module name="demo" initializer="createTable" tableName="tableDemo" version="1.5" resetOnUpgrade="true" upgradeMinVersion="1.2">
  • initializer 参数可选。对于 initializer 指定的 update 方法,DAO 认为是数据库建表方法,会在第一次 DAO 请求时默认执行一次。
  • tableName 指定下面方法里默认操作的表名,在 SQL 语句里可以用 ${T}或${t} 代替,不用每次都写表名。建议每个配置文件只操作一张表。tableName 可空,应对同一配置文件操作相同格式的多张表的情况。比如聊天消息分表处理,可以调用 DAO 对象的 setTableName 方法设置需要操作的表名。
  • version 是配置文件的版本号,格式为 x.x,创建 table 后,会以 tableName 作为 key,把表的版本存到数据库文件的 TableVersions 表里,配合 upgrade 块进行表的更新。
  • resetOnUpgrade,如果为 true 或 YES,当 version 更新后,会删除原表,而不是调用 ungrade 块。无此参数为默认为 false。
  • upgradeMinVersion,如果不为空,对于小于这个版本的数据库文件,直接重置,否则执行升级操作。

const

  1. <const table_columns="(id, time, content, uin, read)"/>
  • 定义一个字符串类型的常量,table_columns 是常量的名字,等号(=)后方为常量值,在配置文件里可以使用 ${常量名} 来引用。

select

  1. <select id="find" arguments="id, time" result=":messageModelMap">
  2. select * from ${T} where id = #{id} and time > @{time}
  3. </select>

@arguments

  • 参数名的列表,用 , 分隔。调用者传进来的参数依赖 arguments 里的描述依次命名。DAO 对象的 selector 调用时不会携带参数名,所以必须在这里按顺序命名。
  • 参数名前面有 $ 符号时,表示这个参数不接受 nil 值。业务的调用 DAO 接口,是允许传 nil 参数的,如果某个参数前面有 $ 符号,当调用者不小心传入了 nil 值,DAO 调用会自动失败。防止发生不可预知的问题。
  • 关于如何引用参数,参见下文中的 引用方式

例如,在上方的代码中,对应的 selector 为:

  1. - (MessageModel*)find:(NSNumber*)id time:(NSNumber*)time;

如果 DAO 对象调用 [daoProxy find:@1234 time:@2014],那么拼接好后的 SQL 语句是:

  1. select * from tableDemo where id = ? and time > 2014

并且 @1234 这个 NSNumber 会交给 sqlite 绑定。

@result

  • result 里可以填写 DAO 方法的返回值,用 [] 括起来表示返回数组类型,会对 select 执行的返回一直进行迭代,直到 sqlite 无结果返回。如果不用 [] 括起来,表示只返回一个结果,对 select 执行的返回只迭代一次,类似 FMDB 库里 FMResultSet 只调用一次 next 方法。

返回类型:

  • int:只有一个结果,返回 [NSNumber numberWithInt] 类型,注意溢出的可能。
  • long long:只有一个结果,返回 [NSNumber numberWithLongLong] 类型。
  • bool:只有一个结果,返回 [NSNumber numberWithBool] 类型。
  • double:只有一个结果,返回 [NSNumber numberWithDouble] 类型。
  • string:只有一个结果,返回 NSString* 类型。
  • binary:只有一个结果,返回 NSData* 类型。
  • [int]:返回数组,数组里为[NSNumber numberWithInt]
  • [long long]:返回数组,数组里为 [NSNumber numberWithLongLong]
  • [bool]:返回数组,数组里为 [NSNumber numberWithBool]
  • [double]:返回数组,数组里为 [NSNumber numberWithDouble]
  • [string]:返回数组,数组里为 NSString*
  • [binary]:返回数组,数组里为 NSData*
  • [{}]:返回数组,数组里是列名 > 列值的 map。
  • [AType]:返回数组,数组里是填好的自定义类。
  • {}:只有一个结果,返回列名 > 列值的 map。
  • AType:只有一个结果,返回填好的自定义类。
  • [:AMap]:返回数组,数组里是使用 xml 里定义的 AMap 映射出来的对象。
  • :AMap:只有一个结果,使用配置文件里定义的 AMap 来描述对象。

例如,上面的例子中,返回类型为 :messageModelMap。具体返回的 Objective-C 类型,以及需要特殊映射的列都会在 messageModelMap 里定义。参考 map 关键字。

@foreach
select 也支持 foreach 字段,用法下文介绍的 insertupdatedelete 里的相似。不同的是,select 方法如果指定了 foreach 参数,那么会执行 N 次 SQL 的 select 操作,并把结果放到数组里返回。所以如果 DAO 的 select 方法是 foreach 的,它的返回值在 protocol 里一定要定义成 NSArray*

insert, update, delete

  1. <insert id="addMessages" arguments="messages" foreach="messages.model">
  2. insert or replace into ${T} (id, content, uin, read) values(#{model.msgId}, #{model.content}, #{model.uin}, #{model.read})
  3. </insert>
  4. <update id="createTable">
  5. <step>
  6. create table if not exists ${T} (id integer primary key, content text, uin integer, read boolean)
  7. </step>
  8. <step>
  9. create index if not exists uin_idx on ${T} (uin)
  10. </step>
  11. </update>
  12. <delete id="remove" arguments="msgId">
  13. delete from ${T} where msgId = #{msgId}
  14. </delete>
  • insert、update、delete 方法格式相同,参数的拼接与引用和 select 方法相同。
  • insert 和 delete 关键字是为了更好的区分方法用途。你完全可以把一个 delete from table 的操作写在 update 函数中。
  • 在 DAO 接口中,需要执行 insert、update 或 delete 的方法,返回值为 APDAOResult*,标识执行是否成功。

@foreach

  • 当 insert、update、delete 方法后面有’foreach’字段时,这个方法被调用时,会依次对参数数组里的每个元素执行一次 sql。
  • 要求 foreach 字段遵循格式: collectionName.item。其中 collectionName 必须对应 arguments 里的一个参数,指定循环的容器对象,并且调用时必须为一个 NSArray 或 NSSet 类型; item 表示从容器里取出的对象,用作循环变量。不能和 arguments 里的任何参数重名,这个 item 可以当作一个普通参数用在 sql 语句里。

例如代理方法为:

  1. - (void)addMessages:(NSArray*)messages;

messages 为 MessageModel 数组,那么对于 messages 里的每个 model,都会执行一次 sql 调用,这样就能实现把数组里的元素一次性插入数据库而上层不需要关心循环的调用。底层会把这次操作合并为一个事务而提升效率。

step

  1. <upgrade toVersion='3.2'>
  2. <step resumable="true">alter table ${T} add column1 text</step>
  3. <step resumable="true">alter table ${T} add column2 text</step>
  4. </upgrade>
  • 在 insert, update, delete, upgrade 方法里,可能遇到这种情况:执行一个 DAO 方法,但是需要调用多次 sql update 操作执行多条 sql 语句。比如用户建表后,又要创建一些索引。在函数里包裹的语句,都会当作一次 sql update 被单独执行,底层会把所有操作合并为一次事务。比如上面的 createTable 方法。
  • 如果一个函数里面有 step 了,那么在 step 外面不允许有文本了。step 内不能再含其它 step。

@resumable

  • 当这条 step 语句生成的 SQL 执行失败时,是否继续执行下面的语句。无此参数默认为 false。也就是顺序执行 step,当发生失败的情况,整个 DAO 方法认为失败。

map

  1. <map id="messageModelMap" result="MessageModel">
  2. <result property="msgId" column="id"/>
  3. </map>
  • 定义一个名为 messageModelMap 的映射,实际生成的 Objective-C 对象是 MessageModel 类。
  • Objective-C 对象的 msgId 属性,对应表里名为 id 的列值;未列的属性认为和表的列名相同,可以省略。

upgrade

  1. <upgrade toVersion="1.1">
  2. <step>
  3. alter table...
  4. </step>
  5. <step>
  6. alter table...
  7. </step>
  8. </upgrade>
  • 随着版本升级,数据库可能有升级需求;处理升级的 sql 语句写在这里。比如最初,配置文件 module 的版本是 1.0,升级后,配置文件的版本为 1.1。那么新版本第一次运行 DAO 方法时,会检测当前表的版本与配置文件的版本,当发现不一致时,会依次执行升级方法。这个方法会由底层自动调用,并在升级完成后再执行 DAO 方法。
  • upgrade 按照 sql update 来执行,如果 sql 不止一个,可以用括起来,类似的实现。
  • 如果需要使用 upgrade 块定义的操作来升级表,那么 module 里的 resetOnUpgrade 必须设置为 false。

crypt

  1. <crypt class="MessageModel" property="content"/>
  • 描述 class 这个类的 property 属性进行加密处理,当向数据库写入时从这个属性里取出的值会进行加密;当数据库读出时,生成对象向这个属性里赋值会先解密再赋值。

比如执行 DAO 方法,model 是 MessageModel 类。因为取了 model 的 content 属性,所以会加密后再写入数据库。

  1. <insert id="insertMessage" arguments="model">
  2. insert into ${T} (content) values(#{model.content})
  3. </insert>

执行这个 select 方法时,返回对象是 MessageModel 类。底层从数据库里取出数据向 MessageModel 的实例写入 content 属性时,会将数据先解密再写入。最后返回处理好的 MessageModel 对象。

  1. <select id="getMessage" arguments="msgId" result="MessageModel">
  2. select * from ${T} where msgId = #{msgId}
  3. </select>

加密方式的设置方法定义在 APDAOProtocol 中,如下

  1. /**
  2. * 设置加密器,用于加密表里标记为需要加密的列的数据。向表里写数据时,碰到这个列,会调用进行加密。
  3. *
  4. * @param crypt 加密结构体,会被拷贝一份。如果传入的 crypt 是外部创建的,需要外部进行 free。如果是 APDefaultEncrypt(),不需要进行释放。
  5. */
  6. - (void)setEncryptMethod:(APDataCrypt*)crypt;
  7. /**
  8. * 设置解密器,用于解密表里标记为需要加密的列的数据。从表里读数据时,碰到这个列,会调用进行解密。
  9. *
  10. * @param crypt 解密结构体,会被拷贝一份。如果传入的 crypt 是外部创建的,需要外部进行 free。如果是 APDefaultDecrypt(),不需要进行释放。
  11. */
  12. - (void)setDecryptMethod:(APDataCrypt*)crypt;

如果不进行设置,会使用 APDataCenter 的默认加密,见 KV 存储。如果一个 DAO 代理对象是 id,并且 DAOProtocol 是@protocol,那么可以直接用 DAO 代理对象调用 setEncryptMethod 和 setDecryptMethod 来设置加密、解密方法。

if

  1. <insert id="addMessages" arguments="messages, onlyRead" foreach="messages.model">
  2. <if true="model.read or (not onlyRead)">
  3. insert or replace into ${T} (msgId, content, read) values(#{model.msgId}, #{model.content}, #{model.read})
  4. </if>
  5. </insert>
  • 在 insert、update、delete、select 方法里,可以嵌套使用 if 条件判断语句。当 if 条件满足时,会把 if 块内的文本拼接到最终的 sql 语句里。
  • if 后可以接 true=”expr”,也可以接 flase=”expr”; expr 为表达式,可以使用方法的参数,并且可以使用”.”来链式访问参数对象的属性。
  • 表达式支持的运算符如下:

    ():括号

    +:正号

    -:负号

    +:加号

    -:减号

    *:乘号

    /:除号

    \:整除

    %:取模

    >:大于

    <:小于

    >=:大于等于

    <=:小于等于

    ==:等于

    !=:不等于

    and:逻辑与,不区分大小写

    or:逻辑或,不区分大小写

    not:逻辑非,不区分大小写

    xor:异或,不区分大小写

  • 大于号、小于号字符需要使用转义。
  • 里面的参数就是外部调用传入的参数名,但是不要像 sql 块里使用#{}或@{}包裹。
  • nil 含义同Objective-C 里的 nil。
  • 表达式里的字符串使用单引号起止,不支持转义字符,但是支持\’代表一个单引号。
  • 当参数为 Objective-C 对象时,支持用’.’来访问它的属性,比如上面例子 model.read,如果参数是数组或字典,可以用’参数名.count’取元素数。

一个较复杂的表达式如下:

  1. <if true="(title != nil and year > 2010) or authors.count >= 2">

title,year,authors 都是调用者传来的参数,调用时 title 是可以传 nil 的;那么上面含义为”当书名不为空,并且出版年份大于 2010 年,或作者数大于 2”

choose

  1. <choose>
  2. <when true="title != nil">
  3. AND title like #{title}
  4. </when>
  5. <when true="author != nil and author.name != nil">
  6. AND author_name like #{author.name}
  7. </when>
  8. <otherwise>
  9. AND featured = 1
  10. </otherwise>
  11. </choose>
  • 实现类似 switch 的语法,表达式要求类似 if 语句; when 后面也可以接 true=”expr”或 false=”expr”。
  • 只会执行第一个符合条件的 when 或者 otherwise;可以没有 otherwise。

foreach

  1. <foreach item="iterator" collection="list" open="(" separator="," close=")" reverse="yes">
  2. @{iterator}
  3. </foreach>
  • open,separator,close,reverse 可以省略。
  • item 表示循环变量,collection 表示循环数组参数名。

比如一个方法从外部接收字符串数组参数,list 内容为@[@”1”, @”2”, @”3”],有另一个参数是 prefix=@”abc”,使用’()’包裹,’,’分隔。那么执行结果为:(abc1,abc2,abc3)

  1. <update id="proc" arguments="list, prefix">
  2. <foreach item="iterator" collection="list" open="(" separator="," close=")">
  3. {prefix}{iterator}
  4. </foreach>
  5. </update>

foreach 语句通常用于拼接 select 语句里的 in 块,比如:

  1. select * from ${T} where id in
  2. <foreach item="id" collection="idList" open="(" separator="," close=")">
  3. #{id}
  4. </foreach>

where, set, trim

  1. <where onVoid="quit">
  2. <if true="state != nil">
  3. state = #{state}
  4. </if>
  5. <if true="title != nil">
  6. AND title like #{title}
  7. </if>
  8. <if true="author != nil and author.name != nil">
  9. AND author_name like #{author.name}
  10. </if>
  11. </where>

where 会处理多余的 AND、OR(大小写无所谓),并在任何条件都不符合时连where 都不返回。用于在 sql 语句里拼接有大量判断条件的 where 子句。比如上例,如果只有最后一个判断成立,该语句会正确返回 where author_name like XXX,而不是 where AND author_name like XXX。

  1. <set>
  2. <if false="username != nil">username=#{username},</if>
  3. <if false="password != nil">password=#{password},</if>
  4. <if true="email != nil">email=#{email},</if>
  5. <if true="bio != nil">bio=#{bio},</if>
  6. </set>

set 会处理结尾多余的’,’,并在任何条件都不符合时什么都不返回。与 where 语句类似,只是它处理的是后缀的逗号。

  1. <trim prefix="WHERE" prefixOverrides="AND | OR | and | or " onVoid="ignoreAfter">
  2. </trim>
  3. <!--
  4. 等价于<where>
  5. -->
  6. <trim prefix="SET" suffixOverrides=",">
  7. </trim>
  8. <!--
  9. 等价于<set>
  10. -->
  • where 和 set 语句可以使用 trim 替换。Trim 语句定义了语句的整体前缀,以及对每个子句需要处理的多余的前缀与后缀列表(用|划分)。

  • onVoid 参数可以出现在 where、set、trim 里,有两个取值”ignoreAfter”和”quit”。分别代表当这个 trim 语句里任何子句都不成立,导致生成一个空串时,采取什么逻辑。ignoreAfter 代码忽略下面的格式化语句,直接返回当前生成的 sql 语句执行,quit 代表不再执行这条 sql 语句,但会返回成功。

sql

  1. <sql id="userColumns"> id,username,password </sql>
  2. <select id="selectUsers" result="{}">
  3. select ${userColumns}
  4. from some_table
  5. where id = #{id}
  6. </select>

定义可重用的 sql 代码段,在其它语句中使用${name}来原文引入进来。name 不能为’T’或’t’,因为${T}和${t}代表默认的表名了。sql 块里面可以再引用别的 sql 块。

try except

  1. <insert id="insertTemplates" arguments="templates" foreach="templates.model">
  2. <try>
  3. insert into ${T} (tplId, tplVersion, time, data, tag) values(%{'#{model.*}', tplId, tplVersion, time, data, tag})
  4. <except>
  5. update ${T} set %{'* = #{model.*}', data, tag} where tplId = #{model.tplId} and tplVersion = #{model.tplVersion}
  6. </except>
  7. </try>
  8. </insert>

有时,同一个 model 可能多次插入数据库,用 insert or replace 会导致当 model 主键冲突(同主键的 model 已经在数据库存在)时,原先的数据被删除掉,重新 insert。这样会导致同条数据的 rowid 发生变化。用 try except 语句块可以解决这个问题(当然不仅限于解决这种问题)。try except 只能出现在 DAO Method 定义里,前后不能再有其它语句。try 和 except 里面可以包含其它语句块。

当这条 DAO 方法执行时,如果 try 里面的语句执行失败,会自动尝试执行 except 里的语句。如果都失败,这次 DAO 调用才会返回失败。

引用方式

@ 引用

@{something},用于方法参数,参数名为 something,在格式化 sql 语句时会把对象内容拼到 sql 语句中;因为参数都为 id 类型,所以默认使用[NSString stirngWithFormat:@”%@”, id]来格式化;@{something or “”}这种格式,表示传入的参数如果为 nil,会转成一个空字符串而不是 NULL。

不建议使用@{}的方式来引用参数,效率比较低,有 SQL 注入风险。如果参数对象是个 NSString,拼接进去后,会自动添加引号将字符串括起来,保证 SQL 语句格式的正确性。如果用户在配置文件里自己写了引号,底层不会自动添加引号了。

使用@{something no “”},这种格式,可以强制不添加引号。

  1. <select id="getMessage" arguments="id" result="[MessageModel]">
  2. select * from ${T} where id = @{id}
  3. </select>

比如上例,id 参数传进来是个 NSString,上面的写法是正确的,生成的 SQL 会自动把 id 格式化进去,并且在前后添加引号。

# 引用

#{something},用于方法参数,参数名为 something,在格式化 sql 语句时会转为一个’?’,然后将对象绑定给 sqlite;建议书写 sql 时尽量使用这种方式,效率更高。 #{something or “”}这种格式,表示传入的参数如果为 nil,会转成一个空字符串而不是 NULL。

$ 引用

${something},用来引用配置文件里的内容,比如引用默认表名${T}或${t}、引用配置文件里定义的常量和 sql 代码块。

链式访问

对于@和#引用,可以使用’.’来访问参数对象的属性。比如传入的参数名是 model,并且是一个 MessageModel 类型,它有属性 NSString* content。那么@{model.content},会取出其 content 属性的值。内部实现为[NSObject valueForKey:],所以如果参数是一个字典(字典的 valueForKey 等价于 dict[@””]),那么也可以使用#{adict.aaa}引用 adict[@”aaa”]值。

代理方法

每个生成的 DAO 对象代理对象都支持 APDAOProtocol。

  1. @protocol MyDAOOperations <APDAOProtocol>
  2. - (APDAOResult*)insertMessage:(MyMessageModel*)model;
  3. @end

具体方法见代码的函数注释。

  1. #import <Foundation/Foundation.h>
  2. #import <sqlite3.h>
  3. #import "APDataCrypt.h"
  4. #import "APDAOResult.h"
  5. #import "APDAOTransaction.h"
  6. @protocol APDAOProtocol;
  7. typedef NS_ENUM (NSUInteger, APDAOProxyEventType)
  8. {
  9. APDAOProxyEventShouldUpgrade = 0, // 即将升级
  10. APDAOProxyEventUpgradeFailed, // 表升级失败
  11. APDAOProxyEventTableCreated, // 表被创建
  12. APDAOProxyEventTableDeleted, // 表被删除
  13. };
  14. typedef void(^ APDAOProxyEventHandler)(id<APDAOProtocol> proxy, APDAOProxyEventType eventType, NSDictionary* arguments);
  15. /**
  16. * 这个 Protocol 定义的方法每个 DAO 代理对象都支持,使用时使用 id<APDAOProtocol>对 DAO 对象进行转换。
  17. */
  18. @protocol APDAOProtocol <NSObject>
  19. /**
  20. * 配置文件里 module 可以设置表名,如果想实现配置文件作为一个模板,操作不同的表,可以生成 DAO 对象后手工向 DAO 对象设计表名。
  21. * 比如要对与每个 id 的对话消息进行分表的情况。
  22. */
  23. @property (atomic, strong) NSString* tableName;
  24. /**
  25. * 返回这个 proxy 操作的表所在数据库文件的路径
  26. */
  27. @property (atomic, strong, readonly) NSString* databasePath;
  28. /**
  29. * 获取这个 proxy 操作的数据库文件的句柄
  30. */
  31. @property (atomic, assign, readonly) sqlite3* sqliteHandle;
  32. /**
  33. * 注册全局变量参数,这些参数配置文件里的所有方法都可以使用,在配置文件里使用#{name}和@{name}来访问。
  34. */
  35. @property (atomic, strong) NSDictionary* globalArguments;
  36. /**
  37. * 这个 proxy 的事件回调,业务自行设置。回调线程不确定。
  38. 注意循环引用的问题,业务对象持有 proxy,这个 handler 方法里不要访问业务对象或 proxy,proxy 可以在回调的第一个参数里拿到。
  39. */
  40. @property (atomic, copy) APDAOProxyEventHandler proxyEventHandler;
  41. /**
  42. * 设置加密器,用于加密表里标记为需要加密的列的数据。向表里写数据时,碰到这个列,会调用进行加密。
  43. *
  44. * @param crypt 加密结构体,会被拷贝一份。如果传入的 crypt 是外部创建的,需要外部进行 free。如果是 APDefaultEncrypt(),不需要进行释放。
  45. */
  46. @property (atomic, assign) APDataCrypt* encryptMethod;
  47. /**
  48. * 设置解密器,用于解密表里标记为需要加密的列的数据。从表里读数据时,碰到这个列,会调用进行解密。
  49. *
  50. * @param crypt 解密结构体,会被拷贝一份。如果传入的 crypt 是外部创建的,需要外部进行 free。如果是 APDefaultDecrypt(),不需要进行释放。
  51. */
  52. @property (atomic, assign) APDataCrypt* decryptMethod;
  53. /**
  54. * 返回 sqlite 的最后一条 rowId
  55. *
  56. * @return sqlite3_last_insert_rowid()
  57. */
  58. - (long long)lastInsertRowId;
  59. /**
  60. * 获取配置文件定义的所有方法列表
  61. */
  62. - (NSArray*)allMethodsList;
  63. /**
  64. * 删除配置文件里定义的表,可以用于特殊情况下的数据还原。删除表后,DAO 对象仍可以正常使用,再次调用其它方法,会重新创建表。
  65. */
  66. - (APDAOResult*)deleteTable;
  67. /**
  68. * 删除符合某个正则规则的所有表,请确保只删除本 Proxy 操作的表,否则可能发生异常
  69. *
  70. * @param pattern 正则表达式
  71. * @param autovacuum 删除完成是否自动调用 vacuum 清理数据库空间
  72. * @param progress 进度回调,可传 nil,回调不保证主线程。为百分之后的结果
  73. *
  74. * @return 操作是否成功
  75. */
  76. - (APDAOResult*)deleteTablesWithRegex:(NSString*)pattern autovacuum:(BOOL)autovacuum progress:(void(^)(float progress))progress;
  77. /**
  78. * 调用自己的数据库链接执行 vacuum 操作
  79. */
  80. - (void)vacuumDatabase;
  81. /**
  82. * DAO 对象可以自己把操作放在事务里提升速度,实际调用的是该 DAO 对象操作的数据库文件 APSharedPreferences 的 daoTransaction 方法。
  83. */
  84. - (APDAOResult*)daoTransaction:(APDAOTransaction)transaction;
  85. /**
  86. * 创建一个数据库副连接,为接下来可能发生的并发select 操作加速使用。可以调用多次,创建多个数据库连接待用。
  87. * 这些创建的链接会自动关闭,业务层无须处理。
  88. * @param autoclose 在空闲状态多少秒后自动关闭,0 表示使用系统值
  89. */
  90. - (void)prepareParallelConnection:(NSTimeInterval)autoclose;
  91. @end