【Android開發】【資料庫】Realm For Android

阿新 • • 發佈：2018-12-27

目錄
1、Realm簡介
2、環境配置
3、初始化Realm
4、建立實體
5、增
6、刪
7、改
8、查
9、非同步操作
10、資料庫資料更新監聽
11、json轉物件，插入資料庫
12、Demo地址 https://github.com/baitutang1221/DemoRealm-master

==========================================

一、Realm簡介

資料庫Realm，是用來替代sqlite的一種解決方案，它有一套自己的資料庫儲存引擎，比sqlite更輕量級，擁有更快的速度，並且具有很多現代資料庫的特性，比如支援JSON，流式api，資料變更通知，自動資料同步,簡單身份驗證，訪問控制，事件處理，最重要的是跨平臺，目前已有Java，Objective C，Swift，React-Native，Xamarin這五種實現。

二、環境配置

（1）. 在專案的build檔案加上 classpath "io.realm:realm-gradle-plugin:2.0.2"

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

（2）在app的build檔案加上

apply plugin: 'realm-android'

三、初始化Realm

（1）在Application的oncreate()方法中Realm.init()

public class MyApplication extends Application {
  @Override
  public void onCreate() {
    super.onCreate();
    Realm.init(this);
  }
}

（2）在Application的oncreate()方法中對Realm進行相關配置
①使用預設配置

public class MyApplication extends Application {
  @Override
  public void onCreate() {
    super.onCreate();
    // The Realm file will be located in Context.getFilesDir() with name "default.realm"
    Realm.init(this);
    RealmConfiguration config = new RealmConfiguration.Builder().build();
    Realm.setDefaultConfiguration(config);
  }
}

②使用自定義配置

public class MyApplication extends Application {
  @Override
  public void onCreate() {
    super.onCreate();
    Realm.init(this);
    RealmConfiguration config = new  RealmConfiguration.Builder()
                                         .name("myRealm.realm")
                                         .deleteRealmIfMigrationNeeded()
                                         .build();
    Realm.setDefaultConfiguration(config);
  }
}

（3）在AndroidManifest.xml配置自定義的Application

<application
  android:name=".MyApplication"
  ...
/>

四、建立實體

（1）新建一個類繼承RealmObject

public class Dog extends RealmObject {
    private String name;
    private int age;
    
    @PrimaryKey
    private String id;


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

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }
}

多對多的關係：

public class Contact extends RealmObject {
    public String name;
    public RealmList<Email> emails;
}

public class Email extends RealmObject {
    public String address;
    public boolean active;
}

（2）其他相關說明

1、支援的資料型別：
boolean, byte, short, int, long, float, double, String, Date and byte[]
在Realm中byte, short, int, long最終都被對映成long型別

2、註解說明

@PrimaryKey
①欄位必須是String、 integer、byte、short、 int、long 以及它們的封裝類Byte, Short, Integer, and Long
②使用了該註解之後可以使用copyToRealmOrUpdate()方法，通過主鍵查詢它的物件，如果查詢到了，則更新它，否則新建一個物件來代替。
③使用了該註解將預設設定（@index）註解
④使用了該註解之後，建立和更新資料將會慢一點，查詢資料會快一點。

@Required
資料不能為null

@Ignore
忽略，即該欄位不被儲存到本地

@Index
為這個欄位新增一個搜尋引擎，這將使插入資料變慢、資料增大，但是查詢會變快。建議在需要優化讀取效能的情況下使用。

五、增

（1）實現方法一：事務操作

型別一：新建一個物件，並進行儲存

Realm realm=Realm.getDefaultInstance();

realm.beginTransaction();
User user = realm.createObject(User.class); // Create a new object
user.setName("John");
user.setEmail("[email protected]");
realm.commitTransaction();

