Realm数据库使用及踩坑（Android-Kotlin）

前言

最近公司新开发了个项目，其中使用到了Realm数据库，在此对Realm数据库的使用及踩坑进行下总结。

Realm简介

Realm 是一个 MVCC （多版本并发控制）数据库，由Y Combinator公司在2014年7月发布一款支持运行在手机、平板和可穿戴设备上的嵌入式数据库，目标是取代SQLite。

Realm 本质上是一个嵌入式数据库，他并不是基于SQLite所构建的。它拥有自己的数据库存储引擎，可以高效且快速地完成数据库的构建操作。和SQLite不同，它允许你在持久层直接和数据对象工作。在它之上是一个函数式风格的查询api，众多的努力让它比传统的SQLite 操作更快。

优势

易用
Ream 不是在SQLite基础上的ORM，它有自己的数据查询引擎。并且十分容易使用。
快速
由于它是完全重新开始开发的数据库实现，所以它比任何的ORM速度都快很多，甚至比SLite速度都要快。
跨平台
Realm 支持 iOS & OS X (Objective‑C & Swift) & Android。我们可以在这些平台上共享Realm数据库文件，并且上层逻辑可以不用任何改动的情况下实现移植。
高级
Ream支持加密，格式化查询，易于移植，支持JSON，流式api，数据变更通知等高级特性
可视化
Realm 还提供了一个轻量级的数据库查看工具：Realm Studio，开发者可以查看数据库当中的内容，执行简单的插入和删除数据的操作。

使用方式

添加依赖
在project的build.gradle中

project的build.gradle中

在Application的build.gragle中

Application的build.gragle中

Application的build.gragle中
初始化Realm
在 Applaction 的 onCreate() 方法中使用 Realm.init() 初始化

在 Applaction 的 onCreate() 方法中初始化

使用图上配置会创建一个 REALM_NAME.realm 的 Realm 文件，一般来说这个文件位于 data/data/包名/files 目录下，通过 realm.getPath 来获得该 Realm 的绝对路径

在Activity中具体使用
在onCreate中打开数据库

在onCreate中打开数据库

在使用完后在 onDestory() 方法中进行关闭

在onDestroy中关闭数据库
创建model类

model类的创建方式有两种：
1. 继承RealmObject
  
  继承RealmObject
2. 实现RealmModel并添加@RealmClass修饰符
  
  实现Realm Model并添加@RealmClass
- 支持的属性
boolean, byte, short,int,long,float, double,String, Date 和byte[], RealmObject, RealmList

还支持Boolean, Byte, Short, Integer, Long, Float 和 Double

Tip：整数类型 short、int 和 long 都被映射到 Realm 内的相同类型（实际上为 long ）
- @PrimaryKey——表示该字段是主键
字段类型必须是字符串（String）或整数（byte，short，int或long）以及它们的包装类型（Byte,Short, Integer, 或 Long）。不可以存在多个主键，使用字符串字段作为主键意味着字段被索引（注释@PrimaryKey隐式地设置注释@Index）。
- @Required——表示该字段非空
在某些情况下，有一些属性是不能为null的。使用@Required可用于用于强行要求其属性不能为空，只能用于Boolean, Byte, Short, Integer, Long, Float, Double, String, byte[] 和 Date。在其它类型属性上使用 @Required修饰会导致编译失败。

Tip：基本数据类型不需要使用注解 @Required，因为他们本身就不可为空。
- @Ignore——表示忽略该字段
被添加@Ignore标签后，存储数据时会忽略该字段。
- @Index——添加搜索索引
为字段添加搜索索引，这样会使得插入的速度变慢，数据量也变得更大。不过在查询速度将变得更快，建议只在优化读取性能的特定情况时添加索引。支持索引：String，byte，short，int，long，boolean和Date字段。

结合RxJava使用

RxJava是一个在 Java VM 上使用可观测的序列来组成异步的、基于事件的程序的库。

Realm包含了对RxJava的原生支持。

Rxjava调用

这里使用asFlowable轻松转换成RxJava中的Flowable对象，之后可以使用RxJava中的特性，流式编程，使代码更简洁，逻辑更清晰。

结合Kotlin使用

Realm完全兼容Kotlin语言，但有些地方需要注意：

Model需要时开放的（open）
很多RealmApi引用了Java类。你必须在编译一栏中添加 org.jetbrains.kotlin:kotlin-reflect:$kotlin_version。

踩坑指南

使用Gson作为Json解析框架的时候，继承RealmObject的类序列化和反序列化的时候需排除RealmObject中的属性，否则将因为类RealmObject涉及父子轮调，导致死循环

解决方法：使用ExclusionStrategy（排除策略）实现对类或者域的序列化排除

使用ExclusionStrategy（排除策略）实现对类或者域的序列化排除

Realm数据自动更新。Realm查找到数据后如果数据发生了改变，会直接修改我们查找到的对象中的数据，但在项目的开发过程中会导致原生与H5之间不断的进行无效的交互。

解决方法：使用firstElement实现只取一次数据。

使用firstElement实现只取一次数据

在获取到Realm实例的时候注意Realm.getDefaultInstance()这个方法，每调用一次这个方法会在当前线程中创建一个新的Realm对象，导致内存占用过大。

解决方法：使用RealmManager管理当前Realm对象，保证一个线程中只存在一个Realm对象。

使用RealmManager管理当前Realm对象

总结

Realm主要有两个优点：

对象就是表，属性就是字段，不需要额外的设置（相比GreenDao更简单）。
相比其他移动端数据库框架，性能更加卓越，存取速度很快。

Realm也有两个缺点：

不支持继承父类对象，所有Realm类都必须继承RealmObject（或者实现RealmModel接口）
realm对象只能在创建的线程使用，不允许跨线程访问realm对象。