Android之Realm詳解

文章大綱

一、Realm介紹

二、Realm實戰

三、Realm官方文檔

四、項目源碼下載下傳

五、參考文章

什麼是Realm

Realm 是一個手機資料庫，是用來替代 SQlite 的解決方案，比 SQlite 更輕量級，速度更快，因為它有一套自己的資料庫搜尋引擎，并且還具有很多現代資料庫的優點，支援 JSON，流式 API 調用，資料變更通知，自動資料同步，簡單身份驗證，通路控制，事件處理，最重要的是跨平台，目前已經支援 Java、Swift、Object - C、React - Native 等多種實作。
Realm優勢

易用

Ream 不是在SQLite基礎上的ORM，它有自己的資料查詢引擎。并且十分容易使用。

快速

由于它是完全重新開始開發的資料庫實作，是以它比任何的ORM速度都快很多，甚至比SLite速度都要快。

跨平台

Realm 支援 iOS & OS X (Objective‑C & Swift) & Android。我們可以在這些平台上共享Realm資料庫檔案，并且上層邏輯可以不用任何改動的情況下實作移植。

進階

Ream支援加密，格式化查詢，易于移植，支援JSON，流式api，資料變更通知等進階特性

可視化

Realm 還提供了一個輕量級的資料庫檢視工具，在Mac Appstore 可以下載下傳“Realm Browser”這個工具，開發者可以檢視資料庫當中的内容，執行簡單的插入和删除資料的操作。（windows上還不清楚）

使用要求

（1）目前不支援Android以外的Java

（2）Android Studio >= 1.5.1（不支援Eclipse）

（3）JDK version >=7.

（4）支援API 9(Android 2.3)以及之後的版本

添加依賴

在project的build中加入依賴

buildscript {

repositories {
    jcenter()
}
dependencies {
    classpath "io.realm:realm-gradle-plugin:2.2.1"
}

}

image

在module中加入

apply plugin: 'realm-android'

建立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

提示：整數類型 short、int 和 long 都被映射到 Realm 内的相同類型（實際上為 long ）

（1）@PrimaryKey——表示該字段是主鍵

使用過資料庫的同學應該看出來了，PrimaryKey就是主鍵。使用@PrimaryKey來标注，字段類型必須是字元串（String）或整數（byte，short，int或long）以及它們的包裝類型（Byte,Short, Integer, 或 Long）。不可以存在多個主鍵，使用字元串字段作為主鍵意味着字段被索引（注釋@PrimaryKey隐式地設定注釋@Index）。

@PrimaryKey

private String id;

（2）@Required——表示該字段非空

在某些情況下，有一些屬性是不能為null的。使用@Required可用于用于強行要求其屬性不能為空，隻能用于Boolean, Byte, Short, Integer, Long, Float, Double, String, byte[] 和 Date。在其它類型屬性上使用。

（3）@Required修飾會導緻編譯失敗。

提示：基本資料類型不需要使用注解 @Required，因為他們本身就不可為空。

@Required

private String name;

（4）@Ignore——表示忽略該字段

被添加@Ignore标簽後，存儲資料時會忽略該字段。

@Ignore

（5）@Index——添加搜尋索引

為字段添加搜尋索引，這樣會使得插入的速度變慢，資料量也變得更大。不過在查詢速度将變得更快，建議隻在優化讀取性能的特定情況時添加索引。支援索引：String，byte，short，int，long，boolean和Date字段。

注意：如果你建立Model并運作過，然後修改了Model。那麼就需要更新資料庫，否則會抛異常。更新方式後面會提到

初始化Realm

重寫Application類