型別二：複製一個物件到Realm資料庫
```
Realm realm=Realm.getDefaultInstance();

User user = new User("John");
user.setEmail("[email protected]");

// Copy the object to Realm. Any further changes must happen on realmUser
realm.beginTransaction();
realm.copyToRealm(user);
realm.commitTransaction();

（2）實現方法二：使用事務塊

Realm mRealm=Realm.getDefaultInstance();

final User user = new User("John");
user.setEmail("[email protected]");

mRealm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
realm.copyToRealm(user);
}
});


**切記，Realm資料庫的主鍵欄位不是自動增長的，如果有主鍵，需要自己設定，做新增的時候如果不給id欄位值，預設會為0。
後面再新增會報錯，說id為0的資料已經存在。
尤其是批量新增的時候要注意，當心出現只添加了一條記錄的悲劇。**
####六、刪

Realm  mRealm=Realm.getDefaultInstance();

final RealmResults<Dog> dogs=  mRealm.where(Dog.class).findAll();

    mRealm.executeTransaction(new Realm.Transaction() {
        @Override
        public void execute(Realm realm) {
        
            Dog dog=dogs.get(5);
            dog.deleteFromRealm();
            //刪除第一個資料
            dogs.deleteFirstFromRealm();
            //刪除最後一個數據
            dogs.deleteLastFromRealm();
            //刪除位置為1的資料
            dogs.deleteFromRealm(1);
            //刪除所有資料
            dogs.deleteAllFromRealm();
        }
    });

同樣也可以使用同上的beginTransaction和commitTransaction方法進行刪除
####七、改

Realm mRealm=Realm.getDefaultInstance();

Dog dog = mRealm.where(Dog.class).equalTo("id", id).findFirst();
mRealm.beginTransaction();
dog.setName(newName);
mRealm.commitTransaction();

同樣也可以用事物塊來更新資料

####八、查
（1）查詢全部

查詢結果為RealmResults

public List<Dog> queryAllDog() {
    Realm  mRealm=Realm.getDefaultInstance();
    RealmResults<Dog> dogs = mRealm.where(Dog.class).findAll();
    return mRealm.copyFromRealm(dogs);
}

（2）條件查詢

public Dog queryDogById(String id) {
    Realm  mRealm=Realm.getDefaultInstance();
    Dog dog = mRealm.where(Dog.class).equalTo("id", id).findFirst();
    return dog;
}

常見的條件如下（詳細資料請查官方文件）：

>可拼接查詢條件如下
        //.or()                      或者
        //.beginsWith()              以xxx開頭
        //.endsWith()                以xxx結尾
        //.greaterThan()             大於
        //.greaterThanOrEqualTo()    大於或等於
        //.lessThan()                小於
        //.lessThanOrEqualTo()       小於或等於
        //.equalTo()                 等於
        //.notEqualTo()              不等於
        //.findAll()                 查詢所有
        //.average()                 平均值
        //.beginGroup()              開始分組
        //.endGroup()                結束分組
        //.between()                 在a和b之間
        //.contains()                包含xxx
        //.count()                   統計數量
        //.distinct()                去除重複
        //.findFirst()               返回結果集的第一行記錄
        //.isNotEmpty()              非空串
        //.isEmpty()                 為空串
        //.isNotNull()               非空物件
        //.isNull()                  為空物件
        //.max()                     最大值
        //.maximumDate()             最大日期
        //.min()                     最小值
        //.minimumDate()             最小日期
        //.sum()                     求和

（3）對查詢結果進行排序

/**
 * query （查詢所有）
 */
public List<Dog> queryAllDog() {
    RealmResults<Dog> dogs = mRealm.where(Dog.class).findAll();
    /**
     * 對查詢結果，按Id進行排序，只能對查詢結果進行排序
     */
    //增序排列
    dogs=dogs.sort("id");
    //降序排列
    dogs=dogs.sort("id", Sort.DESCENDING);
    return mRealm.copyFromRealm(dogs);
}

（4）其他查詢

sum，min，max，average只支援整型資料欄位

/**
* 查詢平均年齡
*/
private void getAverageAge() {
double avgAge= mRealm.where(Dog.class).findAll().average("age");
}

/**
 *  查詢總年齡
 */
private void getSumAge() {
  Number sum=  mRealm.where(Dog.class).findAll().sum("age");
    int sumAge=sum.intValue();
}

/**
 *  查詢最大年齡
 */
private void getMaxId(){
  Number max=  mRealm.where(Dog.class).findAll().max("age");
    int maxAge=max.intValue();
}


####九、非同步操作
大多數情況下，Realm的增刪改查操作足夠快，可以在UI執行緒中執行操作。但是如果遇到較複雜的增刪改查，或增刪改查操作的資料較多時，就可以子執行緒進行操作。

（1）非同步增：

private void addCat(final Cat cat) {
  RealmAsyncTask  addTask=  mRealm.executeTransactionAsync(new Realm.Transaction() {
        @Override
        public void execute(Realm realm) {
            realm.copyToRealm(cat);
        }
    }, new Realm.Transaction.OnSuccess() {
        @Override
        public void onSuccess() {
            ToastUtil.showShortToast(mContext,"收藏成功");
        }
    }, new Realm.Transaction.OnError() {
        @Override
        public void onError(Throwable error) {
            ToastUtil.showShortToast(mContext,"收藏失敗");
        }
    });
}

最後在銷燬Activity或Fragment時，要取消掉非同步任務

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


**注意：如果當Acitivity或Fragment被銷燬時，在OnSuccess或OnError中執行UI操作，將導致程式奔潰 。
用RealmAsyncTask .cancel();可以取消事務在onStop中呼叫，避免crash。**

public void onStop () {
if (transaction != null && !transaction.isCancelled()) {
transaction.cancel();
}
}

（2）非同步刪

private void deleteCat(final String id, final ImageView imageView){
  RealmAsyncTask  deleteTask=   mRealm.executeTransactionAsync(new Realm.Transaction() {
        @Override
        public void execute(Realm realm) {
            Cat cat=realm.where(Cat.class).equalTo("id",id).findFirst();
            cat.deleteFromRealm();

        }
    }, new Realm.Transaction.OnSuccess() {
        @Override
        public void onSuccess() {
            ToastUtil.showShortToast(mContext,"取消收藏成功");
        }
    }, new Realm.Transaction.OnError() {
        @Override
        public void onError(Throwable error) {
            ToastUtil.showShortToast(mContext,"取消收藏失敗");
        }
    });
}

最後在銷燬Activity或Fragment時，要取消掉非同步任務

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

（3）非同步改

RealmAsyncTask updateTask= mRealm.executeTransactionAsync(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
Cat cat=realm.where(Cat.class).equalTo("id",mId).findFirst();
cat.setName(name);
}
}, new Realm.Transaction.OnSuccess() {
@Override
public void onSuccess() {
ToastUtil.showShortToast(UpdateCatActivity.this,"更新成功");

        }
    }, new Realm.Transaction.OnError() {
        @Override
        public void onError(Throwable error) {
            ToastUtil.showShortToast(UpdateCatActivity.this,"失敗成功");
        }
    });

最後在銷燬Activity或Fragment時，要取消掉非同步任務

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


（4）非同步查

 RealmResults<Cat>   cats=mRealm.where(Cat.class).findAllAsync();
    cats.addChangeListener(new RealmChangeListener<RealmResults<Cat>>() {
        @Override
        public void onChange(RealmResults<Cat> element) {
           element= element.sort("id");
            List<Cat> datas=mRealm.copyFromRealm(element);
        }
    });

最後在銷燬Activity或Fragment時，要取消掉非同步任務

@Override
protected void onDestroy() {
super.onDestroy();
cats.removeChangeListeners();
}


####十,   資料庫資料更新監聽

MainActivity程式碼：

@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);

    mRealm = Realm.getDefaultInstance();
    userDao = new UserDao(mRealm);

    //...

    /**
     * 資料庫資料更新監聽
     */
    mRealm.addChangeListener(this);
}

//...

@Override
public void onChange(Realm element) {
findAll();
}

@Override
protected void onDestroy() {
userDao = null;
mRealm.close();
super.onDestroy();
}


####十一,  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： * 該屬性保持不變

版本升級的問題，參考：http://www.jianshu.com/p/37af717761cc

參照資料：
http://www.jianshu.com/p/37af717761cc
https://www.2cto.com/kf/201607/526365.html

【Android開發】【資料庫】Realm For Android

一、Realm簡介

二、環境配置

三、初始化Realm

四、建立實體

五、增

【Android開發】【資料庫】Realm For Android

android開發學習 ------- 【轉】 android中的單例模式（詳解）

【Android開發—智慧家居系列】（四）：UDP通訊傳送指令

【Android開發—智慧家居系列】（三）：手機連線WIFI模組

【Android開發—智慧家居系列】（二）：用手機對WIFI模組進行配置

【Android開發—智慧家居系列】（一）：智慧家居原理

【Android開發—電商系列】（二）：仿淘寶商品屬性標籤頁

【vue開發問題-解決方法】（四）vue Element UI使用中.$scopedSlots.default is not a function 報錯

【vue開發問題-解決方法】（四）vue Element UI 日期選擇器獲取日期格式問題 t.getTime is not a function

【軟體開發底層知識修煉】深入淺出處理器之一微處理器與微控制器

【軟體開發底層知識修煉】五 gcc-C語言編譯器

【軟體開發底層知識修煉】三深入淺出處理器之三記憶體管理與記憶體管理單元（MMU）

【軟體開發底層知識修煉】二深入淺出處理器之二中斷的概念與意義

【軟體開發底層知識修煉】十連結器-main函式不是第一個被執行的函式

【軟體開發底層知識修煉】九連結器-可重定位檔案與可執行檔案

【軟體開發底層知識修煉】八 Binutils輔助工具之- objdump工具與 size，strings工具

【軟體開發底層知識修煉】七 Binutils輔助工具之- ar工具與nm工具

【軟體開發底層知識修煉】六 Binutils輔助工具之- addr2line與strip工具

【軟體開發底層知識修煉】深入淺出處理器之二中斷的概念與意義

【敏捷開發每日一貼】：看板方法

【Android開發】【資料庫】Realm For Android

一、Realm簡介

二、環境配置

三、初始化Realm

四、建立實體

五、增

相關推薦