介紹
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-plugin:2.2.1" } }
在module中加入
apply plugin: 'realm-android' 
Realm從v1.0.0后，不支持Ecilpse，我們推薦使用Android Studio
創建model
創建一個User類，需要繼承RealmObject。支持public, protected和 private的類以及方法
public class User extends 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
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。那么就需要升級數據庫，否則會拋異常。升級方式后面會提到
### **初始化** 使用默認配置 ```java 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); } }); - 如果你用的是這樣的
modle
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 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; - 1
- 1
插入數據
@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 更新對象：
- 對於非必須（可為空值的屬性），設置其值為 null；
- 對於必須（不可為空值的屬性），拋出異常；
- 使用不包含對應屬性的 JSON： * 該屬性保持不變
查
查找操作就比插入方便多了，並不需在事務中操作，直接查詢即可。
findAll——查詢
例：查詢所有的User
RealmResults<User> userList = mRealm.where(User.class).findAll(); - 1
- 1
這里使用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> - 1
- 1
注意：
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()¬EqualTo()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(); userList = result.sort("age"); //根據age，正序排列 userList = 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(); - 例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中，繼續添加處理方法。
if (oldVersion == 1 && newVersion == 2) { //創建Dog表 RealmObjectSchema dogSchema = schema.create("Dog"); dogSchema.addField("name", String.class); dogSchema.addField("age", int.class); //User中添加dogs屬性 schema.get("User") .addRealmListField("dogs", dogSchema) .transform(new RealmObjectSchema.Function() { @Override public void apply(DynamicRealmObject obj) { //為已存在的數據設置dogs數據 DynamicRealmObject dog = realm.createObject("Dog"); dog.set("name", "二哈"); dog.set("age", 2); obj.getList("dogs").add(dog); } }); oldVersion++; } - 更多用法——
RealmObjectSchema
例：取消id必填：
personSchema.setNullable("id", true): - 1
- 1
例：移除id字段
personSchema.removeField("id"); - 1
- 1
例：重命名
personSchema..renameField("id", "userId"); - 1
- 1
- 更多用法——
DynamicRealmObject
例：獲取id
String id = obj.getString("id"); - 1
- 1
例：為字段設置值
obj.setString("name", "Gavin"); obj.setInt("id", 1); obj.setLong("id", 1); 疑問：我在debug時發現這樣的數據，如圖：
userList
什么，dogs、id、name的值怎么都是null？這~~
開始我還以為升級時數據丟失，不過在圖中userList第0條數據的右邊看到了我的數據，於是我展開了里面的內容，如圖：展開后的userListg
好吧，他並不是我想象中的那種存法，我已經不知道他內部是怎么實現的了。（還望大神賜教）
加密
（官方原文）
Realm 文件可以通過傳遞一個512位（64字節）的密鑰參數給 Realm.getInstance().encryptionKey() 來加密存儲在磁盤上。
byte[] key = new byte[64]; new SecureRandom().nextBytes(key); RealmConfiguration config = new RealmConfiguration.Builder() .encryptionKey(key) .build(); Realm realm = Realm.getInstance(config); 保證了所有永久性存儲在磁盤上的數據都是通過標准 AES-256 加密的。每次創建新的 Realm 實例的時候，都需要提供相同的密鑰。
參考 examples/encryptionExample。這個例子演示了如何通過 Android KeyStore 來安全地存儲密鑰。
適配器（Adapter）
（官方原文）
Realm提供了一些抽象的工具類來方便地將 OrderedRealmCollection
（RealmResults和 RealmList 都實現了這個借口）展示到UI控件上。
你需要在 app 的 build.gradle中添加額外的依賴以使用這些適配器。
dependencies { compile 'io.realm:android-adapters:1.4.0' } Intents
（官方原文）
你不可以直接通過 intent傳遞 RealmObject，建議你只傳遞RealmObject的標識符。舉個常用例子，假如你的對象擁有一個主鍵，請通過intent 的 bundle 來傳遞這個主鍵的值。
// Assuming we had a person class with a @PrimaryKey on the 'id' field ... Intent intent = new Intent(getActivity(), ReceivingService.class); intent.putExtra("person_id", person.getId()); getActivity().startService(intent); 在接受方（Activity、Service、IntentService、BroadcastReceiver及其它）從 bundle中解析出這個主鍵然后打開Realm 查詢得到這個 RealmObject。
// in onCreate(), onHandleIntent(), etc. String personId = intent.getStringExtra("person_id"); Realm realm = Realm.getDefaultInstance(); Person person = realm.where(Person.class).equalTo("id", personId).findFirst();// do something with the person ... realm.close(); 可以參考 threading example 中的 Object Passing部分。該示例展示了在安卓開發中常用的如何傳遞 id 並且得到對應的 RealmObject。
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，有時間可以去看看。
也許還有很多同學不了解RxJava，這里極力推薦給 Android 開發者的 RxJava 詳解。
終於寫完了~~~說好易用的，沒想到內容居然這么多。
源碼地址
參考資料
官方文檔
GitHub
Realm for Android快速入門教程
Android開發筆記（八十五）手機數據庫Realm
在Android加入和使用Realm
Android 進階之第三方庫的介紹 Realm [一] 基礎用法