轉載：http://www.cnblogs.com/RaphetS/p/5996265.html

目錄
1、Realm簡介
2、環境配置
3、在Application中初始化Realm
4、建立實體
5、增刪改查
6、非同步操作
7、Demo地址（https://github.com/RaphetS/DemoRealm ）

一、Realm簡介

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

本篇文章用的版本為Realm 2.0.2(官方文件)

二、環境配置

（1） 在專案的build檔案加上

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

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

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

• equalTo() & notEqualTo()

• contains(), beginsWith() & endsWith()

• isNull() & isNotNull()

• isEmpty() & isNotEmpty()

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

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

Demo是以本地收藏為應用場景的，實現了對Realm的增刪改查等操作，以及非同步的增刪改查操作，過程中也踩了不少的坑。