public class MyApp extends Application {

@Override
public void onCreate() {
    super.onCreate();

AndroidManifest.xml中配置MyApp

建立方式1

@Override
public void onCreate() {
    super.onCreate();

    Realm.init(this);//初始化realm

    Realm mRealm = Realm.getDefaultInstance();
}

這時候會建立一個叫做 default.realm的Realm檔案，一般來說，這個檔案位于/data/data/包名/files/。通過realm.getPath()來獲得該Realm的絕對路徑。

建立方式2

@Override
public void onCreate() {
    super.onCreate();

    Realm.init(this);//初始化realm

    //這時候會建立一個叫做 default.realm的Realm檔案，一般來說，
    // 這個檔案位于/data/data/包名/files/。通過realm.getPath()來獲得該Realm的絕對路徑
    RealmConfiguration config = new RealmConfiguration.Builder()
            .name("myrealm.realm") //檔案名
            .schemaVersion(0) //版本号
            .build();
    Realm realm = Realm.getInstance(config);

}

建立方式3

@Override
public void onCreate() {
    super.onCreate();

    Realm.init(this);//初始化realm

//建立儲存在記憶體中的realm，應用關閉後就清除了

// RealmConfiguration myConfig = new RealmConfiguration.Builder(this)

// .name("myrealm.realm")

// .inMemory() .build();

建立方式4

@Override
public void onCreate() {
    super.onCreate();

    Realm.init(this);//初始化realm

    
    //建立加密的realm

// byte[] key = new byte[64];

// new SecureRandom().nextBytes(key);

// RealmConfiguration config = new RealmConfiguration.Builder()

// .encryptionKey(key)

// .build();

// Realm realm = Realm.getInstance(config);

總結：

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();

擷取realm對象
class RealmHelper {

public static final String DB_NAME = "myRealm.realm";

private Realm mRealm;

public RealmHelper(Context context) {

    mRealm = Realm.getDefaultInstance();
}

public Realm getRealm(){

return mRealm;
}

增加資料

寫入操作需要在事務中進行，可以使用executeTransaction方法來開啟事務。

（1）使用executeTransaction方法插入資料

mRealm.executeTransaction(new Realm.Transaction() {

@Override
        public void execute(Realm realm) {
            User user = realm.createObject(User.class);
            user.setName("Gavin");
            user.setAge(23);
        }
    });

注意：如果在UI線程中插入過多的資料，可能會導緻主線程擁塞。

（2）使用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;

就這樣寫

@Override
        public void execute(Realm realm) {
            User2 user = realm.createObject(User2.class);
            user.name = "Micheal";
            user.age = 30;
        }
    });

（3）上面都是用可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來實作。

（4）使用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();
  }

（5）Realm還是個很好的功能就是将Json字元串轉化為對象

// 一個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插入資料

@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 更新對象：

使用不包含對應屬性的 JSON： * 該屬性保持不變

查詢資料

查找操作就比插入友善多了，并不需在事務中操作，直接查詢即可。

（1）findAll ——查詢

例：查詢所有的User

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

(2)findAllAsync——異步查詢

當資料量較大，可能會引起ANR的時候，就可以使用findAllAsync

RealmResults userList = mRealm.where(User.class)

.equalTo("name", "Gavin")
            .findAllAsync();

(3)findFirst ——查詢第一條資料

例：查詢User表中的第一條資料

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

(4)equalTo ——根據條件查詢

例：得到name為Gavin的使用者清單。

.equalTo("name", "Gavin").findAll();

如果User中還有Dog屬性，希望根據Dog的條件來擷取使用者：

例：查詢dogs.name為二哈的User

.equalTo("dogs.name", "二哈").findAll();

得到有養有dogs.name為”二哈”的使用者清單（這裡的dogs是User表中的屬性名）

(5)equalTo ——多條件查詢

當然，我們還經常要用到多條件的查詢的功能。

例：找到使用者名為“Gavin”，且dogs.name為“二哈”的User

.equalTo("name", "Gavin").findAll();

RealmResults userList = user5.where()

.equalTo("dogs.name", "二哈").findAll();

（6）排序

查詢結束後，還可以進行排序，就像這樣：

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

userList = result.sort("age"); //根據age，正序排列

userList = result.sort("age", Sort.DESCENDING);//逆序排列

（7）聚合

RealmResult自帶一些聚合方法：

RealmResults 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();

（8）更多查詢條件

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

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

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

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

max() : 對指定字段求最大值。count : 求結果集的記錄數量。

findAll(): 傳回結果集所有字段，傳回值為RealmResults隊列

findAllSorted() : 排序傳回結果集所有字段，傳回值為RealmResults隊列

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

equalTo() & notEqualTo()

contains(), beginsWith() & endsWith()

isNull() & isNotNull()

isEmpty()& isNotEmpty()

修改資料

@Override

public void execute(Realm realm) {

//先查找後得到User對象
User user = mRealm.where(User.class).findFirst();
user.setAge(26);

修改也是需要在事務中操作。使用查詢語句得到資料，然後将内容改了即可。

删除資料

(1)使用deleteFromRealm()

//先查找到資料

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

@Override
public void execute(Realm realm) {
    userList.get(0).deleteFromRealm();
}

(2)使用deleteFromRealm(int index)

@Override
public void execute(Realm realm) {
    userList.deleteFromRealm(0);
}

(3)其他方法

userList.deleteFirstFromRealm(); //删除user表的第一條資料

userList.deleteLastFromRealm();//删除user表的最後一條資料

results.deleteAllFromRealm();//删除user表的全部資料

異步任務注意點

最後在銷毀Activity或Fragment時，要取消掉異步任務

protected void onDestroy() {
    super.onDestroy();
   if (deleteTask!=null&&!addTask.isCancelled()){
        deleteTask.cancel();
    }
}

其他常見操作

API:RealmObjectSchema

（1）取消id必填

personSchema.setNullable("id", true):

（2）移除id字段

personSchema.removeField("id");

（3）重命名

personSchema..renameField("id", "userId");

API:DynamicRealmObject

（4）擷取id

String id = obj.getString("id");

（5）為字段設定值

obj.setString("name", "Gavin");

obj.setInt("id", 1);

obj.setLong("id", 1);

資料庫版本更新

當資料結構發生變化是，需要更新資料庫。對于Realm來說，資料庫更新就是遷移操作，把原來的資料庫遷移到新結構的資料庫

例1：User類發生變化，移除age，新增個@Required的id字段。

User版本：version 0

String name;

int age;

User版本：version 1

String id;

建立遷移類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 2

private RealmList dogs;

Dog類

public class Dog extends RealmObject {

private String name;
    private int age;

在遷移類CustomMigration中，繼續添加處理方法。

(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++;
        }

https://realm.io/cn/docs/java/latest/

連結:

https://pan.baidu.com/s/1wSoXuclZ-Nwntnw_79xkLA

密碼:oc95

https://blog.csdn.net/u013651026/article/details/79481615 https://www.jianshu.com/p/28912c2f31db

原文位址

https://www.cnblogs.com/WUXIAOCHANG/p/10662998.html

Android之Realm詳解

繼續閱讀

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

NOSQL安全攻擊

mybatis_入門程式Mybatis入門

vue-cli簡介（中文翻譯）

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

登入plsql 報錯 the account is locked --使用者被鎖

Ajax發送和擷取json資料到Spring mvc 1.spring mvc後端2.web前段

Effective Java 8:通用程式設計

SequoiaDB巨杉資料庫C++驅動概述

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method

JSONObject包導入異常 java.lang.NoClassDefFoundErrorweb項目的導入包的問題