Realm在iOS中的简单使用

一、`Realm`简单介绍

1、`Realm`简介

Realm是由美国YCombinator孵化的创业团队历时几年打造，第一个专门针对移动平台设计的数据库
Realm是一个跨平台的移动数据库引擎，目前支持iOS、Android平台，同时支持Objective-C、Swift、Java、React Native、Xamarin等多种编程语言
Realm并不是对SQLite或者CoreData的简单封装, 是由核心数据引擎C++打造，是拥有独立的数据库存储引擎，可以方便、高效的完成数据库的各种操作

2、`Realm`的优势与亮点

开源。Realm移动端数据库相关代码已全部开源。数千开发者在GitHub上参与了相关工作。另外还有几百个Realm数据库相关的扩展。
简单易用：Core Data、SQLite庞大的学习量和繁杂的代码足以吓退绝大多数刚入门的开发者，而换用Realm，则可以极大地减少学习代价和学习时间，让应用及早用上数据存储功能
跨平台：现在绝大多数的应用开发并不仅仅只在iOS平台上进行开发，还要兼顾到Android平台的开发。为两个平台设计不同的数据库是不明智的，而使用Realm数据库，iOS和Android无需考虑内部数据的架构，调用Realm提供的API就可以完成数据的交换
线程安全。程序员无需对在不同线程中，对数据库的读取一致性做任何考虑，Realm会保证每次读取都得到一致的数据

3、可视化工具`Realm Browser`

为了配合Realm的使用，Realm还提供了一个轻量级的数据库查看工具Realm Browser，借助这个工具，开发者可以查看数据库当中的内容，并执行简单的插入和删除操作。Realm Browser可以在App Store中下载安装

Realm Browser

需要注意的是

如果需要调试, 可以通过NSHomeDirectory()打印出Realm数据库地址, 找到对应的Realm文件, 然后用Realm Browser可视化工具打开即可

二、`Realm`的安装

Realm的Github地址

1、手动安装

当使用手工方式安装Realm时，可以按照如下步骤进行

登录Realm官方网站或者Github，下载Realm的最新版本并解压
将Realm.framework从ios/static/文件夹拖曳到您Xcode项目中的文件导航器当中, 确保Copy items if needed选中然后单击Finish
在Xcode文件导航器中选择您的项目，然后选择您的应用目标，进入到Build Phases选项卡中。在Link Binary with Libraries中单击 + 号然后添加libc++.tbd以及libz.tbd

RealmResource

2、使用`CocoaPods`安装

当使用CocoaPods方式安装Realm时，以Objective-C为例

CocoaPods版本要求是1.1.0及以上版本
在Podfile中，添加pod 'Realm'，如有需要, 添加pod 'Realm/Headers'到测试项目中
在终端运行pod install即可安装
在Swift中需要输入pod 'RealmSwift'才可以安装
如果是混编项目，就需要安装OC的Realm, 然后要把 Swift/RLMSupport.swift文件一同编译进去

RLMSupport.swift

RLMSupport.swift这个文件为Objective-C版本的Realm集合类型中引入了Sequence一致性，并且重新暴露了一些不能够从Swift中进行原生访问的Objective-C方法，例如可变参数variadic arguments等, 更加详细的说明见官方文档

3、Xcode插件

Realm提供了一个Xcode插件，来方便的创建RLMObject类，这需要我们首先安装相关的插件
打开Realm文件夹中的plugin/RealmPlugin.xcodeproj并进行编译，重启Xcode之后插件即可生效
当需要新建RLMObject类时，在新建类的选项中选择Realm Model Object即可

Realm Model

三、`Realm`的类定义说明

在Realm框架中，定义了二十个核心类、常量、枚举类型、协议等，常用的如：RLMRealm类、RLMObject类、RLMResults类等, 我们可以从Realm的官方网站上查看所有的定义以及使用说明

1、RLMRealm类

