
最近專案在用 Realm,就把實踐過程中的心得整理出來分享。
Realm 是 Y Combinator 孵化的一款跨平台行動資料庫,可用於 iOS(Swift 與 Objective-C 皆可)和 Android。本文以 Realm 2.0.2 為基準,當時支援的平台上 Java、Objective-C、Swift、React Native、Xamarin 都在列。
官網列了很多優點,但真正說服我選它的只有三點:

Realm Browser 在除錯時實在太好用,強烈推薦。使用模擬器時,可以透過下列程式碼印出資料庫路徑,接著在 Finder 中 ⇧⌘G 跳轉,用 Realm Browser 打開對應的 .realm 檔即可:
[RLMRealmConfiguration defaultConfiguration].fileURL
若使用真機除錯,則是「Xcode → Window → Devices」,找到對應的設備與專案,點擊 Download Container,導出 xcappdata 檔後顯示套件內容,進入 AppData → Documents,再用 Realm Browser 打開 .realm 檔。
自 2012 年起,Realm 就已被用於正式商業產品,四年下來逐步趨於穩定。
使用 Realm 建構 App 的基本要求:iOS 7 以上、macOS 10.9 以上(tvOS 與 watchOS 全版本皆可),並需要 Xcode 7.3 或更新版本。
注意:純 OC 專案裝 OC 版 Realm,純 Swift 專案裝 Swift 版。若是混編專案,要裝 OC 版 Realm,並把 Swift/RLMSupport.swift 一起編譯進去——這個檔案為 Objective-C 版的 Realm 集合型別引入了 Sequence 一致性,並重新 exposes 一些無法從 Swift 原生存取的 Objective-C 方法(例如可變參數)。
動態框架與 iOS 7 不相容,要支援 iOS 7 請改用「靜態框架」。
Realm.framework 拖進 Embedded Binaries,確認勾選 Copy items if needed 後點 Finish。Swift/RLMSupport.swift 拖進專案檔案導航列並勾選 Copy items if needed。bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Realm.framework/strip-frameworks.sh"
這一步是為了繞過 App Store 上傳的 bug,打包通用設備的二進位版本時必做。

