肇鑫的技术博客

业精于勤，荒于嬉

开发者备份和恢复Realm数据库

最近在研究带参数的捷径。因为是SiriKit相关，需要把Realm放在应用组里。这样就不能通过Xcode下载容器了。几天时间里，已经有了两次不小心删除掉数据库，而不得不通过备份恢复手机的经历。我开始研究一下如何导出和恢复数据。

思路

因为目的只是为了方便开发，而不是交给用户操作，过程简便，代码容易是重点。

首先想到的是通过长按某个按钮实现导出，然后出了问题就将导出的数据库放在应用里，应用启动时检测是否有数据，如果有，就替换，然后再正常启动。

实现

具体实现的时候，遇到了一个问题，分享出来的URL，并没有写成文件，而是写成了纯文本。

@objc private func exportRealm(_ sender:Any) {
    let sourceURL = Realm.Configuration.defaultConfiguration.fileURL!
    
    // copy realm to cache and rename it to current date and time
    let fm = FileManager.default
    let filename = { () -> String in
        let df = DateFormatter()
        df.dateFormat = "yyyy.MM.dd_HH.mm.ss"
        return "any_counter_2.backup.at.\(df.string(from: Date())).realm"
    }()
    let cacheFolderURL = fm.urls(for: .cachesDirectory, in: .userDomainMask).first!
    let destinationURL = URL(fileURLWithPath: filename, isDirectory: false, relativeTo: cacheFolderURL)
    
    do {
        try fm.copyItem(at: sourceURL, to: destinationURL)
    } catch {
        return
    }

    // export
    let activityViewController = UIActivityViewController(activityItems: [destinationURL], applicationActivities: nil)
    activityViewController.completionWithItemsHandler = { (_, isCompleted, _, activityError) -> Void in
        guard activityError == nil || (activityError! as NSError).code == 3072 else { // Error Domain=NSCocoaErrorDomain Code=3072 \"操作已被取消。\"
            fatalError("\(activityError!)")
        }

        // clear cache after success
        try? fm.removeItem(at: destinationURL)
    }
    present(activityViewController, animated: true, completion: nil)
}

这个问题花费了我不少时间去寻找解决方案。最后我突发奇想解决了。实际上，就是和URL有关。将12行

let destinationURL = URL(fileURLWithPath: filename, isDirectory: false, relativeTo: cacheFolderURL)

替换为

let destinationURL = URL(fileURLWithPath: cacheFolderURL.path + "/" + filename, isDirectory: false)

，问题解决。

类似的事情很早就遇到过，比如

import Foundation

let folder = "/foo"
let file = "bar"

let folderURL = URL(fileURLWithPath: folder, isDirectory: true)
let u1 = URL(fileURLWithPath: file, isDirectory: false, relativeTo: folderURL)
print(u1.path) // /foo/bar

let u2 = URL(fileURLWithPath: folder + "/" + file, isDirectory: false)
print(u2.path) // /foo/bar

print(u1 == u2) // false
print(u1.path == u2.path) // true

即两个path相同的URL，仅仅是因为构造方法的不同，它们就不相等。这其实是很不直观的，人们在没遇到之前，可能就会认为path相等的两个URL就是相等的，但是实际上系统认为不是。

这里也是这样，通过relativeTo构造的URL，iOS系统仅能将它存成一个纯文本。但是直接构造的URL就没有这个问题。

我虽然不认同，但是只能记住。

Realm的坑（四）

之前的三个坑都是很久远的事情了。今天要填一个新坑。

我们知道，Realm.objects(_)返回的值是Results<T>，由于Realm自身的特性，Results<T>是很有用的，它是lazy和动态的。因此，在使用Realm的时候，我们更喜欢使用Results<T>而不是Array。

但是Results<T>有一个问题，就是它的排序功能十分有限。它最基本的排序只有一个函数，即sorted(byKeyPath:ascending:)。也就是说，Results<T>只能按照Realm对象的动态属性排序，而不能使用我们经常用到的closure排序。

分析

这就使得我们在有些时候，为了排序的方便，要么增加磁盘占用，添加额外的动态属性；要么，就只能使用Array类型。

