Realm踩坑笔记

[TOC]

  • 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 ,解压以后打开plugin/RealmPlugin.xcodeproj进行编译,重启Xcode,command + N,拉倒底部,出现一个Realm Model Object的图标,点击即可创建RLMObject对象

五.API 参考

所有的类和方法什么的都可以去API文档查阅

六.创建数据模型

  • 创建一个数据模型,并创建参数
#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存储模型属性。

八.模型嵌套

// .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进行数据管理

  • 方法一:
RLMRealm *realm = [RLMRealm defaultRealm];
[realm transactionWithBlock:^{
 // 进行数据处理
}];
  • 方法二:
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实例。

// 默认查询 
RealmRLMResults *dogs = [Dog allObjects]; // 从默认Realm中查找所有的🐶

// 指定查询
RealmRLMRealm *petsRealm = [RLMRealm realmWithPath:@"pets.realm"]; // 得到一个指定的realm
RealmRLMResults *otherDogs = [Dog allObjectsInRealm:petsRealm]; // 在指定的realm中查询所有的狗

2.谓词/条件查询

如果你对NSPredicate很熟悉的话, 那么你就已经知道怎么在realm里面查询了。
RLMObjects, RLMRealm, RLMArray和RLMResults都提供很好的methods来查询特定的RLMObjects:
你只需要传递相应地NSPredicate实例,谓词字符串,谓词格式字符串,就可以获取你想要的RLMObjects实例。就和NSObject一样的。

举个例子,下面的代码就是对上面的拓展。 通过调用[RLMObject objectsWhere:],获得了默认realm数据库中的所有颜色是黄褐色的,名字开头是“B”的狗的实例。

// 条件查询
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操作符, 例如:

RLMResults *results = [Person objectsWhere:@"age BETWEEN %@", @[42, 43]];

3.条件排序

1.在很多情况下,我们都希望获取或者查询返回的结果都能按照一定条件排序。
所以,RLMArray支持使用指定的属性对数据列进行排序。
2.Realm允许你指定一个排序要求并且根据一个或多个属性进行排序。
3.举例来说, 下面代码呼叫了[RLMObject objectsWhere:where:]对返回的数据”dogs”进行排序,排序的条件是名字的字母表升序。:

// 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“的小狗。 你可以发送如下的请求。
RLMResults *tanDogs = [Dog objectsWhere:@"color = 'tan'"];
RLMResults *tanDogsWithBNames = [tanDogs objectsWhere:@"name BEGINSWITH 'B'"];

5.删除数据

  • 删除某个在Realm数据库中的数据。
Book *cheeseBook = ... // 存储在 Realm 中的 Book 对象
// 在事务中删除一个对象
[realm beginWriteTransaction];
[realm deleteObject:cheeseBook];
[realm commitWriteTransaction];
  • 删除数据库中的所有数据。
// 从 Realm 中删除所有数据
[realm beginWriteTransaction];
[realm deleteAllObjects];
[realm commitWriteTransaction];

十.通知

每当一次写事务完成Realm实例都会向其他线程上的实例发出通知,可以通过注册一个block来响应通知:

// 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的版本号实现版本迁移.

// 版本迁移和配置数据库基本数据
- (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);
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 175,490评论 5 419
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 74,060评论 2 335
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 124,407评论 0 291
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 47,741评论 0 248
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 56,543评论 3 329
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 43,040评论 1 246
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 34,107评论 3 358
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 32,646评论 0 229
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 36,694评论 1 271
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 32,398评论 2 279
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 33,987评论 1 288
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 30,097评论 3 285
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 35,298评论 3 282
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 27,278评论 0 14
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 28,413评论 1 232
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 38,397评论 2 309
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 38,099评论 2 314

推荐阅读更多精彩内容