Realm Swift 体验 - todoList 实现
realm 介绍什么的就自己点链接到官网看就可以了,这里也不分析对比之类的了,网上相关文章不少,可以自个去看或者有空自己测试下,这里直接就说realm的应用,说下如何使用realm 来实现一个todo list的功能。
首先 demo 在这里~~~
新建一个只有一个页面的工程,使用 Swift, 还是建议大家向 Swift 上靠拢,原因不多说了。
图片.png这里直接通过pods来集成,手动集成时相对会麻烦一点, 可以看官方的说明来集成就可以了。
这里只介绍realm的入门,简单地说下关系realm的增删改查以及数据的迁移,首先我们需要创建一个保存对象的实体类:
final class Task: Object {
// realm 没有自增属性
dynamic var id = NSUUID().uuidString
dynamic var text = ""
dynamic var completed = false
// 主键
override static func primaryKey() -> String? {
return "id"
}
}
这里需要注意的是,在realm中并没有自增属性,所以不想指定主键的时候,可以在创建时给它生成一个唯一的标识,如使用 NSUUID().uuidString。
配置realm
先看事例代码:
private func setupRealm() {
let paths = NSSearchPathForDirectoriesInDomains(.documentDirectory, .userDomainMask, true)
let filePath = paths[0] + "/default.realm"
print(filePath)
var realmConfiguration = Realm.Configuration()
realmConfiguration.fileURL = URL(fileURLWithPath: filePath)
realm = try! Realm(configuration: realmConfiguration)
}
首先是设置realm的保存路径,如果本地不在该文件,则会自动创建,如果已经创建,则会使用该文件启动数据库。
增
事例代码:
alertController.addAction(UIAlertAction(title: "Add", style: .default) { _ in
guard let text = alertTextField.text , !text.isEmpty else { return }
try! self.realm.write {
let task = Task(value: ["text": text])
// 添加
self.realm.add(task)
}
})
realm中添加、删除或者更新时,都是传一个对应的对象就可以,底层的具体操作,realm已经帮我们处理了。
删
事例代码:
override func tableView(_ tableView: UITableView, commit editingStyle: UITableViewCellEditingStyle, forRowAt indexPath: IndexPath) {
if editingStyle == .delete {
try! realm.write {
let item = tasks[indexPath.row]
// 删除
self.realm.delete(item)
}
}
}
改
事例代码:
override func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
let item = tasks[indexPath.row]
if !item.completed {
try! realm.write {
let item = tasks[indexPath.row]
item.completed = !item.completed
// 更新
self.realm.add(item, update: true)
}
}
}
这里需要注意的一个地方是,实体类必须要有主键时才能执行更新的,否则是没有办法更新的,如果真的不需要主键时,就随机生成一个唯一的主键就好。
查
事例代码:
private func getTodoList() {
// 查询
tasks = realm.objects(Task.self)
// tasks = realm.objects(Task.self).filter("completed = false")
self.tableView.reloadData()
}
查询时主要过filter来设置过滤的条件,比直接写sql简单多了。关于filter的详细设置可以多读下官方的文档。
通知监听
事例代码:
var notificationToken: NotificationToken!
private func addNotification() {
notificationToken = tasks.addNotificationBlock({ (changes: RealmCollectionChange) in
switch changes {
case .initial:
self.tableView.reloadData()
break
case .update(_, deletions: _, insertions: _, modifications: _):
self.getTodoList()
break
case .error(let err):
fatalError("\(err)")
break
}
})
}
realm 提供 NotificationToken 来监听某一个实体类的相关变化,有下面三种状态:
图片.png监听什么时候初始成功,什么时候实体类被更新了,还有一个出现错误时的回调。
数据库迁移
事例代码:
// v2
//final class Task: Object {
// // realm 没有自增属性
// dynamic var id = NSUUID().uuidString
// dynamic var text = ""
// dynamic var completed = false
// dynamic var date = NSDate()
//
// override static func primaryKey() -> String? {
// return "id"
// }
//}
private func setupRealm() {
let paths = NSSearchPathForDirectoriesInDomains(.documentDirectory, .userDomainMask, true)
let filePath = paths[0] + "/default.realm"
print(filePath)
var realmConfiguration = Realm.Configuration()
realmConfiguration.fileURL = URL(fileURLWithPath: filePath)
// 用于数据库迁移
realmConfiguration.schemaVersion = 1
realmConfiguration.migrationBlock = { migration, oldSchemaVersion in
migration.enumerateObjects(ofType: Task.className()) { oldObject, newObject in
if oldSchemaVersion < 1 {
let text = oldObject!["text"] as! String
newObject!["text"] = "\(text)+\(text)"
// migration.renameProperty(onType: Task.className(), from: "text", to: "text2")
}
// if oldSchemaVersion < 2 {
// newObject!["date"] = NSDate()
// }
}
}
realm = try! Realm(configuration: realmConfiguration)
}
数据库迁移的操作应该放在设置realm上处理,schemaVersion 是数据库的版本号,将旧的版本号和新的版本号做比较,然后选择升级的操作。
使用感觉
realm比直接使用sql快捷多了,但如果想把原项目的sqlite替换掉,这里还是不太建议的,毕竟realm的实体类有自己的一套逻辑,重构的成本还是比较大的。据前人的测试,realm的性能和Core Data很接近了,而且我觉得它本身也比Core Data友好,所以说,有新项目的话,可以入坑尝试玩下。
如果觉得表达不是太清晰,可以参考下demo,我觉得,主要还是自己多动手去尝试。