Android Realm详解

今日科技快讯

近日，乐视网、乐视影业、乐视致新与战略投资者嘉睿汇鑫（融创中国实际控制）达成150亿投资协议。在完成投资后，嘉睿汇鑫持有上市公司乐视网8.61%的股权；持有上市公司乐视网控股子公司乐视致新33.4959%的股权，并成为其第二大股东；持有乐视影业15%股权，为乐视影业第二大股东。此项投资案之后，一直深陷资金链断裂危机的乐视终于可以喘口气了。

作者简介

本篇是 带心情去旅行 的第三篇投稿，详细的讲解了数据库引擎 Realm 的常规用法。希望能帮助到大家。因为篇幅有限，文章中很多参考资料这里并没有贴出，感兴趣的朋友可以点击最后 阅读原文 查看。

带心情去旅行 的博客地址：

http://www.jianshu.com/u/769d3d3a9d4b

介绍

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

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

https://realm.io/cn/news/jp-simard-realm-core-database-engine

https://www.zybuluo.com/pockry/note/453560

优势

如果在在使用它时候，连它的优势在哪都不知道的话就有点说不过去了。

• 易用：Ream 不是在SQLite基础上的ORM，它有自己的数据查询引擎。并且十分容易使用。

• 快速：由于它是完全重新开始开发的数据库实现，所以它比任何的ORM速度都快很多，甚至比SLite速度都要快。

• 跨平台：Realm 支持 iOS & OS X (Objective‑C & Swift) & Android。我们可以在这些平台上共享Realm数据库文件，并且上层逻辑可以不用任何改动的情况下实现移植。

• 高级：Ream支持加密，格式化查询，易于移植，支持JSON，流式api，数据变更通知等高级特性

• 可视化：Realm 还提供了一个轻量级的数据库查看工具，在Mac Appstore 可以下载“Realm Browser”这个工具，开发者可以查看数据库当中的内容，执行简单的插入和删除数据的操作。（windows上还不清楚）

条件

• 目前不支持Android以外的Java

• Android Studio >= 1.5.1

• 较新的Android SDK版本

• JDK version >=7.

• 支持API 9(Android 2.3)以及之后的版本

使用

加入依赖

在 project 的 build 中加入依赖：

在 module 中加入:

apply plugin: 'realm-android'

Realm从v1.0.0后，不支持Ecilpse，我们推荐使用Android Studio

创建model

创建一个 User 类，需要继承 RealmObject。支持 public, protected 和 private 的类以及方法：

除了直接继承于 RealmObject 来声明 Realm 数据模型之外，还可以通过实现 RealmModel接口 并添加 @RealmClass 修饰符来声明。

@RealmClass
public class User implements RealmModel {
    ...
}

• 支持的属性

boolean, byte, short, int, long, float, double, String, Date 和 byte[], RealmObject, RealmList<? extends RealmObject>

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

Tip：整数类型 short、int 和 long 都被映射到 Realm 内的相同类型（实际上为 long ）

• @PrimaryKey——表示该字段是主键

使用过数据库的同学应该看出来了，PrimaryKey 就是主键。使用 @PrimaryKey 来标注，字段类型必须是字符串（String）或整数（byte，short，int或long）以及它们的包装类型（Byte,Short, Integer, 或 Long）。不可以存在多个主键，使用字符串字段作为主键意味着字段被索引（注释 @PrimaryKey 隐式地设置注释 @Index）。

@PrimaryKey
private String id;

• @Required——表示该字段非空

在某些情况下，有一些属性是不能为null的。使用@Required可用于用于强行要求其属性不能为空，只能用于Boolean, Byte, Short, Integer, Long, Float, Double, String, byte[] 和 Date。在其它类型属性上使用 @Required修饰会导致编译失败。

Tip：非基本数据类型不需要使用注解 @Required，因为他们本身就不可为空。

@Required
private String name;

• @Ignore——表示忽略该字段

被添加 @Ignore 标签后，存储数据时会忽略该字段。

@Ignore
private String name;

• @Index——添加搜索索引