一个RLMRealm类的对象可以认为是一个Realm的数据库。Realm数据库既可以存储在硬盘上，同时也可以存储在内存中
Realm是框架的核心所在，是我们构建数据库的访问点，就如同Core Data的管理对象上下文managed object context一样
RLMRealm类中，常用的属性或方法如下

// 获取默认的Realm数据库
+ (instancetype)defaultRealm;


//实例化一个RLMRealm类的对象
//根据配置参数获得RLMRealm
+ (nullable instancetype)realmWithConfiguration:(RLMRealmConfiguration *)configuration error:(NSError **)error;

//根据指定持久化文件路径获得RLMRealm
+ (instancetype)realmWithPath:(NSString *)path;


//对Realm数据库进行读写操作
//在Realm上开始写入事务, 每个Realm文件一次只能打开一个写事务
- (void)beginWriteTransaction;

//在当前写入事务中提交所有写入操作，并结束事务
- (void)commitWriteTransaction;
//没有足够的磁盘空间来保存写入或由于意外的I / O错误，此方法可能会失败, 并返回error信息
- (BOOL)commitWriteTransaction:(NSError **)error;
// 在当前写入事务中提交所有写入操作，而不收到此写入事件的特定通知
- (BOOL)commitWriteTransactionWithoutNotifying:(NSArray *)tokens error:(NSError **)error;

// 回滚在当前写入事务期间进行的所有写入并结束事务
- (void)cancelWriteTransaction;

//执行写入事务内给定块中包含的操作
- (void)transactionWithBlock:(__attribute__((noescape)) void(^)(void))block;
//执行写入事务内给定块中包含的操作, 如果发生错误，则返回时包含NSError描述问题的对象
- (BOOL)transactionWithBlock:(__attribute__((noescape)) void(^)(void))block error:(NSError **)error;


//添加或更新一个对象
- (void)addObject:(RLMObject *)object;
//将现有对象添加或更新到Realm中, 有则更新没有则插入
- (void)addOrUpdateObject:(RLMObject *)object;
//添加或更新多个对象
- (void)addObjects:(id)objects;
- (void)addOrUpdateObjects:(id)objects;


//删除对象
- (void)deleteObject:(RLMObject *)object;
- (void)deleteObjects:(id)array;
- (void)deleteAllObjects;

2、RLMObject类

在Realm数据库中存储的都是RMObject对象，RLMObject类是所有可以存储在Realm数据库中的对象的根类
凡是可以存储在Realm数据库中的对象都是RLMObject类或RLMObject类的子类
要创建一个数据模型，我们只需要继承RLMObject，然后设计我们想要存储的属性即可
在RLMObject类中，我们可以添加属性，添加的属性类型可以支持如下类型：
- NSString：字符串
- NSInteger, int, long, float, double：数字型，注意没有CGFloat
- BOOL/bool：布尔型
- NSDate：日期型
- NSData：二进制字符型
- NSNumber: 其中X必须RLMInt, RLMFloat, RLMDouble或 RLMBool类型
- RLMArray: 其中X必须是RLMObject类的子类, 用于建模多对多关系
- RLMObject的子类，用于建模多对一关系
RLMObject类中，比较常用如下方法：

//创建Realm对象, 传入一个NSArray或NSDictionary实例来设置对象属性的值
- (nonnull instancetype)initWithValue:(nonnull id)value;

//在Realm数据库中，获取该RLMObject类的所有对象
+ (RLMResults *)allObjects;

//根据查询条件返回满足条件的所有RLMObject类的对象
+ (RLMResults *)objectsWhere:(NSString *)predicateFormat, ...;

//使用默认Realm中的给定主键检索此对象类型的单个实例
+ (nullable instancetype)objectForPrimaryKey:(nullable id)primaryKey;

//从指定的Realm返回此对象类型的所有对象
+ (nonnull RLMResults *)allObjectsInRealm:(nonnull RLMRealm *)realm;

