2. 程式人生 > >Android Realm資料庫完美解析

Android Realm資料庫完美解析

阿新 • • 發佈：2019-02-20
當我們的app有資料需要儲存到本地快取時，可以使用file，sharedpreferences，還有sqlite。
sharedpreferences其實使用xml的方式，以鍵值對形式儲存基本資料型別的資料。對於有複雜篩選查詢的
操作，file和sharedpreferences都不能滿足了。sqlite可以滿足有大量複雜查詢要求的快取資料操作。但是sqlite的使用略複雜，程式碼量很大，還好網上有很多優秀的orm框架可使用，比喻ORMlite，greenDao等。


ORMlite，greenDao這些框架都是在SQLite的基礎上封裝的ORM物件關係對映框架，簡化了程式碼操作。
而今天的主角：Realm是一個可以替代SQLite以及ORM Libraries的輕量級資料庫。

相比SQLite，Realm更快並且具有很多現代資料庫的特性，比如支援JSON，流式api，資料變更通知，以及加密支援，這些都為安卓開發者帶來了方便。不多介紹，更詳細的介紹參見官網：

https://realm.io/

我們重點來說說Reaml的使用，看看到底爽在哪裡。

環境配置：

1、在Project的build.gradle檔案中新增依賴：

dependencies {
        ...
        classpath "io.realm:realm-gradle-plugin:1.1.0"
        ...
    }



2、在app module的build.gradle檔案的top新增下面程式碼：
apply plugin: 'com.android.application'
apply plugin: 'realm-android'
....


配置完畢。

使用：


在整個使用的過程中，Realm是主角，我們先來看看Realm類中的一段翻譯：

/**
     * Realm類可以對你的持久化物件進行儲存和事務管理，可以用來建立RealmObjects例項。領域內的物件可以在任何時間查詢和讀取。
     * 建立，修改和刪除等操作必須被包含在一個完整的事務裡面，後面的程式碼會講到。
     * 該事務確保多個例項（在多個執行緒）可以在一個一致的狀態和保證事務在ACID前提下，訪問相同的物件。
     *
     * 當一個Realm例項操作完成後，切記不要忘記呼叫close()方法。否則會導致本地資源無法釋放，引起OOM。
     *
     * Realm例項不能在不同的執行緒間訪問操作。確切的說，你必須在每個要使用的執行緒上開啟一個例項
     * 每個執行緒都會使用引用計數來自動快取Realm例項，所以只要引用計數不達到零，
     *  呼叫getInstance(RealmConfiguration)方法將會返回快取的Realm例項，應該算是一個輕量級的操作。
     *
     * 對於UI執行緒來說，開啟和關閉Realm例項，應當放在onCreate/onDestroy或者onStart/onStop方法中
     *
     *  在不同的執行緒間，Realm例項使用Handler機制來調整他的狀態。也就是說，Realm例項線上程中，如果沒有Looper，是不能收到更新通知的，
     *  除非手動呼叫waitForChange()方法
     *
     * 在安卓Activity領域工作的一個標準模式可以在下面看到
     * 在Android Activity中，Realm的標準工作模式如下：
     *
     *
     * public class RealmApplication extends Application {
     *
     *     \@Override
     *     public void onCreate() {
     *         super.onCreate();
     *
     *         // The Realm file will be located in package's "files" directory.
     *         RealmConfiguration realmConfig = new RealmConfiguration.Builder(this).build();
     *         Realm.setDefaultConfiguration(realmConfig);
     *     }
     * }
     *
     * public class RealmActivity extends Activity {
     *
     *   private Realm realm;
     *
     *   \@Override
     *   protected void onCreate(Bundle savedInstanceState) {
     *     super.onCreate(savedInstanceState);
     *     setContentView(R.layout.layout_main);
     *     realm = Realm.getDefaultInstance();
     *   }
     *
     *   \@Override
     *   protected void onDestroy() {
     *     super.onDestroy();
     *     realm.close();
     *   }
     * }
     *
     *
     * Realm支援String和byte欄位長度高達16MB
     * 參考連線：
     * <a href="http://en.wikipedia.org/wiki/ACID">ACID</a>
     * <a href="https://github.com/realm/realm-java/tree/master/examples">Examples using Realm</a>
     *
     */