为字段添加搜索索引，这样会使得插入的速度变慢，数据量也变得更大。不过在查询速度将变得更快，建议只在优化读取性能的特定情况时添加索引。支持索引：String，byte，short，int，long，boolean和Date字段。

注意：如果你创建Model并运行过，然后修改了Model。那么就需要升级数据库，否则会抛异常。升级方式后面会提到。

初始化

使用默认配置

Realm.init(this);
Realm mRealm = Realm.getDefaultInstance();

这时候会创建一个叫做 default.realm 的Realm文件，一般来说，这个文件位于/data/data/包名/files/。通过 realm.getPath() 来获得该Realm的绝对路径。

注意：模拟器上运行时，Realm.getDefaultInstance() 抛出异常，真机上没问题（不知何故）

当然，我们还可以使用 RealmConfiguration 来配置Realm

创建非持久化的 Realm，也就是保持在内存中，应用关闭后就清除了。

RealmConfiguration 支持的方法：

• Builder.name : 指定数据库的名称。如不指定默认名为default。

• Builder.schemaVersion : 指定数据库的版本号。

• Builder.encryptionKey : 指定数据库的密钥。

• Builder.migration : 指定迁移操作的迁移类。

• Builder.deleteRealmIfMigrationNeeded : 声明版本冲突时自动删除原数据库。

• Builder.inMemory : 声明数据库只在内存中持久化。

• build : 完成配置构建。

关闭Realm

记得使用完后，在 onDestroy 中关闭Realm

@Override protected void onDestroy() { 
    super.onDestroy();
    // Close the Realm instance. 
    realm.close(); 
}

增

写入操作需要在事务中进行，可以使用 executeTransaction 方法来开启事务。

• 使用 executeTransaction 方法插入数据

在 execute 方法中执行插入操作：

注意：如果在UI线程中插入过多的数据，可能会导致主线程拥塞。

• 使用 copyToRealmOrUpdate 或 copyToRealm 方法插入数据

当Model中存在主键的时候，推荐使用 copyToRealmOrUpdate 方法插入数据。如果对象存在，就更新该对象；反之，它会创建一个新的对象。若该Model没有主键，使用 copyToRealm 方法，否则将抛出异常。

• 如果你用的是这样的modle

public class User2 extends RealmObject {
   public String name;
   public int age;
}

就这样写：

• 如果User还有其他属性是，比如养了只Dog

public class Dog extends RealmObject {
   private String name;
   private int age;
   //getters and setters
}

对应的User属性中加入Dog类

public class User extends RealmObject {
   private String name;
   private int age;
   private Dog dog;
   //getters and setters
}

如果你养了不止一只，你养了二哈、阿拉撕家...那你就要用到 RealmList 了。在User中加入该属性：

private RealmList<Dog> dogs;

插入数据

• 上面都是用可 executeTransaction 方法插入数据，还有另一种方法可以用于插入数据——beginTransaction 和 commitTransaction

在插入前，先调用 beginTransaction()，完成后调用 commitTransaction() 即可。

注意：在UI和后台线程同时开启创建write的事务，可能会导致ANR错误。为了避免该问题，可以使用executeTransactionAsync来实现。

• 使用 executeTransactionAsync

该方法会开启一个子线程来执行事务，并且在执行完成后进行结果通知。

还可以加入监听：

注意：如果当 Acitivity 或 Fragment 被销毁时，在 OnSuccess 或 OnError 中执行UI操作，将导致程序奔溃 。用 RealmAsyncTask .cancel();可以取消事务在 onStop 中调用，避免 crash。

• JSON

Realm还是个很nice的功能就是将Json字符串转化为对象，厉害了我的Realm（直接借用官方的例子）

Realm 解析 JSON 时遵循如下规则：

• 使用包含空值（null）的 JSON 创建对象：

• 对于非必须（可为空值的属性），设置其值为 null；

• 对于必须（不可为空值的属性），抛出异常；

• 使用包含空值（null）的 JSON 更新对象：

• 对于非必须（可为空值的属性），设置其值为 null；

• 对于必须（不可为空值的属性），抛出异常；