//返回与指定Realm中给定谓词匹配的此对象类型的所有对象
+ (nonnull RLMResults *)objectsInRealm:(nonnull RLMRealm *)realm where:(nonnull NSString *)predicateFormat, ...;

3、RLMResults类

当我们执行一个查询操作后，查询出满足条件的RLMObject对象会存放在一个RLMResults对象中
RLMResults类是一个数组类型的数据结构，因此在其类定义中，提供了很多与数组类似的属性和方法

相关属性

//结果集合中的对象个数
@property (readonly, assign, nonatomic) NSUInteger count;

//结果集合中对象的类型
@property (readonly, assign, nonatomic) RLMPropertyType type;

//管理此结果集合的Realm对象
@property (readonly, nonatomic) RLMRealm *_Nonnull realm;

//结果集合中包含的对象的类名称
@property (readonly, copy, nonatomic, nullable) NSString *objectClassName;

相关方法

//返回结果集合中的第一个对象
- (nullable RLMObjectType)firstObject;

//返回结果集合中的最后一个对象
- (nullable RLMObjectType)lastObject;

//根据索引index获取其中的某个对象
- (RLMObjectType)objectAtIndex:(NSUInteger)index;

//根据对象返回其索引
- (NSUInteger)indexOfObject:(RLMObjectArgument)object;

//返回与谓词匹配的结果集合中第一个对象的索引
- (NSUInteger)indexOfObjectWhere:(nonnull NSString *)predicateFormat, ...;

//返回与结果集合中给定谓词匹配的所有对象
- (RLMResults *)objectsWhere:(NSString *)predicateFormat, ...;

//返回RLMResults从现有结果集合中排序的内容
- (RLMResults *)sortedResultsUsingKeyPath:(NSString *)keyPath ascending:(BOOL)ascending;

//返回RLMResults与现有结果集合不同的内容
- (nonnull RLMResults *)distinctResultsUsingKeyPaths:(nonnull NSArray *)keyPaths;

更多相关类及其属性和方法, 可参考官方文档

https://realm.io/docs/objc/latest/api/Classes.html

四、`Realm`的使用

Realm中一些常用的类及其类的属性和方法上面已经介绍了, 下面我们就介绍Realm的使用方法

1、创建RLMObject类

我们首先创建一个Student类，该类是RLMObject类的一个子类, 下图就是按照之前安装的Xcode插件创建的

image

在Student添加两个属性, RLMObject官方建议在RLMObject类中添加的属性，是不需要指定属性关键字的，完全交由Realm处理
假如设置了，这些attributes会一直生效直到RLMObject被写入realm数据库
RLM_ARRAY_TYPE宏创建了一个协议，从而允许 RLMArray语法的使用
如果RLM_ARRAY_TYPE宏没有放置在模型接口的底部的话，您或许需要提前声明该模型类

@interface Student : RLMObject

@property int num;
@property NSString *name;

@end
RLM_ARRAY_TYPE(Student)

2、存储操作

对于RLMObject类型的对象，我们可以直接对创建的对象进行存储
第一步, 初始化对象

// 方式一: 接受一个数组对象
Student *stu1 = [[Student alloc]initWithValue:@[@1, @"jun"]];

//方式二: 接受一个字典对象
Student *stu2 = [[Student alloc]initWithValue:@{@"num": @2, @"name":@"titan"}];

//方式三: 属性赋值
Student *stu3 = [[Student alloc]init];
stu3.num = 3;
stu3.name = @"titanjun";

第二步就是把RLMObject对象写入Realm数据库, 同样有三种方式

//方式一: 提交事务处理
//获取Realm对象
RLMRealm *realm = [RLMRealm defaultRealm];
//开始写入事务
[realm beginWriteTransaction];
//添加模型对象
[realm addObject:stu1];
//提交写入事务
[realm commitWriteTransaction];


