巨核信息共享中心

Realm 数据库基础使用和注意事项

—

由

Robin Yang
于 , ,

Realm is a mobile database: a replacement for SQLite & ORMs

目前 Realm-Java 最新版本是 10.8.0，安卓项目最开始使用的是从 5 开始，然后是 6 到目前的版本 10，从 5 到 10 版本使用上面的变化差异不大。因此只要熟悉 10 版本即可

一、RealmConfiguration

Realm DB 配置参数对于使用 Realm 很重要

val builder = RealmConfiguration.Builder()
builder.modules(ExampleModule())
    .assetFile("example.realm")
    .directory(File(context.dataDir, "xxx"))
    .allowWritesOnUiThread(true)
    .allowQueriesOnUiThread(true)
    .name("example.realm")
    .schemaVersion(10)
val configuration = builder.build()

1.1Modules

Realm 比较重要基础概念 Modules，Modules 用来指定 Realm DB 中的表，对应 java 或者 kotlin 里面就是 class，这个 class 通过继承 RealmObject 来实现，当然也可以通过接口实现，具体可以参看 Android 官方文档

@RealmModule(classes = [TargetTags::class])
class ExampleModule

以上就一个很简单的 Module 指定，这个 DB 包含一张表，表明叫做 TargetTags

public class TargetTags extends RealmObject {
    @PrimaryKey
    private String objectId;
    @Index
    private String targetId;
    @Index
    private String tag;

    public String getObjectId() {
        return objectId;
    }

    public void setObjectId(String objectId) {
        this.objectId = objectId;
    }

    public String getTargetId() {
        return targetId;
    }

    public void setTargetId(String targetId) {
        this.targetId = targetId;
    }

    public String getTag() {
        return tag;
    }

    public void setTag(String tag) {
        this.tag = tag;
    }
}

这个类实现了 RealmObject，对外提供了基础方法，并且使其一个字段声明为 primaryKey。当生成Realm DB 文件时，里面就会含有 TargetTags 的表，其中字段有 objectId、targetId、tag

1.2 schemaVersion

数据库版本号，类似于 Sqlite 的版本号，主要目的是针对字段变更、表的增加或者删除的。
对于字段的变更安卓不像 ios 那么方便，即使版本号增加也还是需要手动迁移，因此需要特别注意。
Realm DB在使用的时候就会对字段进行相应检查，如果检查不通过就会对外抛出异常，并且提示使用者哪里出问题，一般表现为该有的字段没有做对应迁移

1.3 directory

数据库目录，如果不指定的话默认就会在应用的 data 目录下面，最好指定对应目录，方便数据库文件的管理及迁移操作，尤其 Realm 打开 DB 文件时候会生成多个辅助文件，为了方便管理务必指定文件路径

1.4 name

DB 在数据库目录下面的文件名称，为了方便管理也最好指定

1.5 assetFile

可以让 Realm 直接指定读取 asset 目录下面准备好的 realm 文件，其实现原理也是通过拷贝 asset 目录下面的资源文件到指定目录。如果需要做比较特殊的迁移操作，或者说废弃掉当前目录下面的 realm 文件，需要提前自行删除或者移动

1.6 migration

数据库迁移操作，用户实现 RealmMigration 接口，在这个接口的

public void migrate(@NotNull DynamicRealm realm, long oldVersion, long newVersion) {
}

方法中做相应表的迁移，有增加字段，删除字段，修改字段，为某个字段添加额外索引，另外增加表删除表也需要在这里面声明。其本身实现原理是 Realm 另外一种使用方法，这种使用方式效率较低，但是对扩充字段比较方便，有兴趣的可以去查看文档 DynamicRealm 使用

1.7 其它

.allowWritesOnUiThread(true)
.allowQueriesOnUiThread(true)
.compactOnLaunch()

protected RealmConfiguration(File realmPath,
        @Nullable String assetFilePath,
        @Nullable byte[] key,
        long schemaVersion,
        @Nullable RealmMigration migration,
        boolean deleteRealmIfMigrationNeeded,
        OsRealmConfig.Durability durability,
        RealmProxyMediator schemaMediator,
        @Nullable RxObservableFactory rxObservableFactory,
        @Nullable FlowFactory flowFactory,
        @Nullable Realm.Transaction initialDataTransaction,
        boolean readOnly,
        @Nullable CompactOnLaunchCallback compactOnLaunch,
        boolean isRecoveryConfiguration,
        long maxNumberOfActiveVersions,
        boolean allowWritesOnUiThread,
        boolean allowQueriesOnUiThread) {}

realm 使用配置地方有很多，重要的还有能否在主线程写入和读取等等。可以在有需要的时候再去查看

二 Realm 使用

使用 RealmConfiguration 可以创建空的 Realm DB 文件，也可以通过拷贝方式拷贝现成 Realm 到指定目录，然后通过

Realm.getInstance(configuration)

直接就可以打开 Realm 对其中的表做数据库标准操作：增、删、改、查

不同于一般的关系型数据库，面向对象型数据库操作都是以对象为基本单位，尤其是修改某个属性时操作比较特殊，直接操作对象本身，这些操作可以去查看官方安卓文档
Realm 还有其他不少，例如删除数据库、数据库数据变更监听等，官方文档写得更加详细

三、transaction