• 使用不包含对应属性的 JSON： * 该属性保持不变

查

查找操作就比插入方便多了，并不需在事务中操作，直接查询即可。

• findAll ——查询

例：查询所有的User

RealmResults<User> userList = mRealm.where(User.class).findAll();

这里使用 RealmResults 来接受查询到的结果，突然出现的 RealmResults 可能会让人懵逼。看看他的源码，发现 RealmResults 继承了 AbstractList，而 AbstractList 又实现了 List接口。好吧，原来实现了我们熟悉的List接口。

public final class RealmResults<E extends RealmModel> extends AbstractList<E>

public abstract class AbstractList<E> extends AbstractCollection<E> implements List<E>

注意：RealmResults虽然实现了List接口，不过有很多方法是不能用的。比如add、addAll、remove、clear等，调用后会直接抛异常。不过也不用当心误用这些方法，因为它们都被标记为 @Deprecated 了。

• findAllAsync——异步查询

当数据量较大，可能会引起ANR的时候，就可以使用 findAllAsync

值得注意的是，这里并不会马上查到数据，是有一定延时的。也就是说，你马上使用 userList 的时候，里面是没有数据的。可以注册 RealmChangeListener 监听器，或者使用 isLoaded() 方法，判断是否查询完成

if (result.isLoaded()) {
   // 完成查询
}

• findFirst ——查询第一条数据

例：查询 User 表中的第一条数据

User user2 = mRealm.where(User.class).findFirst();

• equalTo ——根据条件查询

例：得到 name 为 Gavin 的用户列表：

如果 Use r中还有 Dog 属性，希望根据 Dog的条件来获取用户。例：查询 dogs.name 为二哈的User：

得到有养有 dogs.name 为"二哈"的用户列表（这里的 dogs 是 Use r表中的属性名）

• equalTo ——多条件查询

当然，我们还经常要用到多条件的查询的功能。例：找到用户名为“Gavin”，且dogs.name为“二哈”的User

上面先找到 name 为 “Gavin” 的 User列表，然后再得到的结果中查询 dogs.name 为“二哈”
觉得这样写太麻烦？我也是这样想的，所以还可以这样写：

是不是很清爽~~~

• 更多查询条件

上面就展示了 equalTo 的用法。当然，查询还有更多的用法，我就不一一示例了。已知的方法如下：

sum()：对指定字段求和。

average()：对指定字段求平均值。

min(): 对指定字段求最小值。

max() : 对指定字段求最大值。count : 求结果集的记录数量。

findAll(): 返回结果集所有字段，返回值为RealmResults队列

findAllSorted() : 排序返回结果集所有字段，返回值为RealmResults队列

between(), greaterThan(),lessThan(), greaterThanOrEqualTo() & lessThanOrEqualTo()

equalTo() & notEqualTo()

contains(), beginsWith() & endsWith()

isNull() & isNotNull()

isEmpty()& isNotEmpty()

• RealmQuery 以及 or 的使用

在使用 where() 方法时，能得到一个 RealmQuery 对象，使用方法如下。例：查询 name为“Gavin”和“Eric”的用户：

这种情况下就要用到 or() 方法。这么一大串，你又觉得麻烦了？没事，继续简化。

Tip：查询的时候你不用当心得到的 RealmResults 为 null。如果查询的结果为空，那么 RealmResults 的 size 为 0。

• 排序

查询结束后，还可以进行排序，就像这样：

• 聚合

RealmResult 自带一些聚合方法：

改

修改也是需要在事务中操作。使用查询语句得到数据，然后将内容改了即可。

删

• 使用 deleteFromRealm()

• 使用 deleteFromRealm(int index)

• 更多方法

版本升级

当数据结构发生变化是，需要升级数据库。对于 Realm 来说，数据库升级就是迁移操作，把原来的数据库迁移到新结构的数据库。（体验：略麻烦）

例1：User类发生变化，移除age，新增个@Required的id字段。

User版本：version 0

String name;
int age;

User版本：version 1

@Required
String id;
String name;

