Realm ios踩坑筆記

> * *Realm，爲移動設備而生!替代 SQLite 和 Core Data。爲你省下數週的時間和數千行的代碼，幫你創造出更棒的用戶體驗。--Realm官網* ###一.優點 Realm 並非基於 Core Data ，也不是基於 SQLite 所構建的。它擁有本身的數據庫存儲引擎，能夠高效且快速地完成數據庫的構建操做。 Realm 比使用 SQLite 要快，比ORM要快不少。 簡單。經過標註和對象操做實現數據操做。 版本升級時，數據遷移成本很低。 與rxjava、retrofit等Library有很好的交互。 *** ###二.安裝方式 * cocoapods(推薦): ``` 1.[安裝CocoaPods 0.39.0 或者更高版本] 2.運行 pod repo update，以確保 CocoaPods 可以獲取到Realm 的最新版本 3.在您的Podfile中，添加pod 'Realm'到您的 app 目標中，添加pod 'Realm/Headers'到您的測試目標中； 4.在終端運行pod install； 5.採用 CocoaPods 生成的.xcworkspace來運行工程！ 6.若是須要在 Swift 當中使用的話，將於 Swift/RLMSupport.swift 的這個文件拖動到您 Xcode 項目的文件導航器當中，檢查以確保 **Copy items if needed** 選項已被勾選。 ``` * Static Framework(靜態庫): ``` 1.下載Realm 的最新版本並解壓； 2.將 Realm.framework 從 ios/static/文件夾拖曳到您 Xcode 項目中的文件導航器當中。確保 **Copy items if needed** 選中而後單擊 **Finish**； 3.在 Xcode 文件導航器中選擇您的項目，而後選擇您的應用目標，進入到** Build Phases** 選項卡中。在 **Link Binary with Libraries** 中單擊 + 號而後添加 **libc++.tbd** 以及 **libz.tbd**； 4.若是你在用 Swift 來使用 Realm，那麼將位於 Swift/RLMSupport.swift 的文件拖曳進您 Xcode 項目中的文件導航器當中，確保 **Copy items if needed** 選中。 ``` ###三.Realm瀏覽器/數據庫管理器 `在mac的Appstore下載一款名爲Realm Browser的軟件便可進行管理` ###四.Xcode插件 * 快速建立RLMObject對象 點擊下載[release zip](https://link.juejin.im/?target=https%3A%2F%2Fstatic.realm.io%2Fdownloads%2Fobjc%2Frealm-objc-2.8.2.zip) ,解壓之後打開plugin/RealmPlugin.xcodeproj進行編譯,重啓Xcode,command + N,拉倒底部,出現一個Realm Model Object的圖標,點擊便可建立RLMObject對象 ###五.API 參考 全部的類和方法什麼的均可以去[API文檔查閱](https://link.jianshu.com/?t=https://realm.io/docs/objc/latest/api/) ###六.建立數據模型 * 建立一個數據模型,並建立參數 ```objectivec #import <Realm/Realm.h> #import "ExpandCell_M.h" typedef enum : NSUInteger { TransactionDetailButtonTypeAll = 0, TransactionDetailButtonTypeRecharge, TransactionDetailButtonTypeDeposit, TransactionDetailButtonTypeEarnings, } TransactionDetailButtonType; @interface ExpandSection_M : RLMObject /// 是否隱藏 @property (nonatomic,assign) BOOL isExpand; /// 時間標題 @property (nonatomic, copy) NSString *month; ///判斷類型(TransactionDetailButtonType類型轉化爲NSInteger類型) @property (nonatomic, assign) NSInteger DetailType; ///編碼 @property (nonatomic, assign) NSInteger SectionID; @end ``` ####注意事項: >1.Realm支持如下的屬性property種類： BOOL,bool, int, NSInteger, long, float, double, CGFloat, NSString, NSDate 和NSData。 tip: 枚舉及結構體沒法進行存儲,須要進行數據類型轉換 2.你可使用RLMArray<NSObject> 和RLMObject來模擬對一或對多的關係 3.Realm也支持RLMObject繼承。 4.屬性property特性:請注意Realm忽略了objective-c的property attributes,像nonatomic, atomic, strong, copy, weak等等。 >因此，爲了不誤解，咱們推薦你在寫入模型的時候不要使用任何的property attributes。可是，假如你設置了，這些attributes會一直生效直到RLMObject被寫入realm數據庫。 不管RLMObject在或不在realm中，你爲getter和setter自定義的名字都能正常工做。 ###七.數據模型定製 幾個存在的類方法進一步指定模型信息: `+ (NSDictionary *)defaultPropertyValues; 能夠被重寫，用覺得新建的對象提供默認值。` `+ (NSString *)primaryKey; 能夠被重寫來設置模型的主鍵。定義主鍵能夠提升效率而且確保惟一性。` `+ (NSArray *)ignoredProperties; 能夠被重寫來防止Realm存儲模型屬性。` ###八.模型嵌套 ```objectivec // .h (官網示例) #import <Realm/Realm.h> @class Person; // 狗狗的數據模型 @interface Dog : RLMObject @property NSString *name; @property Person *owner; @end RLM_ARRAY_TYPE(Dog) // 定義RLMArray<Dog> // 狗狗主人的數據模型 @interface Person : RLMObject @property NSString *name; @property NSDate *birthdate; // 經過RLMArray創建關係 @property RLMArray<Dog> *dogs; @end RLM_ARRAY_TYPE(Person) // 定義RLMArray<Person> // .m @implementation Dog @end // 暫無使用 @implementation Person @end // 暫無使用 ``` ###八.使用Realm進行數據管理 * 方法一: ```objectivec RLMRealm *realm = [RLMRealm defaultRealm]; [realm transactionWithBlock:^{ // 進行數據處理 }]; ``` * 方法二: ```objectivec RLMRealm *realm = [RLMRealm defaultRealm]; [realm beginWriteTransaction]; // 進行數據處理 [realm commitWriteTransaction]; ``` ###九.查詢 ####1.全部的數據抓取都很簡單，而且直到得到數據以後才建立副本。 #####關於使用RLMResults的小貼士: - Realm的對象查詢返回一個RLMResults對象。它包含了一系列的RLMObject。(保存什麼類型,取出就是什麼類型) - RLMResults有一個與NSArray很類似的interface（接口）而且對象能夠經過索引（index）下標獲取。 但不一樣於NSArray的是，RLMResult是歸類的——它只能容納一種RLMObjects類型。(數組類型單一) - 根據種類獲取對象從realm中獲取對象的最基本方法就是 [RLMObject allObjects], 它返回一個RLMResults，裏面是查詢的子類的全部RLMObject實例。 ```objectivec // 默認查詢 RealmRLMResults *dogs = [Dog allObjects]; // 從默認Realm中查找全部的🐶 // 指定查詢 RealmRLMRealm *petsRealm = [RLMRealm realmWithPath:@"pets.realm"]; // 獲得一個指定的realm RealmRLMResults *otherDogs = [Dog allObjectsInRealm:petsRealm]; // 在指定的realm中查詢全部的狗 ``` ####2.謂詞/條件查詢 >若是你對[NSPredicate](http://www.cocoachina.com/ios/20160111/14926.html)很熟悉的話, 那麼你就已經知道怎麼在realm裏面查詢了。 RLMObjects, RLMRealm, RLMArray和RLMResults都提供很好的methods來查詢特定的RLMObjects： 你只須要傳遞相應地NSPredicate實例，謂詞字符串，謂詞格式字符串，就能夠獲取你想要的RLMObjects實例。就和NSObject同樣的。 舉個例子，下面的代碼就是對上面的拓展。 經過調用[RLMObject objectsWhere:],得到了默認realm數據庫中的全部顏色是黃褐色的，名字開頭是「B」的狗的實例。 ```objectivec // 條件查詢 RLMResults *tanDogs = [Dog objectsWhere:@"color = 'tan' AND name BEGINSWITH 'B'"]; // 使用一個NSPredicate對象查詢 NSPredicate *pred = [NSPredicate predicateWithFormat:@"color = %@ AND name BEGINSWITH %@", @"tan", @"B"]; tanDogs = [Dog objectsWithPredicate:pred]; ``` 能夠參看Apple的`Predicates Programming Guide`瞭解更多關於如何建立謂詞。 1.Realm支持不少常見的謂詞：在比較中， 操做數能夠是屬性名或者常量。可是其中至少有一個是屬性名。 2.只有int, long, float, double, and NSDate這些屬性類型（property types）支持 ==, <=, <, >=, >, !=, 和 BETWEEN這些比較操做符。布爾屬性能夠支持==和！=。 3.在NSString和NSData屬性中, 咱們支持的操做符有 ==, !=, BEGINSWITH, CONTAINS和ENDSWITH。 4.realm還支持以下的複合型操做符： AND， OR， NOT注意，咱們雖然不支持aggregate expression type,可是咱們支持BETWEEN操做符, 例如： ```objectivec RLMResults *results = [Person objectsWhere:@"age BETWEEN %@", @[42, 43]]; ``` ####3.條件排序 1.在不少狀況下，咱們都但願獲取或者查詢返回的結果都能按照必定條件排序。 因此，RLMArray支持使用指定的屬性對數據列進行排序。 2.Realm容許你指定一個排序要求而且根據一個或多個屬性進行排序。 3.舉例來講， 下面代碼呼叫了[RLMObject objectsWhere:where:]對返回的數據」dogs」進行排序，排序的條件是名字的字母表升序。: ```objectivec // Sort tan dogs with names starting with "B" by name RLMResults *sortedDogs = [[Dog objectsWhere: @"color = 'tan' AND name BEGINSWITH 'B'"] sortedResultsUsingProperty:@"name" ascending:YES]; ``` ####4.鏈式查詢 - Realm查詢引擎的一個獨特屬性就是它可以進行簡單快捷的鏈式查詢， 而不須要像傳統數據庫同樣的麻煩。舉個例子來講，假如你要全部黃褐色的小狗的結果序列，而後從中查找名字開頭是「B「的小狗。 你能夠發送以下的請求。 ```objectivec RLMResults *tanDogs = [Dog objectsWhere:@"color = 'tan'"]; RLMResults *tanDogsWithBNames = [tanDogs objectsWhere:@"name BEGINSWITH 'B'"]; ``` ####5.刪除數據 * 刪除某個在Realm數據庫中的數據。 ```objectivec Book *cheeseBook = ... // 存儲在 Realm 中的 Book 對象 // 在事務中刪除一個對象 [realm beginWriteTransaction]; [realm deleteObject:cheeseBook]; [realm commitWriteTransaction]; ``` * 刪除數據庫中的全部數據。 ```objectivec // 從 Realm 中刪除全部數據 [realm beginWriteTransaction]; [realm deleteAllObjects]; [realm commitWriteTransaction]; ``` ###十.通知 每當一次寫事務完成Realm實例都會向其餘線程上的實例發出通知，能夠經過註冊一個block來響應通知： ```objectivec // Observe Realm Notifications self.token = [realm addNotificationBlock:^(NSString *note, RLMRealm * realm) { [myViewController updateUI]; }]; ``` 只要有任何的引用指向這個返回的notification token，它就會保持激活狀態。 在這個註冊更新的類裏，你須要有一個強引用來鉗制這個token， 由於一旦notification token被釋放，通知也會自動解除註冊。 具體內容： `[Realm addNotificationBlock:]和[Realm removeNotificationBlock:]`。 ###十一.Realm配置 每一個用戶有本身不一樣的數據庫,在App啓動之後根據用戶的uid來設置數據庫,能夠經過對默認配置進行更改,而後經過訪問默認數據庫來實現不一樣用戶不一樣數據庫. 由於設置了模型插入數據庫之後若是發生屬性更改,須要進行版本遷移.可使用app的版本做爲數據庫的版本,當版本迭代發生之後,改了模型的屬性,經過更改App的版本號實現版本遷移. ```objectivec // 版本遷移和配置數據庫基本數據 - (void)setRealmMigration:(NSString *)username{ RLMRealmConfiguration *config = [RLMRealmConfiguration defaultConfiguration]; // BTLog(@"%@---",config.fileURL); // 使用默認的目錄，可是使用用戶名來替換默認的文件名 config.fileURL = [[[config.fileURL URLByDeletingLastPathComponent] URLByAppendingPathComponent:username ? username : @"defalut"] URLByAppendingPathExtension:@"realm"]; // 將這個配置應用到默認的 Realm 數據庫當中 [RLMRealmConfiguration setDefaultConfiguration:config]; // 設置新的架構版本。這個版本號必須高於以前所用的版本號（若是您以前從未設置過架構版本，那麼這個版本號設置爲 0） NSDictionary *infoDic = [[NSBundle mainBundle] infoDictionary]; NSString *appVersion = [infoDic objectForKey:@"CFBundleShortVersionString"]; uint64_t schemaVersion = appVersion.floatValue; config.schemaVersion = schemaVersion; // 設置閉包，這個閉包將會在打開低於上面所設置版本號的 Realm 數據庫的時候被自動調用 config.migrationBlock = ^(RLMMigration *migration, uint64_t oldSchemaVersion) { // 目前咱們還未進行數據遷移，所以 oldSchemaVersion == 0 if (oldSchemaVersion < schemaVersion) { // 什麼都不要作！Realm 會自行檢測新增和須要移除的屬性，而後自動更新硬盤上的數據庫架構 } }; // 告訴 Realm 爲默認的 Realm 數據庫使用這個新的配置對象 [RLMRealmConfiguration setDefaultConfiguration:config]; // 如今咱們已經告訴了 Realm 如何處理架構的變化，打開文件以後將會自動執行遷移 [RLMRealm defaultRealm]; // realm文件的位置 BTLog(@"fileurl===%@",[RLMRealmConfiguration defaultConfiguration].fileURL); } ```