//方式二: 在事务中调用addObject:方法
RLMRealm *realm = [RLMRealm defaultRealm];
[realm transactionWithBlock:^{
    [realm addObject:webSite1];
    [realm addObject:webSite2];
}];


//方式三: 在十五中创建新的对象并添加
[realm transactionWithBlock:^{
    //添加模型
    [Student createInRealm:realm withValue:@{@"num": @3, @"name":@"coder"}];
}];

一定要注意的是

所有的必需属性都必须在对象添加到Realm前被赋值
如果在进程中存在多个写入操作的话，那么单个写入操作将会阻塞其余的写入操作，并且还会锁定该操作所在的当前线程
- 建议常规的最佳做法：将写入操作转移到一个独立的线程中执行
- 官方给出的建议：由于Realm采用了MVCC设计架构，读取操作并不会因为写入事务正在进行而受到影响
- 除非您需要立即使用多个线程来同时执行写入操作，不然您应当采用批量化的写入事务，而不是采用多次少量的写入事务
- 下面的代码就是把写事务放到子线程中去处理

dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        
    RLMRealm *realm = [RLMRealm defaultRealm];
    [realm transactionWithBlock:^{
        [realm addObject: stu4];
    }];
});

3、查询操作

Realm中也提供了功能强大的数据查询能力，如果会使用SQL语言的话，上手的难度更低
在Realm的查询功能中，也可以像SQL一样使用各种条件查询关键字，查询的结果会保存在一个RLMResults类的数组中
全量查询, 通过调用allObjects方法, 得到该表中的所有数据
条件查询，设置一些查询条件，从而查询出符合条件的对象
- Realm的查询条件可以使用==、<=、<、>=、>、!=、BETWEEN、CONTAINS 以及 ENDSWITH等多种操作符

全量查询

//1. 获取所有数据
RLMResults *resArr = [Student allObjects];
NSLog(@"%@", resArr);

//2. 添加一条数据
RLMRealm *realm = [RLMRealm defaultRealm];
Student *stu = [[Student alloc]initWithValue:@[@10, @"coder"]];
[realm transactionWithBlock:^{
    [realm addObject:stu];
}];

//3. 一旦检索执行之后, RLMResults 将随时保持更新
NSLog(@"%@", resArr);

条件查询

//条件查询
RLMResults *stuArr = [Student objectsWhere:@"num > 7"];
NSLog(@"%@", stuArr);

//排序
//排序不会对原数组进行操作, 会返回一个新的数组
RLMResults *stuArr2 = [stuArr sortedResultsUsingKeyPath:@"name" ascending:YES];
NSLog(@"%@", stuArr2);


//链式查询
RLMResults *stuArr3 = [stuArr2 objectsWhere:@"num > 8"];
//可以不断的根据上一个查询结果进行查询
RLMResults *stuArr4 = [stuArr3 objectsWhere:@"num > 9"];
NSLog(@"%@", stuArr4);

4、更新操作

需要修改的模型一定是被Realm所管理的模型, 而且已经和磁盘上的对象进行地址映射
对新添加的模型进行更新

//获取Realm对象
RLMRealm *realm = [RLMRealm defaultRealm];
Student *stu4 = [[Student alloc]initWithValue:@{@"num": @4, @"name":@"titan4"}];
//添加数据
// 这个模型stu, 已经被realm 所管理, 而且, 已经和磁盘上的对象, 进行的地址映射
[realm transactionWithBlock:^{
    //添加模型
    [realm addObject:stu4];
}];

// 这里修改的模型, 一定是被realm所管理的模型
[realm transactionWithBlock:^{
    stu4.name = @"coder4";
}];

根据查询到的数据更新指定属性的数据

//条件查询
RLMResults *results = [Student objectsWhere:@"num = 4"];
Student *stu = results.firstObject;

//更新指定属性的数据
[realm transactionWithBlock:^{
    stu.name = @"titanking";
}];

