Android Realm Example 示例

Android 数据库主要分三类:

  1. SQLite;
  2. 基于 SQLite 的封装;
  3. 其它数据库引擎。

各有优缺,可参考 Android目前流行三方数据库ORM分析及对比,这里选择 Realm 演示简单的 CRUD。选择 Realm 的一个原因是其在 StackOverflow 上的问题数和 SQLite 在同一个数量级,遇到的问题估计都可以找 StackOverflow

0. Prepare

首先添加相关依赖,在项目配置文件的依赖项中添加如下内容:

classpath "io.realm:realm-gradle-plugin:4.1.1" // 当前最新版 4.1.1

在应用模块配置文件中注明使用 Realm 插件:

apply plugin: 'realm-android'

1. Layout

写一个简单的布局,以便演示,四个按钮,只有一个是写操作,其余三个为查询,单击每条记录将其删除。
activity_realm.xml

<?xml version="1.0" encoding="utf-8"?>
<android.support.constraint.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:app="http://schemas.android.com/apk/res-auto"
  xmlns:tools="http://schemas.android.com/tools"
  android:layout_width="match_parent"
  android:layout_height="match_parent"
  tools:context="me.xandeer.examples.realm.RealmActivity">

  <android.support.v7.widget.Toolbar
    android:id="@+id/toolbar"
    app:title="@string/realm"
    android:layout_width="match_parent"
    android:layout_height="?attr/actionBarSize"
    android:background="?attr/colorPrimary"
    app:navigationIcon="@drawable/ic_toolbar_back" />

  <LinearLayout
    android:id="@+id/input"
    app:layout_constraintTop_toBottomOf="@+id/toolbar"
    android:layout_width="match_parent"
    android:layout_height="wrap_content">
    <EditText
      android:id="@+id/edit_name"
      android:hint="@string/name"
      android:inputType="textCapWords"
      android:layout_width="0dp"
      android:layout_weight="1"
      android:layout_height="44dp" />
    <EditText
      android:id="@+id/edit_age"
      android:hint="@string/age"
      android:inputType="number"
      android:layout_width="0dp"
      android:layout_weight="1"
      android:layout_height="44dp" />
  </LinearLayout>

  <LinearLayout
    android:id="@+id/write"
    app:layout_constraintTop_toBottomOf="@id/input"
    android:layout_width="match_parent"
    android:layout_height="wrap_content">
    <Button
      android:id="@+id/create"
      android:text="@string/create_update"
      android:layout_width="0dp"
      android:layout_weight="1"
      android:layout_height="wrap_content" />
    <Button
      android:id="@+id/all"
      android:text="@string/all"
      android:layout_width="0dp"
      android:layout_weight="1"
      android:layout_height="wrap_content" />
  </LinearLayout>

  <LinearLayout
    android:id="@+id/query"
    app:layout_constraintTop_toBottomOf="@id/write"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:orientation="horizontal">
    <Button
      android:id="@+id/find_by_name"
      android:text="@string/find_by_name"
      android:layout_width="0dp"
      android:layout_weight="1"
      android:layout_height="wrap_content" />
    <Button
      android:id="@+id/find_by_age"
      android:text="@string/find_by_age"
      android:layout_width="0dp"
      android:layout_weight="1"
      android:layout_height="wrap_content" />
  </LinearLayout>

  <ListView
    app:layout_constraintTop_toBottomOf="@+id/query"
    android:id="@+id/persons_view"
    android:layout_width="match_parent"
    android:layout_height="wrap_content" />

</android.support.constraint.ConstraintLayout>

2. Model

一个简单的继承自 RealmOjbect 的类。
Person.kt

package me.xandeer.examples.realm

import io.realm.RealmObject
import io.realm.annotations.PrimaryKey

open class Person(
    @PrimaryKey var name: String = "",
    var age: Int = 16
) : RealmObject() {
}

3. CRUD

RealmActivity.kt

3.0 Initialize

Realm 在使用前需要初始化,并获取一个当前线程的实例。

// 在 Activity 的 onCreate 中初始化
Realm.init(this)
// 也可在 Application 的 onCreate 中初始化
// Realm.init(applicationContext)

// 在当前线程获取一个默认的 Realm 实例
realm = Realm.getDefaultInstance()

3.1 Create/Update

create.setOnClickListener {
  if (edit_name.text.isNotEmpty() && edit_age.text.isNotEmpty()) {
    val name = edit_name.text.toString()
    val age = edit_age.text.toString().toInt()
    val person = Person(name, age)

    // 所有写操作都需要在 transaction 中执行
    realm.executeTransaction {
      // create or update
      it.copyToRealmOrUpdate(person)
      log("add person: ${person.name}, ${person.age}")
    }
    edit_age.setText("")
    edit_name.setText("")
  }
}

3.2 Query

all.setOnClickListener {
  val results = realm.where(Person::class.java).findAll()
  show(results)
}

// 条件查询
find_by_name.setOnClickListener {
  if (edit_name.text.isNotEmpty()) {
    val results = realm.where(Person::class.java)
        .equalTo("name", edit_name.text.toString())
        .findAll()
    show(results)
  }
}
...

private fun show(results: RealmResults<Person>) {
  persons.clear()
  results.forEach {
    persons.add("name: ${it.name}, age: ${it.age}")
  }
  (persons_view.adapter as BaseAdapter).notifyDataSetChanged()
}

3.2.1 支持的条件查询语句

  • between(), greaterThan(), lessThan(), greaterThanOrEqualTo() & lessThanOrEqualTo()
  • equalTo() & notEqualTo()
  • contains(), beginsWith() & endsWith()
  • isNull() & isNotNull()
  • isEmpty() & isNotEmpty()

3.2.2 对查询结果的操作

  • sort()
  • sum()
  • min()
  • max()
  • average()

3.3 Delete

persons_view.setOnItemClickListener { parent, _, position, _ ->
  val name = parent.getItemAtPosition(position).toString()
      .removePrefix("name: ")
      .substringBefore(", age: ")
  val person = realm.where(Person::class.java)
      .equalTo("name", name)
      .findFirst()!!
  realm.executeTransaction {
    log("delete person: ${person.name}.")
    // remove a single object
    person.deleteFromRealm()
  }
}

3.4 Change Listener

// 数据库内容变化后更新视图
realm.addChangeListener {
  val results = realm.where(Person::class.java).findAll()
  show(results)
}

3.5 Finally

要记得善后:

override fun onDestroy() {
  super.onDestroy()
  realm.removeAllChangeListeners()
  realm.close()
}

更多用法请参考 Realm Java Docs

4. Run

realm-example

5. Code Repository

Github: Android Example

6. Referrence

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

推荐阅读更多精彩内容