部分原始碼分析：

public final class Realm extends BaseRealm {
//預設的檔名，是啥？
public static final String DEFAULT_REALM_NAME = RealmConfiguration.DEFAULT_REALM_NAME;


//怎麼這麼熟悉呢？是RxJava？
@Override
    @OptionalAPI(dependencies = {"rx.Observable"})
    public Observable<Realm> asObservable() {
        return configuration.getRxFactory().from(this);
    }

//下面這些方法，應該都能顧名思義吧

public <E extends RealmModel> void createAllFromJson(Class<E> clazz, JSONArray json) {
}


    public <E extends RealmModel> void createOrUpdateAllFromJson(Class<E> clazz, JSONArray json) {
}


    public <E extends RealmModel> E createOrUpdateObjectFromJson(Class<E> clazz, JSONObject json) {
}


    public <E extends RealmModel> E createObject(Class<E> clazz) {
}


    public <E extends RealmModel> E copyToRealmOrUpdate(E object) {
}


    public void executeTransaction(Transaction transaction) {
}


    public void delete(Class<? extends RealmModel> clazz) {
}
}




RealmConfiguration類的說明翻譯：
/**
 * 一個RealmConfiguration物件，可用來設定特定的Realm例項
 * RealmConfiguration例項只能通過io.realm.RealmConfiguration.Builder類的build()方法來建立
 * 想使用預設的RealmConfiguration例項，請使用io.realm.Realm#getDefaultInstance()方法。
 * 如果想使用自己配置RealmConfiguration例項的Realm例項，需要呼叫Realm#setDefaultConfiguration(RealmConfiguration)
 * 
 * <p>
 * 可以用下面程式碼建立一個最簡單配置的例項:
 * RealmConfiguration config = new RealmConfiguration.Builder(getContext()).build())
 * 這樣建立的例項，具有一下屬性：
 * 
 * <ul>
 * <li>Realm的預設檔名是"default.realm"</li>
 * <li>"default.realm"檔案儲存在"Context.getFilesDir()"目錄中</li>
 * <li>它的schema版本號設定為0</li>
 * </ul>
 */


 
部分原始碼分析：
public final class RealmConfiguration {
//預設檔名
public static final String DEFAULT_REALM_NAME = "default.realm";

//Rx工廠
private final RxObservableFactory rxObservableFactory;

//弱引用
private final WeakReference<Context> contextWeakRef;

/**
     * 
     * 從Asset目錄中返回Realm檔名，還可以儲存在Asset中？
     * @return input stream to the asset file.
     * @throws IOException if copying the file fails.
     */
    InputStream getAssetFile() throws IOException {
        Context context = contextWeakRef.get();
        if (context != null) {
            return context.getAssets().open(assetFilePath);
        } else {
        }
    }

/**
         * 使用app自己內建硬碟目錄來儲存Realm file。不需要任何擴充套件訪問許可權。
         * 預設目錄為：/data/data/<packagename>/files，這個路徑能否修改取決於供應商的具體實現
         * 
         * @param 引數context請使用application的context.
         */
        public Builder(Context context) {
            if (context == null) {
                throw new IllegalArgumentException("A non-null Context must be provided");
            }
            RealmCore.loadLibrary(context);
            initializeBuilder(context.getFilesDir());
        }
｝




通過上面的翻譯說明和原始碼分析，應該幾乎明白了Realm的原理和基本使用了吧。總結下面幾點：
1、Realm儲存的結果其實是在一個檔案裡面，預設的檔名是"default.realm"，在"Context.getFilesDir()"目錄中，即：/data/data/<packagename>/files/default.realm。意思是，當你在應用管理裡面給當前app"清除資料"，realm資料庫的資料會丟失。故我們需要把預設的資料檔案放到asset目錄中，當資料庫初始化時再copy到"Context.getFilesDir()"下。
2、在建立RealmConfiguration物件時，可以通過.assetFile(this,"realm file path in assets")方法指定初始化的資料庫檔案。Realm會把制定路徑下的xxx.realm檔案copy到Context.getFilesDir()目錄中，以替換預設建立的空資料庫檔案。
3、可以設定預設檔名，通過RealmConfiguration類進行配置。路徑似乎改不了，需要看具體裝置供應商的實現。
4、Realm的例項需要在每次的具體操作中獲取，可以看成是一個數據操作的sessin，用完後必須close關閉。
開啟和關閉Realm例項，應當放在onCreate/onDestroy或者onStart/onStop方法中。
5、Realm中似乎有RxJava的影子，支援鏈式非同步任務？
6、Realm中有個各種增刪改差的方法，還可以根據JSON的資料例項化一個RealmObject子類java bean。
7、重點：切記，Realm資料庫的主鍵欄位不是自動增長的，需要自己設定，做新增的時候如果不給id欄位值，預設會為0。後面再新增會報錯，說id為0的資料已經存在。尤其是批量新增的時候要注意，當心出現只添加了一條記錄的悲劇。
8、資料自動更新。mRealm.addChangeListener(this);//當資料庫的資料有變化時，系統回撥此方法。


經過上面的分析和總結，其實已經很明瞭了。為了那些伸手主義者，還是簡單擼些程式碼吧。還有些需要注意的地方，在程式碼中講解。




application程式碼：
public class MyApplication extends Application {
    private String realmName = "dk.realm";


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


