您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

從 Core Data 遷移到 Realm:一份可照做的實操指南

編輯:iOS 開發基礎

投稿文章,作者:一縷殇流化隱半邊冰霜(簡書)

前言

看到標題,可能還有人不清楚 Realm 是什麼。先簡單介紹一下這個後起的資料庫——它的定位是用來替代 SQLite 和 Core Data。主要優點有幾個:

上手快。Realm 並不是建立在 SQLite 之上的 ORM,而是自帶持久化引擎,為簡單與速度而生。不少開發者反饋幾分鐘就能跑通,幾小時就能搭出一個 app,每個專案至少省下數週工時。

性能強。得益於零拷貝設計,Realm 比多數 ORM、甚至比原生 SQLite 都更快。

跨平台。Realm 支持 iOS 與 OS X(Objective-C 和 Swift)以及 Android,可以在各平台共享同一套 model 與 Realm 文件,業務邏輯也能複用。

特性完善。加密、圖形化查詢、平滑遷移等高階能力都有支持,API 適合打造高響應的應用,也提供了不少便捷組件用於構建複雜界面。

經過驗證。銀行、醫療機構、大型企業應用乃至星巴克都在使用。

社區活躍。它是 GitHub 上星標數排名第四的資料庫專案,僅次於 Java 與 Cocoa 的 repos;核心工程之外,社區還產出了上百個外掛與組件。官方團隊也會在 GitHub、StackOverflow 和 Twitter 上答覆問題。

再放三張性能對比圖:

上圖是 20 萬條數據中查詢後 count 的每秒執行次數:Realm 約為每秒 30.9 次,SQLite 為 13.6 次,Core Data 只有可憐的 1 次。

同樣在 20 萬條數據中做一次遍歷查詢,趨勢相似:Realm 一秒能遍歷 31 次,Core Data 只有 2 次,SQLite 是 14 次。

這張是單次事務每秒插入量的對比。Realm 每秒可插入 9.4 萬條記錄;在這一項上純 SQLite 表現最好,可達 17.8 萬條;封裝了 SQLite 的 FMDB 約為 Realm 的一半,4.7 萬;Core Data 更低,僅 1.8 萬。

三張圖大致說明了 Realm 的性價比。那麼第一步,就是把本地的資料庫換成 Realm。下面這篇翻譯教程,會手把手帶你完成從 Core Data 到 Realm 的遷移。

原文:Migrating an App from Core Data to Realm


1. 移除 Core Data Framework

先找出所有涉及 Core Data 的代碼——這些就是要重構的部分。幸運的是做法很樸素:全局搜索相關引用,刪掉每一處導入 Core Data 頭文件的語句。

#import  // 或 @import CoreData;

刪完之後,凡是用到 Core Data 的地方都會報編譯錯誤。接下來就是逐個消滅這些錯誤,剩下的只是時間問題。

2. 移除 Core Data 的棧設置代碼

在 Core Data 中,對 model 物件的讀寫要經過 managed object context,而 context 由 persistent store coordinator 創建,coordinator 又由 managed object model 創建。所以當你準備讀寫數據時,往往需要在 app 的某個位置把這條依賴鏈搭起來,再把方法暴露出來給業務邏輯用。無論寫在 application delegate、全局單例還是 inline 代碼裡,這部分「只需要一次」的設置代碼通常都不少。

轉到 Realm 之後,這些都可以刪掉。Realm 的所有配置在你第一次創建 Realm 物件時就完成了;當然也可以手動指定文件存儲路徑等參數,這些都能在運行時決定。

RLMRealm *defaultRealm = [RLMRealm defaultRealm]; // 或 let realm = Realm()

是不是清爽很多?

3. 遷移 model 文件

Core Data 中,持久化的類都定義為 NSManagedObject 的子類,接口比較標準;但原生類型(如 NSInteger、CGFloat)不能直接用,必須包裝成 NSNumber。

@interface Dog : NSManagedObject
@property (nonatomic, copy) NSString *name;
@property (nonatomic, strong) NSNumber *age;
@property (nonatomic, strong) NSDate *birthdate;
@end

@implementation Dog
@dynamic name;
@dynamic age;
@dynamic birthdate;
@end

轉成 Realm 非常直接:

