Android教程網
  1. 首頁
  2. Android 技術
  3. Android 手機
  4. Android 系統教程
  5. Android 游戲
 Android教程網 >> Android技術 >> 關於Android編程 >> Android Realm數據庫完美解析

Android Realm數據庫完美解析

編輯:關於Android編程

當我們的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
     * 參考連接:
     * ACID
     * Examples using Realm
     *
     */


 

 

部分源碼分析:

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 asObservable() {
        return configuration.getRxFactory().from(this);
    }

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

public  void createAllFromJson(Class clazz, JSONArray json) {
}


    public  void createOrUpdateAllFromJson(Class clazz, JSONArray json) {
}


    public  E createOrUpdateObjectFromJson(Class clazz, JSONObject json) {
}


    public  E createObject(Class clazz) {
}


    public  E copyToRealmOrUpdate(E object) {
}


    public void executeTransaction(Transaction transaction) {
}


    public void delete(Class clazz) {
}
}




RealmConfiguration類的說明翻譯:
/**
 * 一個RealmConfiguration對象,可用來設置特定的Realm實例
 * RealmConfiguration實例只能通過io.realm.RealmConfiguration.Builder類的build()方法來創建
 * 想使用默認的RealmConfiguration實例,請使用io.realm.Realm#getDefaultInstance()方法。
 * 如果想使用自己配置RealmConfiguration實例的Realm實例,需要調用Realm#setDefaultConfiguration(RealmConfiguration)
 * 
 * 

* 可以用下面代碼創建一個最簡單配置的實例: * RealmConfiguration config = new RealmConfiguration.Builder(getContext()).build()) * 這樣創建的實例,具有一下屬性: * *

  • *
  • Realm的默認文件名是"default.realm"
  • *
  • "default.realm"文件保存在"Context.getFilesDir()"目錄中
  • *
  • 它的schema版本號設置為0
  • *
*/


部分源碼分析:
public final class RealmConfiguration {
//默認文件名
public static final String DEFAULT_REALM_NAME = "default.realm";

//Rx工廠
private final RxObservableFactory rxObservableFactory;

//弱引用
private final WeakReference 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//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//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 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 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 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 findByAnyParams(HashMap







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

  1. 上一頁:
  2. 下一頁:
熱門文章
閱讀排行版
Copyright © Android教程網 All Rights Reserved