当有主键的情况下, 使用Update方法
addOrUpdateObject会去先查找有没有传入的Student相同的主键，如果有，就更新该条数据
这里需要注意，addOrUpdateObject这个方法不是增量更新，所有的值都必须有，如果有哪几个值是null，那么就会覆盖原来已经有的值，这样就会出现数据丢失的问题
createOrUpdateInRealm:withValue这个方法是增量更新的，后面传一个字典，使用这个方法的前提是有主键
方法会先去主键里面找有没有字典里面传入的主键的记录，如果有，就只更新字典里面的子集;如果没有，就新建一条记录

//获取Realm对象
RLMRealm *realm = [RLMRealm defaultRealm];
Student *stu2 = [[Student alloc]initWithValue:@{@"num": @12, @"name":@"titan"}];

//addOrUpdateObject方式
[realm transactionWithBlock:^{
    [realm addOrUpdateObject:stu2];
}];

//createOrUpdateInRealm方式
[realm transactionWithBlock:^{
    [Student createOrUpdateInRealm:realm withValue:@{@"num": @11, @"name":@"titan11"}];
}];

5、删除操作

删除的模型, 一定要求是被realm所管理的已经存在的模型
当需要在Realm中删除某些对象时，需要注意的是，该方法的执行需要在一个事务中进行

//获取Realm对象
RLMRealm *realm = [RLMRealm defaultRealm];

//根据条件删除一条数据 
RLMResults *results = [Student objectsWhere:@"name = 'titanking'"];
Student *titan1 = results.firstObject;

// 删除单条记录
[realm transactionWithBlock:^{
    [realm deleteObject:titan1];
}];



//删除所有符合条件的数据
RLMResults *results = [Student objectsWhere:@"name = 'coder'"];
for (Student *stu in results) {
    [realm transactionWithBlock:^{
        [realm deleteObject:stu];
    }];
}



//删除表中所有的数据
[realm transactionWithBlock:^{
    [realm deleteAllObjects];
}];



/*场景, 根据主键删除一个模型*/
 // 1. 根据主键, 查询到这个模型(这个模型, 就是被realm数据库管理的模型)
Student *res = [Student objectInRealm:realm forPrimaryKey:@4];

//2. 删除该模型
[realm transactionWithBlock:^{
    [realm deleteObject:res];
}];

6、`Realm`数据库机制

上面用到的获取realm对象的方式都是通过defaultRealm来获取默认配置的realm对象
当我们需要创建不同的realm表格时又该如何操作呢?
下面我们来看一下

- (void)setDefaultRealmForUser:(NSString *)username {
    //先获取默认配置
    RLMRealmConfiguration *config = [RLMRealmConfiguration defaultConfiguration];
    
    //设置只读数据库
    //config.readOnly = YES;
    
    // 使用默认的目录，但是使用用户名来替换默认的文件名
    config.fileURL = [[[config.fileURL URLByDeletingLastPathComponent]
                       URLByAppendingPathComponent:username]
                      URLByAppendingPathExtension:@"realm"];
    // 将这个配置应用到默认的 Realm 数据库当中
    [RLMRealmConfiguration setDefaultConfiguration:config];
}

做好上述配置之后, 便可创建不同的数据库了

// 不同的用户, 使用不同的数据库
[self setDefaultRealmForUser:@"zhangsan"];

//这里也只需要调用默认配置即可
RLMRealm *realm = [RLMRealm defaultRealm];

7、通知

Realm实例将会在每次写入事务提交后，给其他线程上的Realm实例发送通知
一般控制器如果想一直持有这个通知，就需要申请一个属性, 强引用该属性，strong持有这个通知
集合通知是异步触发的，首先它会在初始结果出现的时候触发，随后当某个写入事务改变了集合中的所有或者某个对象的时候，通知都会再次触发

//强引用属性
@property (nonatomic, strong) RLMNotificationToken *token;


