Unrealm 开源项目教程

Unrealm 开源项目教程

Unrealm Unrealm is an extension on RealmCocoa, which enables Swift native types to be saved in Realm. 项目地址: https://gitcode.com/gh_mirrors/un/Unrealm

1. 项目介绍

Unrealm 是一个基于 RealmCocoa 的扩展，旨在使 Swift 原生类型（如类、结构体和枚举）能够存储在 Realm 数据库中。通过使用 Unrealm，开发者可以避免继承 Realm 的 Object 类，转而采用面向协议的编程方式。这不仅简化了代码，还减少了 Realm 数据库使用过程中常见的崩溃问题，如“对象已被删除或无效”和“Realm 访问了错误的线程”。

Unrealm 支持以下 Swift 类型：

• Swift 基本类型
• Swift 结构体
• Swift 类
• Swift 枚举
• Swift 数组
• Swift 字典
• 嵌套类/结构体
• Swift 可选类型（String, Data, Date）
• Swift 可选基本类型（Int, Float, Double, Bool）
• Swift 可选的 Realmable 类型
• Swift 可选的数组

2. 项目快速启动

安装

使用 CocoaPods 安装

在 Podfile 中添加以下行：

pod 'Unrealm'

然后运行 pod install。

使用 Swift Package Manager 安装

在 Xcode 中，选择 File > Swift Packages > Add Package Dependency，然后输入以下 URL：

https://github.com/matghazaryan/Unrealm.git

快速启动示例

1. 定义结构体或类

   创建一个符合 Realmable 协议的结构体或类：

   import Unrealm
   
   struct ToDoItem: Realmable {
       var id: String = UUID().uuidString
       var text: String = ""
       var isCompleted: Bool = false
   }
   

2. 注册类型

   在 AppDelegate 的 didFinishLaunchingWithOptions 方法中注册类型：

   import Unrealm
   
   func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
       Realm.registerRealmables(ToDoItem.self)
       return true
   }
   

3. 存储和检索数据

   使用 Realm 存储和检索数据：

   do {
       let realm = try Realm()
       let todoItem = ToDoItem(text: "Buy groceries", isCompleted: false)
       try realm.write {
           realm.add(todoItem)
       }
   
       let todos = realm.objects(ToDoItem.self)
       for todo in todos {
           print(todo.text)
       }
   } catch {
       print("Error: \(error)")
   }
   

3. 应用案例和最佳实践

应用案例

Unrealm 适用于需要使用 Realm 数据库存储 Swift 原生类型的场景。例如，在一个待办事项应用中，可以使用 Unrealm 存储 ToDoItem 结构体，而不需要继承 Object 类。

最佳实践

1. 避免使用 @objc dynamic：Unrealm 允许你直接使用 var 或 let，避免了使用 @objc dynamic 的繁琐。
2. 使用 Realmable 协议：确保你的结构体或类符合 Realmable 协议，以便能够存储在 Realm 中。
3. 手动更新对象：由于 Unrealm 不支持“实时对象”功能，修改对象后需要手动更新到 Realm 中。

4. 典型生态项目

Unrealm 可以与其他 Swift 生态项目结合使用，例如：

• SwiftUI：在 SwiftUI 中使用 Unrealm 存储和检索数据，构建响应式应用。
• Combine：结合 Combine 框架，使用 Unrealm 进行数据绑定和响应式编程。
• Codable：Unrealm 支持 Swift 的 Codable 协议，可以轻松地将 JSON 数据转换为 Realm 对象。

通过这些生态项目的结合，Unrealm 可以进一步提升开发效率和应用性能。

Unrealm Unrealm is an extension on RealmCocoa, which enables Swift native types to be saved in Realm. 项目地址: https://gitcode.com/gh_mirrors/un/Unrealm