WCDB
英文版本请参看这里
WCDB是一个高效、完整、易用的移动数据库框架,已应用于微信。它基于SQLite和SQLCipher,支持五种语言:C++、Java、Kotlin、Swift和Objective-C。
特性
易用性
- ORM(对象关系映射):WCDB提供了灵活易用的ORM,用于创建表、索引和约束,以及通过C++/Java/Kotlin/Swift/Objc对象进行CRUD操作。
- WINQ(WCDB语言集成查询):WINQ是一种原生数据查询能力,让开发者无需编写胶水代码来拼接SQL查询字符串。
借助ORM和WINQ,你可以用一行代码实现对象的插入、更新、查询和删除:
// C++
database.insertObjects<Sample>(Sample(1, "text"), myTable);
database.updateRow("text2", WCDB_FIELD(Sample::content), myTable, WCDB_FIELD(Sample::id) == 1);
auto objects = database.getAllObjects<Sample>(myTable, WCDB_FIELD(Sample::id) > 0);
database.deleteObjects(myTable, WCDB_FIELD(Sample::id) == 1);
// Java
database.insertObject(new Sample(1, "text"), DBSample.allFields(), myTable);
database.updateValue("text2", DBSample.content, myTable, DBSample.id.eq(1));
List<Sample> objects = database.getAllObjects(DBSample.allFields(), myTable, DBSample.id.gt(0));
database.deleteObjects(myTable, DBSample.id.eq(1));
// Kotlin
database.insertObject<Sample>(Sample(1, "text"), DBSample.allFields(), myTable)
database.updateValue("text2", DBSample.content, myTable, DBSample.id.eq(1))
val objects = database.getAllObjects<Sample>(DBSample.allFields(), myTable, DBSample.id.gt(0))
database.deleteObjects(myTable, DBSample.id.eq(1))
// Swift
try database.insert(Sample(id:1, content:"text"), intoTable: myTable)
try database.update(table: myTable,
on: Sample.Properties.content,
with: "text2"
where:Sample.Properties.id == 1)
let objects: [Sample] = try database.getObjects(fromTable: myTable,
where: Sample.Properties.id > 0)
try database.delete(fromTable: myTable where: Sample.Properties.id == 1)
// Objc
[database insertObject:sample intoTable:myTable];
[database updateTable:myTable
setProperty:Sample.content
toValue:@"text2"
where:Sample.id == 1];
NSArray* objects = [database getObjectsOfClass:Sample.class
fromTable:myTable
where:Sample.id > 0];
[database deleteFromTable:myTable where:Sample.id == 1];
高效性
通过框架层和sqlcipher源码优化,WCDB具有更高效的性能。
- 多线程并发:WCDB通过连接池支持并发的读读和读写访问。
- 深度优化:WCDB对SQLite的源码和配置进行了深度优化,以适应移动端的开发场景。同时,WCDB还针对常见的耗时场景进行了优化,如批量写入数据。
完整性
WCDB总结了实践中的常见问题,为数据库开发提供更完整的开发体验:
- 加密支持:WCDB通过SQLCipher支持数据库加密。
- 损坏恢复:WCDB提供内置修复工具包用于数据库损坏恢复。
- 防注入:WCDB提供内置保护,防止SQL注入。
- 数据库模型升级:数据库模型与类定义绑定,使得数据库字段的增删改与类变量的定义保持一致。
- 全文搜索:WCDB提供易用的全文搜索接口,并包含多种语言的分词器。
- 数据迁移:WCDB支持通过简单配置将数据从一个数据库迁移到另一个数据库。开发者无需关心迁移的中间状态和进度。
- 数据压缩:WCDB支持通过简单配置,使用Zstd对数据库表中特定字段的内容进行压缩。一旦配置完成,数据压缩和解压缩的细节对开发者来说是透明的,WCDB可以自动压缩现有数据。
兼容性
WCDB拥有五种语言的接口:C++、Java、Kotlin、Swift和Objc。不同语言的接口共享相同的底层逻辑。WCDB的代码结构如下图所示:
在这种架构下,不同语言的WCDB可以拥有相同的接口结构和接口能力。在一个项目中,你可以使用一个WCDB用不同语言编写数据库代码。不同语言的数据库逻辑不会冲突。一些全局接口,如错误监控,可以同时作用于不同语言的数据库逻辑。
构建和安装
以下wiki包含了关于WCDB构建和安装的详细说明。
教程
不同语言的教程可以在以下链接找到:
贡献
如果你有兴趣贡献代码,请查看 [CONTRIBUTING.md],也可以加入我们的腾讯开源计划。
信息公示
-
开发者: 深圳市腾讯计算机系统有限公司