Realm简介
数据库Realm,是用来替代sqlite的一种解决方案,它有一套自己的数据库存储引擎,比sqlite更轻量级,拥有更快的速度,并且具有很多现代数据库的特性,比如支持JSON,流式api,数据变更通知,自动数据同步,简单身份验证,访问控制,事件处理,最重要的是跨平台,目前已有Java,Objective C,Swift,React-Native,Xamarin这五种实现。
官方文档
https://realm.io/docs/java/latest/
项目地址
https://github.com/realm/realm-java
Domo地址
https://github.com/kinglong123/RealmDemo
添加依赖,在工程目录下的build.gradle中加上
classpath 'com.novoda:gradle-android-command-plugin:1.5.0'
classpath "io.realm:realm-gradle-plugin:2.4.0-SNAPSHOT"
在使用的module中加上
apply plugin: 'android-command'
apply plugin: 'realm-android'
初始化Realm
在Application的oncreate()方法中Realm.init()
public final void onCreate() {
super.onCreate();
Realm.init(this);
}
使用自定义配置
private RealmHelper(){
RealmConfiguration defaultConfig = new RealmConfiguration.Builder()
.name(DB_NAME)
.schemaVersion(1)
.deleteRealmIfMigrationNeeded()
.build();
mRealm = Realm.getInstance(defaultConfig);
}
其实Realm数据库的创建方式有非常多种。这里只展示了我自己写的。
Realm数据库的名称是可以不用指定的,如果只有一个数据库,可以不指定,在调试的时候也会省很多事。
还可以创建一个默认的Config。
Realm.setDefaultConfiguration(defaultConfig);
获取Realm的时候
Realm.getDefaultInstance();
看上去简单很多,而且可以不用传context。
Realm初始化是有非常多配置的。
.schemaVersion(1) 设置一个版本号,如果没设置,默认是0
.encryptionKey() 数据库加密
.deleteRealmIfMigrationNeeded() 迁移方案的一种,当数据库结构改变时,删除原数据库中的所有数据, 这在debug版本的时候非常有用,一旦应用上线,需要保留原数据数据,这个方案就不适用了。
.migration() 指定一个迁移方案,如果应用上线之后,数据库结构需要发生改变,可以通过配置Migration来解决,用于将原数据库中的数据迁移到新数据库中。
创建实体
public class Person extends RealmObject implements Serializable {
// All fields are by default persisted.
private String name;
private int age;
private String githubUserName;
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 getGithubUserName() {
return githubUserName;
}
public void setGithubUserName(String githubUserName) {
this.githubUserName = githubUserName;
}
}
(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
为这个字段添加一个搜索引擎,这将使插入数据变慢、数据增大,但是查询会变快。建议在需要优化读取性能的情况下使用。
增
事务操作
public void addPerson(final Person person) {
mRealm.beginTransaction();
mRealm.copyToRealm(person);
mRealm.commitTransaction();
}
事务块
public void addPerson2(final Person person) {
mRealm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
realm.copyToRealm(person);
}
});
}
删
final RealmResults<Person> personList = mRealm.where(Person.class).equalTo("name", name).findAll();
// mRealm.beginTransaction();
// personList.deleteAllFromRealm();
// mRealm.commitTransaction();
mRealm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
personList.deleteAllFromRealm();
}
});
同样也可以使用同上的beginTransaction和commitTransaction方法进行删除
改
public void updatePerson(String oldName, String newName) {
RealmResults<Person> persons = mRealm.where(Person.class).equalTo("name", oldName).findAll();
if(persons!=null && persons.size() >0) {
mRealm.beginTransaction();
for(Person person :persons){
person.setName(newName);
}
mRealm.commitTransaction();
}
}
查
查询全部
public List<Dog> queryAllDog() {
Realm mRealm=Realm.getDefaultInstance();
RealmResults<Dog> dogs = mRealm.where(Dog.class).findAll();
return mRealm.copyFromRealm(dogs);
}
条件查询
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()
对查询结果进行排序
/**
* 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);
}
RX使用
mSubscription = RealmHelper.getRealmHelper().getRealm().where(Person.class)
.beginsWith("name", s)
.findAllSortedAsync("name")
.asObservable()
.observeOn(AndroidSchedulers.mainThread())
.subscribe(
new Action1<RealmResults<Person>>() {
@Override
public void call(RealmResults<Person> persons) {
personList = persons;
mSimpleAdapter.setData(personList);
mSimpleAdapter.notifyDataSetChanged();
}
}, new Action1<Throwable>() {
@Override
public void call(Throwable throwable) {
}
});
结合RxBinding使用
subscription = RxTextView.textChangeEvents(mEt)
.debounce(200, TimeUnit.MILLISECONDS) // 在一定的时间内没有操作就会发送事件 default Scheduler is Schedulers.computation()
.observeOn(AndroidSchedulers.mainThread()) // Needed to access Realm data
.flatMap(new Func1<TextViewTextChangeEvent, Observable<RealmResults<Person>>>() {
@Override
public Observable<RealmResults<Person>> call(TextViewTextChangeEvent event) {
// Use Async API to move Realm queries off the main thread.
// Realm currently doesn't support the standard Schedulers.
return RealmHelper.getRealmHelper().getRealm().where(Person.class)
.beginsWith("name", event.text().toString())
.findAllSortedAsync("name").asObservable();
}
})
.filter(new Func1<RealmResults<Person>, Boolean>() {
@Override
public Boolean call(RealmResults<Person> persons) {
// Only continue once data is actually loaded
// RealmObservables will emit the unloaded (empty) list as its first item
return persons.isLoaded();
}
})
.subscribe(new Action1<RealmResults<Person>>() {
@Override
public void call(RealmResults<Person> persons) {
personList = persons;
mSimpleAdapter.setData(personList);
mSimpleAdapter.notifyDataSetChanged();
}
}, new Action1<Throwable>() {
@Override
public void call(Throwable throwable) {
throwable.printStackTrace();
}
});
数据迁移
方法一、删除旧版本的数据
RealmConfiguration config = new RealmConfiguration.Builder()
.deleteRealmIfMigrationNeeded()
.build()
方法二、设置schema 版本和 migration,对改变的数据进行处理
RealmConfiguration config = new RealmConfiguration.Builder()
.schemaVersion(2) // Must be bumped when the schema changes
.migration(new Migration()) // Migration to run instead of throwing an exception
.build()
处理版本数据变化Migration
如何参考数据库
mac用户:
提供了一个独立的应用程序 Realm Browser 来读写.realm数据库。
你可以通过 Tools > Generate demo database 生成一个测试数据库。
查阅 StackOverflow 上的这个答案 获得有关你的应用程序 Realm 文件路径的详细说明。
Realm Browser 已经上架Map App Store。你也可以从我们 github 页面下载。
Realm Browser 目前不能运行在 Windows 或者 Linux 环境中。
但你可以使用Stetho-Realm。Stetho 是 Facebook 提供的桥接安卓调试和 Chrome 浏览器的组件。
Stetho 在realm中的使用
项目地址https://github.com/uPhyca/stetho-realm
使用:
在Appliction onCreate中加入
Stetho.initialize(
Stetho.newInitializerBuilder(this)
.enableDumpapp(Stetho.defaultDumperPluginsProvider(this))
.enableWebKitInspector(RealmInspectorModulesProvider.builder(this)
.databaseNamePattern(Pattern.compile(".+\\.realm"))
.build())
.build());
选择编译debug版本,成功运行到手机后,在谷歌浏览器中输入:
chrome://inspect/#devices
然后就可以查看数据库中的数据了。
这边有个问题:设置了数据库名字的 .name(DB_NAME),无法查看?暂时灭找到原因