        RealmConfiguration realmConfig = new RealmConfiguration.Builder(this)
                .name(realmName)
                //.assetFile(this,"realm file path in assets，will copy this file to Context.getFilesDir() replace an empty realm file")
                .build();
        Realm.setDefaultConfiguration(realmConfig);
    }
}




java Bean:
public class TestUser extends RealmObject {


    @PrimaryKey
    private int userId;//id,主鍵
    @Required
    private String userName;//使用者姓名,必填欄位
    private String userPwd;//密碼
    private int userAge;//年齡
    private String userAddress;//住址
    private String userWork;//工作
    private String userSex;//性別


    //private RealmList<E> list;  集合
//...
}




BaseDao,簡單封裝，把基本的增刪改功能提取：
public class BaseDao {
    private Realm realm;


    public BaseDao(Realm realm) {
        this.realm = realm;
    }


    /**
     * 新增(效能優於下面的saveOrUpdate（）方法)
     *
     * @param object
     * @return 儲存或者修改是否成功
     */
    public boolean insert(RealmObject object) {
        try {
            realm.beginTransaction();
            realm.insert(object);
            realm.commitTransaction();
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            realm.cancelTransaction();
            return false;
        }
    }
/**
     * 新增(效能優於下面的saveOrUpdateBatch（）方法)
     *
     * @param list
     * @return 批量儲存是否成功
     */
    public boolean insert(List<? extends RealmObject> list) {
        try {
            realm.beginTransaction();
            realm.insert(list);
            realm.commitTransaction();
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            realm.cancelTransaction();
            return false;
        }
    }
//...
}




UserDao extends BaseDao:
/**
     * 單條儲存demo
     */
    public boolean addOneTest() {
        boolean bl = false;
        try{
            realm.beginTransaction();
            //在資料庫中建立一個物件，主鍵預設值為0
            TestUser user = realm.createObject(TestUser.class);//(類，主鍵)


            //更新資料庫各自段的值
            user.setUserName("admin");
            //主鍵欄位的值由0更新為55。而不是直接建立了一個id為55的物件
            user.setUserId(55);
            //...
            realm.commitTransaction();
            bl = true;
        }catch (Exception e){
            e.printStackTrace();
            realm.cancelTransaction();
        }


        /*try{
            realm.beginTransaction();
            TestUser user2 = new TestUser("hibrid", "120250", 26, "贛州", "賊", "男");
            //不給id，會被預設為0
            //user2.setUserId(102);
            TestUser userWithId = realm.copyToRealm(user2);
            realm.commitTransaction();
            bl = true;
        }catch (Exception e){
            e.printStackTrace();
            realm.cancelTransaction();
        }*/
        return bl;
    }