在 Podfile 中加入 pod 'Realm',終端機執行 pod install。
github "realm/realm-cocoa",執行 carthage update。若要指定 Swift toolchain,可用 --toolchain 參數;--no-use-binaries 也是必要的,可避免 Carthage 下載預先建置的 Swift 3.0 二進位檔。例如:carthage update --toolchain com.apple.dt.toolchain.Swift_2_3 --no-use-binaries
Realm.framework 拖進 Xcode 專案 General 設定的 Linked Frameworks and Libraries。/usr/local/bin/carthage copy-frameworks
並在 Input Files 中加入框架路徑,例如 $(SRCROOT)/Carthage/Build/iOS/Realm.framework。同樣是為了繞過 App Store 上傳的 bug。
Realm.framework 從 ios/static/ 拖進專案檔案導航器,勾選 Copy items if needed。RLMRealm:框架的核心,是我們存取資料庫的入口,相當於 Core Data 的 managed object context。最簡單的用法是 [RLMRealm defaultRealm]。
RLMObject:自訂的 Realm 資料模型。建立模型的行為就等於定義資料庫結構——繼承 RLMObject,設計要存的屬性即可。
關系 Relationships:在模型中宣告一個 RLMObject 型別的屬性,就建立了一對多關係;也能建立多對一與多對多。
寫操作事務 Write Transactions:所有建立、編輯、刪除物件的操作都必須在事務中完成,也就是包在 write 閉包裡。
查詢 Queries:最簡單的形式是對 Realm 實例發送查詢;更複雜的需求可用 predicates、複合查詢與結果排序。
RLMResults:查詢後回傳的型別,內部是一系列 RLMObject。它類似 NSArray,可用下標語法存取,還支援排序、查找等更強的能力。
Realm 的 API 極為親切,一看就懂,所以這裡照平時開發的順序梳理一遍。
- (void)creatDataBaseWithName:(NSString *)databaseName {
NSArray *docPath = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
NSString *path = [docPath objectAtIndex:0];
NSString *filePath = [path stringByAppendingPathComponent:databaseName];
NSLog(@"數據庫目錄 = %@", filePath);
RLMRealmConfiguration *config = [RLMRealmConfiguration defaultConfiguration];
config.fileURL = [NSURL URLWithString:filePath];
config.objectClasses = @[MyClass.class, MyOtherClass.class];
config.readOnly = NO;
int currentVersion = 1.0;
config.schemaVersion = currentVersion;
config.migrationBlock = ^(RLMMigration *migration, uint64_t oldSchemaVersion) {
// 資料遷移設定
if (oldSchemaVersion < currentVersion) { }
};
[RLMRealmConfiguration setDefaultConfiguration:config];
}
主要是設定 RLMRealmConfiguration:把路徑與資料庫名稱拼接後賦值給 fileURL 即可。
objectClasses 用來限制哪些類別能存進指定的 Realm 資料庫。例如兩個團隊分別開發 App 的不同部分卻共用同一個資料庫,就能靠它避免遷移時互相打架;一般情況可以不設。
readOnly 控制是否唯讀。
還有一種很特殊的記憶體資料庫:把 inMemoryIdentifier 設起來而不設 fileURL,就能建立完全在記憶體中運行的資料庫。
RLMRealmConfiguration *config = [RLMRealmConfiguration defaultConfiguration]; config.inMemoryIdentifier = @"MyInMemoryRealm"; RLMRealm *realm = [RLMRealm realmWithConfiguration:config error:nil];
記憶體資料庫在每次程式運行期間不會保存資料,但不影響查詢、關系與執行緒安全等其他功能。若你需要「可讀可寫但不想落地」的暫存空間,它很合適。使用時有兩點要注意:
Realm 的資料模型基於標準 Objective-C 類別定義,用屬性描述結構。只要繼承 RLMObject(或既有的模型類),就建立了一個新的模型,對應資料庫裡的一張表。
@interface RLMUser : RLMObject @property NSString *accid; // 用戶註冊 id @property NSInteger custId; // 編號 @property NSString *custName; // 姓名 @property NSString *avatarBig; // 頭像大圖 url @property RLMArray *cars; RLM_ARRAY_TYPE(RLMUser) // 定義 RLMArray @end @interface Car : RLMObject @property NSString *carName; @property RLMUser *owner; @end RLM_ARRAY_TYPE(Car)
注意:官方建議不要在 RLMObject 上加 Objective-C 的 property attributes(nonatomic、atomic、strong、copy、weak 等),因為這些屬性會一直生效直到物件被寫入 Realm。
RLM_ARRAY_TYPE 宏會建立一個協議,讓 RLMArray<Car> 這種語法可用;若宏沒放在模型介面底部,可能需要提前宣告該模型類。
對一(To-One):多對一或一對一,只需宣告一個 RLMObject 子類型別的屬性,例如 @property RLMUser *owner;。
對多(To-Many):透過 RLMArray 型別的屬性定義,例如 @property RLMArray<Car> *cars;。
反向關系(Inverse Relationship):鏈接是單向的,因此 cars 與 owner 實際上是兩條互相獨立的鏈接。若要建立反向查詢:
@interface Car : RLMObject
@property NSString *carName;
@property (readonly) RLMLinkingObjects *owners;
@end
@implementation Car
+ (NSDictionary *)linkingObjectsProperties {
return @{
@"owners": [RLMPropertyDescriptor descriptorWithClass:RLMUser.class
propertyName:@"cars"],
};
}
@end
這裡可以類比 Core Data 的 xcdatamodel 檔案裡那些「箭頭」。

@implementation Book
// 主鍵
+ (NSString *)primaryKey { return @"ID"; }
// 屬性預設值
+ (NSDictionary *)defaultPropertyValues { return @{@"carName": @"測試"}; }
// 忽略屬性,不存進 Realm
+ (NSArray *)ignoredProperties { return @[@"ID"]; }
// 必要屬性:只有 name 為 nil 時才拋異常,其他屬性則允許為空
+ (NSArray *)requiredProperties { return @[@"name"]; }
// 索引,可加快檢索速度
+ (NSArray *)indexedProperties { return @[@"ID"]; }
@end