@interface Dog : RLMObject
@property NSString *uuid;
@property NSString *name;
@property NSInteger age;
@property NSDate *birthdate;
@end

@implementation Dog
+ (NSString *)primaryKey {
    return @"uuid";
}

+ (NSDictionary *)defaultPropertyValues {
    return @{ @"uuid" : [[NSUUID UUID] UUIDString],
              @"name" : @"",
              @"birthdate" : [NSDate date]};
}
@end

或者用 Swift:

class Dog: Object {
    dynamic var uuid = NSUUID().UUIDString
    dynamic var name = ""
    dynamic var age = 0
    dynamic var birthdate = NSDate().date

    override static func primaryKey() -> String? {
        return "uuid"
    }
}

就這麼簡單。不過有幾個細節值得留意。

初次使用 Realm 的人常糾結要不要寫屬性關鍵字——其實不必,Realm 內部已經處理好了,所以頭文件看上去特別精簡。另外 Realm 原生支持 NSInteger、CGFloat 等簡單類型,那些為了 Core Data 而存在的 NSNumber 包裝都可以刪掉。

另一方面,有兩點是 Realm 特有的約定:

Core Data 用內部的 NSManagedObjectID 唯一標識物件,Realm 把這件事交給開發者。上例中我們額外加了一個 uuid 屬性,並通過 [RLMObject primaryKey] 指定它作為該類的唯一鍵。如果你的物件本來就不需要唯一標識,這一步可以跳過。

另外,Realm 目前還不支援 nil 的屬性值,所以我們在 [RLMObject defaultPropertyValues] 中為每個屬性設定了創建時的預設值。這是暫時的限制,後續版本會支援可為 nil 的屬性。

4. 遷移寫操作

不能保存數據的方案都不算方案。Core Data 中創建並修改一個物件需要這些代碼:

// 創建一個新的 Dog
Dog *newDog = [NSEntityDescription insertNewObjectForEntityForName:@"Dog" inManagedObjectContext:myContext];
newDog.name = @"McGruff";

// 保存到磁碟
NSError *saveError = nil;
[newDog.managedObjectContext save:&saveError];

// 重命名
newDog.name = @"Pluto";
[newDog.managedObjectContext save:&saveError];

Realm 的寫法略有不同,但整體結構對應得上:

// 創建 dog 物件
Dog *newDog = [[Dog alloc] init];
newDog.name = @"McGruff";

// 保存到磁碟(用 block 開事務)
RLMRealm *defaultRealm = [RLMRealm defaultRealm];
[defaultRealm transactionWithBlock:^{
    [defaultRealm addObject:newDog];
}];

// 重命名(用 open/close 方式開事務)
[defaultRealm beginWriteTransaction];
newDog.name = @"Pluto";
[defaultRealm commitWriteTransaction];

Swift 版本:

// 創建 dog 物件
let mydog = Dog()
myDog.name = "McGruff"

// 保存到磁碟(用 block 開事務)
Realm().write {
    realm.add(myDog)
}

// 重命名(用 open/close 方式開事務)
Realm().beginWrite()
myDog.name = "Pluto"
Realm().commitWrite()

數據就這樣保存下來了。

關鍵差異在於:在 Realm 中,物件一旦被加入某個 Realm,就變成不可直接修改的。要改屬性,必須把操作放進一個寫事務裡。這種「唯讀常駐 + 事務寫入」的 model,保證了多線程讀寫時的數據一致性。Core Data 允許改完屬性再調 save, Realm 只是把邊界收得更緊一些而已。

5. 遷移查詢

Core Data 用 fetch request 從磁碟檢索數據:先實例化一個 request 物件,再掛上過濾條件與排序規則。

NSManagedObjectContext *context = self.managedObjectContext;

// 查詢所有小於 5 歲的狗,按名字字母序排列
NSEntityDescription *entity = [NSEntityDescription entityForName:@"Dog" inManagedObjectContext:context];
NSPredicate *predicate = [NSPredicate predicateWithFormat:@"age < 5"];
NSSortDescriptor *sortDescriptor = [[NSSortDescriptor alloc] initWithKey:@"name" ascending:YES];

NSFetchRequest *request = [[NSFetchRequest alloc] init];
request.entity = entity;
request.predicate = predicate;
request.sortDescriptors = @[sortDescriptor];

NSError *error;
NSArray *dogs = [moc executeFetchRequest:request error:&error];