//init data
    public boolean init() {
        /**
         * 此處要注意，方法最後呼叫的是新增或者修改的方法。
         * 如果list的資料都不給id，則第一條記錄新增成功後的id為0，後面的都在此基礎上修改。
         * 最後的效果是，資料庫只有一條記錄，id為0，其他欄位被更新為了最後一個物件的資料
         */
        List<TestUser> list = new ArrayList<>();
        list.add(new TestUser(0,"android", "123123", 20, "河南常德", "傳菜員", "女"));
        list.add(new TestUser(1,"angel", "13588889988", 21, "雲南西雙版納", "飛行員", "男"));
        list.add(new TestUser(2,"adidass", "110119", 28, "雲南德克薩斯州", "海員", "男"));
        list.add(new TestUser(3,"hijack", "250250", 39, "加州電廠", "廚師", "女"));
        list.add(new TestUser(4,"hibrid", "120250", 26, "贛州", "賊", "男"));
        list.add(new TestUser(5,"admin", "123456", 20, "湖北漢城", "程式設計師", "女"));
        return saveOrUpdateBatch(list);
    }

/**
     * 條件查詢
     *
     * @return 返回結果集合
     */
    public RealmResults<TestUser> findByAnyParams(HashMap<Object, Object> params) {
        //realm.where(TestUser.class)
        //可跟查詢條件
        //.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()                     求和
        return realm.where(TestUser.class).findAll();
    }







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




增刪改的程式碼注意事務，其他的都簡單。
sorry，忘記上傳demo了。需要demo的請留下qq，發你郵箱吧。

相關推薦

Android Realm資料庫完美解析

當我們的app有資料需要儲存到本地快取時，可以使用file，sharedpreferences，還有sqlite。 sharedpreferences其實使用xml的方式，以鍵值對形式儲存基本資料型別的資料。對於有複雜篩選查詢的 操作，file和sharedpreferen

Android Realm資料庫使用指南

Android Realm資料庫使用指南 轉載於：https://www.cnblogs.com/mengdd/p/android-realm-database-guides.html Realm資料庫, 目前有Java, Objective‑C, React Native, Swift,

android realm資料庫基本使用

   因為realm開源框架支援對資料庫的加密操作，保證了應用儲存到資料庫內容的安全性，因此我選擇在開發中使用realm，通過檢視github上的官方文件，比較模糊和抽象，下載了資源專案到as中，也沒發現很好的執行，可能跟我匯入方式有關，在csdn上搜索了一篇人家使用re

Android Realm資料庫的查詢及自動更新

上一篇文章Android Realm資料庫的使用寫了Relam資料庫的基本配置和基本用法，這次主要看看Realm資料庫的查詢以及自動更新。 1.查詢 查詢分為同步和非同步，同步和非同步的使用請看上一篇文章，這次主要是學習查詢條件的使用： //查詢年齡在

Android windows+chrome 檢視Realm資料庫

Stetho Stetho是Facebook出品的一個非常強大的Android除錯工具。 啟用後，開發人員可以使用Chrome瀏覽器的Chrome開發者工具功能。 開發人員還可以選擇啟用可選的dumpapp工具，它為應用程式內部提供了強大的命令列介面。  Stetho可以監聽網路請求，

Android Hawk資料庫的原始碼解析，Github開源專案，基於SharedPreferences的的儲存框架

今天看了朋友一個專案用到了Hawk，然後寫了這邊文章 一、瞭解一下概念 Android Hawk資料庫github開源專案 Hawk是一個非常便捷的資料庫.操作資料庫只需一行程式碼,能存任何資料型別. 相信大家應該很熟悉SharedPreferences。它是一種輕量級的儲存簡單配置

如何在Android中使用Realm資料庫

我們都知道使用SQLite的本地資料庫，它在Android 開發中用於內部儲存器儲存，主要儲存本地資料，如聯絡人，電話詳細資訊等。現在我發現一個比SQLite更輕的資料庫，被稱為Realm資料庫，我想我們可以徹底放棄SQLite了。 簡單 -資料將以Obje