值得一提的是，有时，如果是涉及到当前时间这一类的排序变量，即便我们使用额外的动态属性，也是不能排序的。因为这个值一直在变。因此就只能使用Array类型。

didSet不执行的问题

特别的，我们需要注意，在Realm的动态属性中，didSet是不会执行的，这应该是和Objective-C的运行时相关。因此，如果需要使用didSet，就需要改成其它的方式。

参考资料

相关

Realm模型升级（二）

Realm模型升级（一）中讲了对象添加了新属性之后要如何升级。最近我又遇到了新的问题，要将对象改名。

新问题

因为业务的需要，必须将代码

class Item:Object {
    static let calendar = Calendar(identifier: .gregorian)
    
    @objc dynamic var title = ""
    @objc dynamic var addedDate:Date = Date()
    @objc dynamic var relatedItem:Item? = nil
    let records = List<Record>()
    
    override class func primaryKey() -> String? {
        return "title"
    }
}

class Record:Object {
    static let dateFormatter:DateFormatter = {
        let df = DateFormatter()
        df.locale = Locale(identifier: "zh")
        df.dateStyle = .medium
        df.timeStyle = .none
        
        return df
    }()
    
    @objc dynamic var id:Int = 1
    @objc dynamic var addedDate:Date = Date()
}

更改为

class ACItem:Object {
    static let calendar = Calendar(identifier: .gregorian)
    
    @objc dynamic var title = ""
    @objc dynamic var addedDate:Date = Date()
    @objc dynamic var relatedItem:ACItem? = nil
    let records = List<ACRecord>()
    
    override class func primaryKey() -> String? {
        return "title"
    }
}

class ACRecord:Object {
    static let dateFormatter:DateFormatter = {
        let df = DateFormatter()
        df.locale = Locale(identifier: "zh")
        df.dateStyle = .medium
        df.timeStyle = .none
        
        return df
    }()
    
    @objc dynamic var id:Int = 1
    @objc dynamic var addedDate:Date = Date()
}

即原来的类的名称之前，需要添加AC字样。更改了代码之后运行，发现数据不见了。

分析

打开数据库文件查看（如图）。原来，虽然代码中的类变了，但是数据库中的类还是原来的名字，需要手动迁移。

realm database

解决方案

23-39行，利用之前的Item对象，生成ACItem对象；利用Item对象中的records属性，生成ACRecord对象。需要注意的事，因为代码中此时已经没有了Item类和Record类，我们没法使用Item.className()，而只能直接使用"Item"。

41-43行，删除掉旧数据。

let config:Realm.Configuration = {
    // update realm
    let config = Realm.Configuration(
        fileURL: destinationURL,
        
        // Set the new schema version. This must be greater than the previously used
        // version (if you've never set a schema version before, the version is 0).
        schemaVersion: 3,
        
        // Set the block which will be called automatically when opening a Realm with
        // a schema version lower than the one set above
        migrationBlock: { migration, oldSchemaVersion in
            // We haven’t migrated anything yet, so oldSchemaVersion == 0
            if (oldSchemaVersion < 1) {
                // Nothing to do!
            }
            
            if (oldSchemaVersion < 2) {
                // Nothing to do!
            }
            
            if (oldSchemaVersion < 3) {
                migration.enumerateObjects(ofType: "Item") { (oldObject, _) in
                    let acItem = migration.create(ACItem.className())
                    acItem["title"] = oldObject!["title"]
                    acItem["addedDate"] = oldObject!["addedDate"]
                    
                    guard let list = acItem["records"] as? List<MigrationObject>,
                        let oldList = oldObject!["records"] as? List<MigrationObject> else {
                        fatalError()
                    }
                    
                    oldList.forEach { o in
                        let acRecord = migration.create(ACRecord.className())
                        acRecord["id"] = o["id"]
                        acRecord["addedDate"] = o["addedDate"]
                        list.append(acRecord)
                    }
                }
                
                // delete
                migration.deleteData(forType: "Item")
                migration.deleteData(forType: "Record")
            }
    })
    
    return config
}()

总结

  1. 代码中对象的改名，意味着数据库中数据的迁移。
  2. MigrationObjectEnumerateBlock中的oldObject，实际上一个词典，我们通过键来进行数据的查找。