作者：郭霖
原文作者：帶心情去旅行
原文地址：http://www.lxweimin.com/u/769d3d3a9d4b
介紹
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 還提供了一個輕量級的數據庫查看工具，在Mac Appstore 可以下載“Realm Browser”這個工具，開發者可以查看數據庫當中的內容，執行簡單的插入和刪除數據的操作。（windows上還不清楚）
條件
- 目前不支持Android以外的Java
- Android Studio >= 1.5.1
- 較新的Android SDK版本
- JDK version >=7.
- 支持API 9(Android 2.3)以及之后的版本
使用
加入依賴
在 project 的 build 中加入依賴：
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'io.realm:realm-gradle-plugins:2.2.1'
}
}
在 module 中加入:
apply plugin: 'realm-android'
Realm從v1.0.0后，不支持Ecilpse，我們推薦使用Android Studio
創建model
創建一個 User 類，需要繼承 RealmObject。支持 public, protected 和 private 的類以及方法：
public class User extend RealmObject {
private String name;
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age){
this.age = age;
}
}
除了直接繼承于 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
整數類型 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修飾會導致編譯失敗。
非基本數據類型不需要使用注解 @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
RealmConfiguration config = new RealmConfiguration.Builder()
.name("myrealm.realm") //文件名
.schemaVersion(0) //版本號
.build();
Realm realm = Realm.getInstance(config);
創建非持久化的Realm，也就是保持在內存中，應用關閉后就清除了。
RealmConfiguration myConfig = new RealmConfiguration.Builder(context)
.name("myrealm.realm")//保存在內存中
.inMemory() .build();
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方法插入數據
mRealm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
User user = realm.createObject(User.class);
user.setName("Gavin");
user.setAge(23);
}
});
在execute方法中執行插入操作
注意：如果在UI線程中插入過多的數據，可能會導致主線程擁塞。
- 使用copyToRealmOrUpdate或copyToRealm方法插入數據
當Model中存在主鍵的時候，推薦使用copyToRealmOrUpdate方法插入數據。如果對象存在，就更新該對象；反之，它會創建一個新的對象。若該Model沒有主鍵，使用copyToRealm方法，否則將拋出異常。
final User user = new User();
user.setName("Jack");
user.setId("2");
mRealm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
realm.copyToRealmOrUpdate(user);
}
});
- 如果你用的是這樣的model
public class User2 extends RealmObject {
public String name;
public int age;
}
就這樣寫
mRealm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
User2 user = realm.createObject(User2.class);
user.name = "Micheal";
user.age = 30;
}
});
- 如果User還有其他屬性是，比如養了只Dog：
public class User extends RealmObject {
private String name;
private int age;
private Dog dog;
//getters and setters
}
需要在User中加入該屬性
private RealmList<Dog> dogs;
插入數據
@Override
public void execute(Realm realm) {
User user = realm.createObject(User.class);
user.setName("Gain");
user.setAge(23);
Dog dog1 = realm.createObject(Dog.class);
dog1.setAge(1);
dog1.setName("二哈");
user.getDogs().add(dog1);
Dog dog2 = realm.createObject(Dog.class);
dog2.setAge(2);
dog2.setName("阿拉撕家");
user.getDogs().add(dog2);
}
});
- 上面都是用可executeTransaction方法插入數據，還有另一種方法可以用于插入數據——beginTransaction和commitTransaction
mRealm.beginTransaction();//開啟事務
User user = mRealm.createObject(User.class);
user.setName("Gavin");
user.setId("3");
mRealm.commitTransaction();//提交事務
在插入前，先調用beginTransaction()，完成后調用commitTransaction()即可。
注意：在UI和后臺線程同時開啟創建write的事務，可能會導致ANR錯誤。為了避免該問題，可以使用executeTransactionAsync來實現。
- 使用executeTransactionAsync
該方法會開啟一個子線程來執行事務，并且在執行完成后進行結果通知。
RealmAsyncTask transaction = mRealm.executeTransactionAsync(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
User user = realm.createObject(User.class);
user.setName("Eric");
user.setId("4");
}
});
還可以加入監聽
RealmAsyncTask transaction = mRealm.executeTransactionAsync(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
User user = realm.createObject(User.class);
user.setName("Eric");
user.setId("4");
}
}, new Realm.Transaction.OnSuccess() {
@Override
public void onSuccess() {
//成功回調
}
}, new Realm.Transaction.OnError() {
@Override
public void onError(Throwable error) {
//失敗回調
}
});
注意：如果當Acitivity或Fragment被銷毀時，在OnSuccess或OnError中執行UI操作，將導致程序奔潰 。用RealmAsyncTask .cancel();可以取消事務**
在onStop中調用，避免crash
public void onStop () {
if (transaction != null && !transaction.isCancelled()) {
transaction.cancel();
}
}
- JSON
Realm還是個很nice的功能就是將Json字符串轉化為對象，厲害了我的Realm
（直接借用官方的例子）
// 一個city model
public class City extends RealmObject {
private String city;
private int id;
// getters and setters left out ...
}
// 使用Json字符串插入數據
realm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
realm.createObjectFromJson(City.class, "{ city: \"Copenhagen\", id: 1 }");
}
});
// 使用InputStream插入數據
realm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
try {
InputStream is = new FileInputStream(new File("path_to_file"));
realm.createAllFromJson(City.class, is);
} catch (IOException e) {
throw new RuntimeException();
}
}
});
Realm 解析 JSON 時遵循如下規則：
- 使用包含空值（null）的 JSON 創建對象;
- 對于非必須（可為空值的屬性），設置其值為 null;
- 對于必須（不可為空值的屬性），拋出異常;
- 使用包含空值（null）的 JSON 更新對;
- 對于非必須（可為空值的屬性），設置其值為 nul;
- 對于必須（不可為空值的屬性），拋出異常;
- 使用不包含對應屬性的 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
RealmResults<User> userList = mRealm.where(User.class)
.equalTo("name", "Gavin")
.findAllAsync();
值得注意的是，這里并不會馬上查到數據，是有一定延時的。也就是說，你馬上使用userList的時候，里面是沒有數據的。可以注冊RealmChangeListener監聽器，或者使用isLoaded()方法，判斷是否查詢完成
if (result.isLoaded()) {
// 完成查詢
}
findFirst ——查詢第一條數據
例：查詢User表中的第一條數據
User user2 = mRealm.where(User.class).findFirst();
equalTo ——根據條件查詢
例：得到name為Gavin的用戶列表。
RealmResults<User> userList = mRealm.where(User.class)
.equalTo("name", "Gavin").findAll();
如果User中還有Dog屬性，希望根據Dog的條件來獲取用戶：
例：查詢dogs.name為二哈的User
RealmResults<User> userList = mRealm.where(User.class)
.equalTo("dogs.name", "二哈").findAll();
得到有養有dogs.name為"二哈"的用戶列表（這里的dogs是User表中的屬性名）
equalTo ——多條件查詢
當然，我們還經常要用到多條件的查詢的功能。
例：找到用戶名為“Gavin”，且dogs.name為“二哈”的User
RealmResults<User> userList = mRealm.where(User.class)
.equalTo("name", "Gavin").findAll();
RealmResults<User> userList = user5.where()
.equalTo("dogs.name", "二哈").findAll();
上面先找到name為“Gavin”的User列表，然后再得到的結果中查詢dogs.name為“二哈”
覺得這樣寫太麻煩？我也是這樣想的，所以還可以這樣寫
RealmResults<User> userList = mRealm.where(User.class)
.equalTo("name", "Gavin")
.equalTo("dogs.name", "二哈")
.findAll();
是不是很清爽~~~
更多查詢條件
上面就展示了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”的用戶
RealmQuery<User> query = mRealm.where(User.class);
query.equalTo("name", "Gavin");
query.or().equalTo("name", "Eric");
RealmResults<User> userList = query.findAll();
這種情況下就要用到or()方法
這么一大串，你又覺得麻煩了？沒事，繼續簡化。
RealmResults<User> userList = mRealm.where(User.class)
.equalTo("name", "Gavin")
.or().equalTo("name", "Eric")
.findAll();
Tip：查詢的時候你不用當心得到的RealmResults為null。如果查詢的結果為空，那么RealmResults的size為0
排序
查詢結束后，還可以進行排序，就像這樣：
RealmResults<User> userList = mRealm.where(User.class) .findAll();
result = result.sort("age"); //根據age，正序排列
result = result.sort("age", Sort.DESCENDING);//逆序排列
聚合
RealmResult自帶一些聚合方法：
RealmResults<User> results = realm.where(User.class).findAll();
long sum = results.sum("age").longValue();
long min = results.min("age").longValue();
long max = results.max("age").longValue();
double average = results.average("age");
long matches = results.size();
改
mRealm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
//先查找后得到User對象
User user = mRealm.where(User.class).findFirst();
user.setAge(26);
}
});
修改也是需要在事務中操作。
使用查詢語句得到數據，然后將內容改了即可。
刪除
使用deleteFromRealm()
//先查找到數據
final RealmResults<User> userList = mRealm.where(User.class).findAll();
mRealm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
userList.get(0).deleteFromRealm();
}
});
使用deleteFromRealm(int index)
mRealm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
userList.deleteFromRealm(0);
}
});
更多方法：
userList.deleteFirstFromRealm(); //刪除user表的第一條數據
userList.deleteLastFromRealm();//刪除user表的最后一條數據
results.deleteAllFromRealm();//刪除user表的全部數據
版本升級
當數據結構發生變化是，需要升級數據庫。對于Realm來說，數據庫升級就是遷移操作，把原來的數據庫遷移到新結構的數據庫。（體驗：略麻煩）
例1：User類發生變化，移除age，新增個@Required的id字段。
User版本：version 0
String name;
int age;
User版本：version 1
@Required
String id;
String name;
創建遷移類CustomMigration，需要實現RealmMigration接口。執行版本升級時的處理：
/**
* 升級數據庫
*/
class CustomMigration implements RealmMigration {
@Override
public void migrate(DynamicRealm realm, long oldVersion, long newVersion) {
RealmSchema schema = realm.getSchema();
if (oldVersion == 0 && newVersion == 1) {
RealmObjectSchema personSchema = schema.get("User");
//新增@Required的id
personSchema
.addField("id", String.class, FieldAttribute.REQUIRED)
.transform(new RealmObjectSchema.Function() {
@Override
public void apply(DynamicReal
mObject obj) {
obj.set("id", "1");//為id設置值
}
})
.removeField("age");//移除age屬性
oldVersion++;
}
}
}
使用Builder.migration升級數據庫，將版本號改為1（原版本號：0）。當Realm發現新舊版本號不一致時，會自動使用該遷移類完成遷移操作。
RealmConfiguration config = new RealmConfiguration.Builder()
.name("myrealm.realm") //文件名
.schemaVersion(1)
.migration(new CustomMigration())//升級數據庫
.build();
RxJava
對于這么火的RxJava，Realm又怎么會放過他。
Realm 包含了對 RxJava 的原生支持。如下類可以被暴露為一個 Observable：Realm, RealmResults, RealmObject, DynamicRealm 和 DynamicRealmObject。
（直接用一個官方的例子）
Realm realm = Realm.getDefaultInstance();
GitHubService api = retrofit.create(GitHubService.class);
realm.where(Person.class).isNotNull("username").findAllAsync().asObservable()
.filter(persons.isLoaded)
.flatMap(persons -> Observable.from(persons))
.flatMap(person -> api.user(person.getGithubUserName())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(user -> showUser(user));
這里使用asObservable輕松轉換成RxJava中的Observable，使用.filter(persons.isLoaded)來判斷是否已查詢完成。到這里，熟悉RxJava的同學應該已經看明白了~~。可能還有人會一臉懵逼，->? 這是什么鬼？哈哈，這叫Lambda，有時間可以去看看。