创建迁移类 CustomMigration，需要实现 RealmMigration 接口。执行版本升级时的处理：

使用 Builder.migration 升级数据库，将版本号改为1（原版本号：0）。当Realm发现新旧版本号不一致时，会自动使用该迁移类完成迁移操作。

例2：加入Dog类，User中加入Dog集合。

User版本：version 1

@Required
String id;
String name;

User版本：version 2

@Required
private String id;
private String name;
private RealmList<Dog> dogs;

Dog类

public class Dog extends RealmObject {
    private String name;
    private int age;
}

在迁移类 CustomMigration 中，继续添加处理方法。

• 更多用法——RealmObjectSchema

• 更多用法——DynamicRealmObject

疑问：我在 debug 时发现这样的数据，如图：

什么，dogs、id、name的值怎么都是null？这~~

开始我还以为升级时数据丢失，不过在图中 userList 第0条数据的右边看到了我的数据，于是我展开了里面的内容，如图：

好吧，他并不是我想象中的那种存法，我已经不知道他内部是怎么实现的了。

加密(官方原文)

Realm 文件可以通过传递一个512位（64字节）的密钥参数给 Realm.getInstance().encryptionKey() 来加密存储在磁盘上。

保证了所有永久性存储在磁盘上的数据都是通过标准 AES-256 加密的。每次创建新的 Realm 实例的时候，都需要提供相同的密钥。参考

examples/encryptionExample

https://github.com/realm/realm-java/tree/master/examples/encryptionExample

这个例子演示了如何通过 Android KeyStore 来安全地存储密钥。

适配器Adapter(官方原文)

Realm提供了一些抽象的工具类来方便地将 OrderedRealmCollection
（RealmResults 和 RealmList 都实现了这个接口）展示到UI控件上。

• RealmBaseAdapter 可以与 ListView 配合使用。参见示例.

https://github.com/realm/realm-android-adapters/blob/master/example/src/main/java/io/realm/examples/adapters/ui/listview/MyListAdapter.java

• RealmRecyclerViewAdapter可以与 RecyclerView 配合使用。参见示例.

https://github.com/realm/realm-android-adapters/blob/master/example/src/main/java/io/realm/examples/adapters/ui/recyclerview/MyRecyclerViewAdapter.java

你需要在 app 的 build.gradle中添加额外的依赖以使用这些适配器。

dependencies {
    compile 'io.realm:android-adapters:1.4.0'
}

Intents(官方原文)

你不可以直接通过 intent 传递 RealmObject，建议你只传递 RealmObject 的标识符。举个常用例子，假如你的对象拥有一个主键，请通过 intent 的 bundle 来传递这个主键的值。

在接受方（Activity、Service、IntentService、BroadcastReceiver及其它）从 bundle中解析出这个主键然后打开 Realm 查询得到这个 RealmObject。

可以参考：

threading example

https://github.com/realm/realm-java/tree/master/examples/threadExample

中的 Object Passing部分。该示例展示了在安卓开发中常用的如何传递 id 并且得到对应的 RealmObject。

RxJava

对于这么火的RxJava，Realm又怎么会放过他。

Realm 包含了对 RxJava 的原生支持。如下类可以被暴露为一个 Observable：Realm, RealmResults, RealmObject, DynamicRealm 和 DynamicRealmObject。（直接用一个官方的例子）

这里使用 asObservable 轻松转换成 RxJava 中的 Observable，使用 .filter(persons.isLoaded) 来判断是否已查询完成。到这里，熟悉RxJava的同学应该已经看明白了~~。可能还有人会一脸懵逼，->? 这是什么鬼？哈哈，这叫 Lambda，有时间可以去看看。

终于写完了~~~说好易用的，没想到内容居然这么多。

更多

每天学习累了，看些搞笑的段子放松一下吧。关注最具娱乐精神的公众号，每天都有好心情。

如果你有好的技术文章想和大家分享，欢迎向我的公众号投稿，投稿具体细节请在公众号主页点击“投稿”菜单查看。

欢迎长按下图 -> 识别图中二维码或者扫一扫关注我的公众号：