功能沒問題,但要寫將近十行。聰明的開發者為此造了不少庫(比如 MagicalRecord)來簡化這部分。相比之下,Realm 的等價寫法是:

RLMResults *dogs = [[Dog objectsWhere:@"age < 5"] sortedResultsUsingProperty:@"name" ascending:YES];

Swift:

var dogs = Realm().objects(Dog).filter("age < 5").sorted("name")

一行調用兩個方法。由於 RLMResults 與 NSArray 行為相近,查詢周圍的業務邏輯幾乎不用改。

6. 遷移用戶已有的數據

代碼遷移完之後,還剩一個棘手問題:如何把用戶設備上現有的 Core Data 數據搬過來?

這件事的複雜程度取決於你的 app 功能和用戶環境,沒有通用答案。目前常見兩種做法:

  • 把 Core Data 重新引入專案,用原生的 NSManagedObject 把舊數據讀出來,再手動寫入 Realm。這段遷移代碼可以長期保留,也可以在使用戶量充分覆蓋後再移除。

  • 如果用戶數據並非不可替代——比如只是一些可重新生成的緩存信息,那可以直接清空 Core Data,讓用戶下次打開時從零開始。但這個決定要非常謹慎,處理不當會留下很糟的第一印象。

最終原則只有一條:以用戶為先。理想狀態是不讓 Core Data 繼續掛在專案裡,但實際取捨還是要看具體情況。

幾點補充討論

並發。如果你在後台線程做重活,可能需要跨線程傳遞 Realm 物件。Core Data 允許跨線程傳 managed object(雖然並非最佳實踐),而 Realm 嚴格禁止,任何嘗試都會拋出嚴重異常。正確做法是傳遞物件的「標識」而不是物件本身:

dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_LOW, 0), ^{
    // 在後台隊列重命名
    [[RLMRealm defaultRealm] transactionWithBlock:^{
        dog.name = @"Peanut Wigglebutt";
    }];

    // 在主隊列打印
    NSString *uuid = dog.uuid;
    dispatch_async(dispatch_get_main_queue(), ^{
        Dog *localDog = [Dog objectForPrimaryKey:uuid];
        NSLog(@"Dog's name is %@", localDog.name);
    });
});

Swift:

dispatch_async(queue) {
    // 在後台隊列重命名
    Realm().write {
        dog.name = "Peanut Wigglebutt"
    }

    // 在主隊列打印
    let uuid = dog.uuid
    dispatch_async(dispatch_get_main_queue()) {
        let localDog = Realm().objectForPrimaryKey(Dog, uuid)
        println("Dog's name is \(localDog.name)")
    }
}

雖然物件本身不能跨線程傳遞,但它的屬性副本可以。考慮到 Realm 從磁碟檢索物件非常快,在新線程裡按主鍵重新取一次的性能損耗很小。上例中我們傳的是主鍵,然後在主線程上下文裡重新獲取物件。

NSFetchedResultsController 的替代方案。堅持用 Core Data 最充分的理由,大概就是 NSFetchedResultsController——它能感知存儲變化並自動反映到 UI 上。寫這篇文章時,Realm 還沒有對等機制:它可以註冊一個 block 在數據變化時執行,但這種「蠻力」做法對多數 UI 場景都不夠友好,直接用在列表上容易出問題。

Realm 的 Cocoa 團隊當時正在開發一套通知系統,允許在物件屬性變更時註冊通知,這部分能力會在後續的 Swift 與 Objective-C 版本中提供。

在此之前,如果現有的通知 block API 滿足不了需求,可以考慮第三方庫 RBQFetchedResultsController 來模擬上述能力;或者退一步,在 model 的 setter 方法裡主動發送自定義通知,也能達到類似效果。

結尾

Core Data 與 Realm 都以 model 物件的形式呈現數據,正是這種相似性,讓遷移變得迅速而直接(並且頗有成就感)。開始時看著確實有點嚇人,真正動手之後無非就是:把每個 Core Data 調換成等價的 Realm 調用,再寫一個輔助類去搬遷用戶的歷史數據。

如果你在 Core Data 上遇到了麻煩,想要更簡單的方案,值得試試 Realm 是否適合自己的場景。感謝閱讀,去用它做點有意思的東西吧。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved