WCDB.objc 2.1.6

WCDB.objc 2.1.6

qiuwenchen 维护。



WCDB.objc 2.1.6

  • 作者:
  • Qiuwen-Chen

WCDB

PRs Welcome Release Version WeChat Approved iOS WeChat Approved Android Platform

中文版本请参看这里

WCDB 是一个高效、完整、易于使用的移动数据库框架,用于微信应用程序。它基于 SQLite 和 SQLCipher,支持 C++、Swift 和 Objective-C 三种语言。

功能

易于使用

  • ORM (对象关系映射): WCDB 提供了一个灵活、易于使用的 ORM,用于创建表、索引和约束,并通过 C++/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);
// 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][sqlcipher]进行数据库加密。
  • 损坏恢复:WCDB提供内置的数据库损坏恢复工具。
  • 反注入攻击:WCDB提供内置的SQL注入攻击防护。
  • 数据库模型升级:数据库模型与类定义绑定,因此数据库字段的添加、删除和修改与类变量的定义保持一致。
  • 全文搜索:WCDB提供易于使用的全文搜索接口,并包含多种语言的分词器。
  • 数据迁移:WCDB支持通过简单配置将数据从数据库之一迁移到另一个数据库。并且开发者无需关注迁移的中间状态和进度。

兼容性

WCDB支持三种语言的接口:C++、Swift和Objc。不同语言的接口共享相同的底层逻辑。WCDB的代码结构如图所示

在这种架构下,不同语言的WCDB可以拥有相同的接口结构和接口能力。在一个项目中,您可以使用同一个WCDB用不同语言编写数据库代码。不同语言中的数据库逻辑不会发生冲突。一些全局接口,如错误监控,可以同时在不同语言的数据库逻辑上工作。

我们将在不久的将来为WCDB添加更多的语言支持,例如 JavaKotlinFlutter,以便WCDB可以应用于更多平台。

构建和安装

以下说明包含了构建和安装WCDB的详细说明。

教程

不同语言的教程如下

贡献

如果您有兴趣贡献,请查看[CONTRIBUTING.md],也可以加入我们的腾讯开源计划