Android windows+chrome 檢視Realm資料庫 2018.6.1更新最新版本庫

Stetho Stetho是Facebook出品的一個非常強大的Android除錯工具。 啟用後，開發人員可以使用Chrome瀏覽器的Chrome開發者工具功能。 開發人員還可以選擇啟用可選的dumpapp工具，它為應用程式內部提供了強大的命令列介面。 St

Android屬性動畫完全解析(上)，初識屬性動畫的基本用法

fcm 操作 fad 擴展性 改變 內部使用 如果 轉載 @override 轉載請註明出處：http://blog.csdn.net/guolin_blog/article/details/43536355 在手機上去實現一些動畫效果算是件比較炫酷的事情，因此Andr

Android ToolBar 使用完全解析

都是 主題 image 需要 oid primary 調用 blank ast ToolBar簡介 ToolBar是Android 5.0推出的一個新的導航控件用於取代之前的ActionBar，由於其高度的可定制性、靈活性、具有Material Design風格等優點，

Android源代碼解析之（六）--&gt;Log日誌

static 同學 ons ets urn append oct source for 轉載請標明出處：一片楓葉的專欄 首先說點題外話，對於想學android framework源代碼的同學，事實上能夠在github中fork一份，詳細地址：p

Android源代碼解析之（四）--&gt;HandlerThread

轉載 detail dcl red tag msg click 創建 tor 轉載請標明出處：一片楓葉的專欄 上一篇文章中我們解說了AsyncTast的基本使用以及實現原理，我們知道AsyncTask內部是通過線程池和Handler實現的。通過

以芯片直讀方式得到的Android全盤鏡像解析——DOS分區

xtend gpt 裏的 per 記錄 style 工作 計算 區號 　　最近得到了一個依舊用芯片直讀方式得到的Android全盤鏡像，這次是一個紅米手機的鏡像，和之前的鏡像不同，這次的分區類型的DOS分區，這裏說明一下，算是對之前那篇記錄的補充。 　　首先要糾正一下我的一

Android源代碼解析之（十三）--&gt;apk安裝流程

solved 就是 activity 文章 空間不夠 orien gpo tpm systems 轉載請標明出處：一片楓葉的專欄 上一篇文章中給大家分析了一

Android源代碼解析之（七）--&gt;LruCache緩存類

access ref trie ber tro double prot 推斷 rate 轉載請標明出處：一片楓葉的專欄 android開發過程中常常會用到緩

Android懸浮窗原理解析(Window)[源碼]

tco inflate 情況 tint input tdi scree list 接收 懸浮窗，在大多數應用中還是很少見的，目前我們接觸到的懸浮窗，差不多都是一些系統級的應用軟件，例如：360安全衛士，騰訊手機管家等；在某些服務行業如金融，餐飲等，也會在應用中添加懸浮窗，例

Kotlin引入Realm資料庫

Kotlin引入Realm資料庫 1.在module的build.gradle中配置外掛 //realm 資料庫新增kapt引入需要 apply plugin: 'kotlin-kapt' 2.在module的build.gradle中引入依賴 compile 'io.re

【輸出文件】 Android 6 USB 模組解析

          USB模組解析 簡介 主要完成USB 功能的切換和狀態的更新。通過接受kernel傳送過來的event訊息來確定USB狀態的切換並向外界傳送廣播訊息。  

activiti工作流，資料庫表解析。

-- 釋出的流程資訊 存有id和名稱。   該id分別在“部署的流程” 和“通用資料” 中記錄 以該表為紐帶，關聯 “部署的流程act_re_procdef” 與“部署流程的配置資訊(該配置資訊記錄在‘通用資料’act_ge_bytearray表中)” select *

Android開發——資料庫框架Suger遇到的大坑（依據列名查詢不到資料解決辦法）

Android開發——資料庫框架Suger遇到的大坑（依據列名查詢不到資料解決辦法） JavaBean命名出現大寫，資料無法正常儲存（用的是Suger第二種操作方式，第一種沒有測試） 習慣中對Bean中變數的命名會出現大寫字母，但使用Suger操作這樣的資料會出現問題，比如我這樣命名