WCDB 的最基础的调用过程大致分为三个步骤:
- 模型绑定
- 创建数据库与表
- 操作数据
模型绑定
WCDB 基于 Swift 4.0 的 Codable
协议实现模型绑定的过程。
对于已经存在的 Sample
类:
- class Sample {
- var identifier: Int? = nil
- var description: String? = nil
- }
可通过以下代码将 Sample
类的 identifier
和 description
两个变量绑定到了表中同名字段:
- class Sample: TableCodable {
- var identifier: Int? = nil
- var description: String? = nil
- enum CodingKeys: String, CodingTableKey {
- typealias Root = Sample
- static let objectRelationalMapping = TableBinding(CodingKeys.self)
- case identifier
- case description
- }
- }
这部分代码基本都是固定模版,暂时不用理解其每一句的具体含义,我们会在模型绑定一章中进行进一步介绍。
创建数据库与表
One line of code 是 WCDB 接口设计的一个基本原则,绝大部分的便捷接口都可以通过一行代码完成。
创建数据库对象
- let database = Database(withPath: "~/Intermediate/Directories/Will/Be/Created/sample.db")
WCDB 会在创建数据库文件的同时,创建路径中所有未创建文件夹。
创建数据库表
- // 以下代码等效于 SQL:CREATE TABLE IF NOT EXISTS sampleTable(identifier INTEGER, description TEXT)
- try database.create(table: "sampleTable", of: Sample.self)
对于已进行模型绑定的类,同样只需一行代码完成。
操作数据
基本的增删查改同样是 One line of code
插入操作
- //Prepare data
- let object = Sample()
- object.identifier = 1
- object.description = "sample_insert"
- //Insert
- try database.insert(objects: object, intoTable: "sampleTable")
查找操作
- let objects: [Sample] = try database.getObjects(fromTable: "sampleTable")
更新操作
- //Prepare data
- let object = Sample()
- object.description = "sample_update"
- //Update
- try database.update(table: "sampleTable",
- on: Sample.Properties.description,
- with: object,
- where: Sample.Properties.identifier > 0)
类似Sample.Properties.identifier > 0
的语法是 WCDB 的特性,它能通过 Swift 语法来进行 SQL 操作,我们将在语言集成查询一章中进行进一步的介绍。
删除操作
- try database.delete(fromTable: "sampleTable")
更多教程
本章简单介绍了 WCDB Swift 进行操作的过程,并展示了基本的用法。后续将对里面的逐个细节进行详细介绍。建议按照顺序阅读基础教程部分,而进阶教程则可以按照个人需求选择阅读。