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); } ```