transaction 中文为事务，数据库常用的操作，是旨在保证插入安全，尤其是数据插入失败时，保证数据库数据安全，Realm 的所有写入都需要放在 transaction 中，并且 transaction 中不能套 transaction

在特殊情况时，如果不确定当前写入操作是否在 transaction 需要进行额外判断

realm.isInTransaction()


因此需要进行比较复杂操作时，最好使用封装好的工具方法进行插入，防止出现事务操作中套事务的方式出现异常问题

四、Realm Thread

MongoDB Realm enables simple and safe multithreaded code when you follow these three rules:
Avoid writes on the UI thread if you write on a background thread:
You can write to a realm from any thread, but there can be only one writer at a time. Consequently, write transactions block each other. A write on the UI thread may result in your app appearing unresponsive while it waits for a write on a background thread to complete. If you are using Realm Sync, avoid writing on the UI thread as Sync writes on a background thread.
Don’t pass live objects, collections, or realms to other threads:
Live objects, collections, and realm instances are thread-confined: that is, they are only valid on the thread on which they were created. Practically speaking, this means you cannot pass live instances to other threads. However, Realm Database offers several mechanisms for sharing objects across threads.
Don’t lock to read:
Realm Database’s Multiversion Concurrency Control (MVCC) architecture eliminates the need to lock for read operations. The values you read will never be corrupted or in a partially-modified state. You can freely read from realms on any thread without the need for locks or mutexes. Unnecessarily locking would be a performance bottleneck since each thread might need to wait its turn before reading.

4.1.Realm 对象目前是不能跨线程

在某个线程创建，如果某个线程退出就需要把 Realm 对象关闭，通过调用

realm.close();

Realm 本身实现了一套比较比较复杂的缓存机制，因此每次调用 Realm.getInstance(configuration) 都首先从缓存里面去查找，如果没有才会创建新的，当然不同线程缓存不同，在主线程操作 Realm 最好保证 Realm 存活不要轻易关闭，非主 UI 线程如果线程不是永久存活，就需要考虑 Realm 关闭，否则一是会出现 Ream 不能完全被关闭一直在占用内存，另外一种情况就是 Realm 缓存数目一直在增加，可能会超过上限造成崩溃。

4.2.Realm 查询得到 RealmObject 不能跨线程

通过 Realm 查询到的 RealmObject 不能跨线程，当然目前 Realm SDK 提供了几种跨线程操作

  • To modify the data on two threads, query for the object on both threads using a primary key.
  • To send a fast, read-only view of an object to other threads, freeze the object.
  • To keep and share many read-only views of the object in your app, copy the object from the realm.
  • To react to changes made on any thread, use notifications.
  • To see changes from other threads in the realm on the current thread, refresh your realm instance (event loop threads refresh automatically).

比较重要的思路，一个是通过 id 查找，另外通过 realm 拷贝方式，还可以通过比较高级方式 freeze 方式得到的查询结果，realm 拷贝对内存和 cpu 消耗会比较大，不适合那些高频操作，freeze 会对 realm DB 文件增长影响有点大，因此根据具体使用场景决定使用方向

五、Refreshing Realms

刷新 realm 算是比较高阶操作了，尤其是牵涉到后台线程插入 DB 的时候，如果希望主线程立马能够取到刚刚插入或者更新的数据，那需要在主线程刷新 realm

realm.refresh();

当然 Realm 系统提供了一套自动刷新的机制，前提是当前线程有 looper，如果没有 looper 直接调用刷新逻辑会抛异常。

不管在后台大批量插入数据，又或者小批量插入数据，如果发现主 UI 界面有概率性部分数据显示异常，就需要考虑刷新 realm 数据库了，当然刷新会消耗系统性能，不能频繁操作。

六、Encrypt a Realm

加密 DB，这种操作防止数据轻易外泄，只需要在 RealmConfiguration 中指定即可，当然已经加密的 DB 不能通过没有指定秘钥的 RealmConfiguration 打开，切记。

七、其它

Realm 自从被 MongoDB 收购后增加了不少数据同步操作，尤其是对写入和读取在异步线程中操作判断越来越严格。不管是写入还是读取都是比较消耗性能的，写入更加耗性能。
不建议把大批量的写入和读取操作放在主 UI 线程，这会造成界面卡顿，可以考虑把重量级写入放在后台，回到主 UI 线程直接刷新数据库，又或者可以通过 realm 提供的回调方式

RealmObjectChangeListener

单纯的 query 对象基本不怎么消耗手机性能， realm 实现了一套 lazy load 方式，但是如果还想要去读取对象里面字段，尤其是比较大批量读取字段的时候，这个时候是非常耗 CPU 时间，有兴趣的可以去查看 realm 官方文档。

总结：Realm 为我们提供了比较便利的面向对象级别的数据库操作，好处是上手简单，基本只要稍微看过文档，知道基本使用方式就可以开发，坏处是，随着开发量越来越多，realm 到后期使用会越来越复杂，会牵涉到线程，插入读取，性能损耗之类的，是一种易上手但很难精的数据库。使用过程中一定要谨慎。

官方安卓 Realm: https://docs.mongodb.com/realm/sdk/android/
MongoDB Realm：https://www.mongodb.com/zh-cn/realm
旧有 Realm：https://docs.mongodb.com/realm-legacy/docs/java/latest/index.html#getting-started