- (void)setUp {
    [super setUp];

    RLMRealm *realm = [RLMRealm defaultRealm];
    // 获取 Realm 通知
    self.token = [realm addNotificationBlock:^(RLMNotification  _Nonnull notification, RLMRealm * _Nonnull realm) {
        NSLog(@"接收到变更通知--%@", notification);
    }];

    //结束该通知
    [self.token stop];
}


- (void)testExample {
    NoticeModel *noticeM = [[NoticeModel alloc] initWithValue:@{@"num": @1, @"name": @"sz"}];

    //添加数据, 数据操作之后便会通知上述通知中心执行相应操作
    RLMRealm *realm = [RLMRealm defaultRealm];
    [realm transactionWithBlock:^{
        [realm addObject:noticeM];
    }];
}

8、数据库迁移

数据库存储方面的增删改查应该都没有什么大问题，比较蛋疼的应该就是数据迁移了
在版本迭代过程中，很可能会发生表的新增，删除，或者表结构的变化，如果新版本中不做数据迁移，用户升级到新版，很可能就直接crash了
数据迁移一直是困扰各类型数据库的一大问题, 但是对于Realm来说, 却方便很多, 这也是Realm的优点之一
- 新增删除表，Realm不需要做迁移
- 新增删除字段，Realm不需要做迁移; Realm会自行检测新增和需要移除的属性，然后自动更新硬盘上的数据库架构

//需要在以下方法中进行配置
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // 获取默认配置, 迁移数据结构
    RLMRealmConfiguration *config = [RLMRealmConfiguration defaultConfiguration];

    // 1. 设置新的架构版本。这个版本号必须高于之前所用的版本号（如果您之前从未设置过架构版本，那么这个版本号设置为 0）
    int newVersion = 4;
    config.schemaVersion = newVersion;

    // 2. 设置闭包，这个闭包将会在打开低于上面所设置版本号的 Realm 数据库的时候被自动调用
    [config setMigrationBlock:^(RLMMigration *migration, uint64_t oldSchemaVersion){
        if (oldSchemaVersion < newVersion) {

            NSLog(@"数据结构会自动迁移");

            // enumerateObjects:block: 遍历了存储在 Realm 文件中的每一个“Person”对象
            [migration enumerateObjects:@"DataMigration" block:^(RLMObject * _Nullable oldObject, RLMObject * _Nullable newObject) {
                // 只有当 Realm 数据库的架构版本为 0 的时候，才添加 “fullName” 属性
                if (oldSchemaVersion < 1) {
                    newObject[@"fullName"] = [NSString stringWithFormat:@"%@ %@", oldObject[@"firstName"], oldObject[@"lastName"]];
                }
                // 只有当 Realm 数据库的架构版本为 0 或者 1 的时候，才添加“email”属性
                if (oldSchemaVersion < 2) {
                    newObject[@"email"] = @"";
                }
                // 替换属性名(原字段重命名)
                if (oldSchemaVersion < 3) { // 重命名操作应该在调用 `enumerateObjects:` 之外完成
                    [migration renamePropertyForClass:Person.className oldName:@"yearsSinceBirth" newName:@"age"];
                }
            }];
        }
    }];

    // 3. 告诉 Realm 为默认的 Realm 数据库使用这个新的配置对象
    [RLMRealmConfiguration setDefaultConfiguration:config];

    // 4. 现在我们已经告诉了 Realm 如何处理架构的变化，打开文件之后将会自动执行迁移
    [RLMRealm defaultRealm];
    
    
    return YES;
}

以上就是我最近学习到的关于Realm的部分内容, 文章不全, 有兴趣的可以参考下面的文章继续学习
参考文档
- Realm数据库从入门到“放弃”
- Realm官方文档
- Realm GitHub

欢迎您扫一扫下面的微信公众号，订阅我的博客！

微信公众号

Realm在iOS中的简单使用

一、Realm简单介绍

1、Realm简介

2、Realm的优势与亮点

3、可视化工具Realm Browser

二、Realm的安装