前言:
Realm数据库是基于C++编写的一个不同于SQLite数据库的数据库引擎,是一个可以替代SQLite以及ORMlibraries的移动端数据库。相比SQLite/ORMlibraries,Realm更轻量级,更快,并且具有很多现代数据库的特性,支持JSON,流式api,数据变更通知,以及加密支持,这给android开发者提供了不少帮助。使用起来更是通俗易懂,简单快捷。目前Realm最新版本是2.x,支持Java,Objective C,Swift,React-Native,tamarin五种编程方式,而下文所讲内容都是基于Realm2.x。通过介绍和使用本案例,学习和了解Realm的基本用法。
更多详细介绍请参见官网 :https://realm.io/
基本使用:
▲配置与导入
在项目Project的build.gradle文件中添加依赖:
在app的build文件加上:
在Application 中初始化,不配置也可以,就是默认
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
Realm.init(this);
//默认配置
//RealmConfiguration configuration=new RealmConfiguration.Builder().build();
//自定义配置
RealmConfiguration configuration = new RealmConfiguration.Builder()
.name("donkor.realm")
.deleteRealmIfMigrationNeeded()
.build();
Realm.setDefaultConfiguration(configuration);
}
同时需要在AndroidManifest.xml中配置
▲案例介绍
图书馆管理系统,其实说白了就是数据库的增删改查,本案例中的增删改查只针对本地Realm的数据库。Realm提供给我们的增删改查操作足够快,在UI线程中执行操作就行。但是如果遇到较复杂的增删改查,或操作的数据较多时,就可以子线程进行操作,使用异步进行增删改查。案例分为两个模块,一个为学生管理,和图书管理,而图书管理则使用异步进行增删改查。
▲创建实体类
- 学生实体:有相应的用户名,密码,姓名,多本收藏的图书
- 图书实体:有相应的书名,作者,出版社
创建Student类继承RealmObject
public class Student extends RealmObject {
//用来标示主键
@PrimaryKey
private String name;
private long password;
private String nickname;
//一对多的关系
private RealmList<Book> books;
public RealmList<Book> getBooks() {
return books;
}
public void setBooks(RealmList<Book> books) {
this.books = books;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public long getPassword() {
return password;
}
public void setPassword(long password) {
this.password = password;
}
public String getNickname() {
return nickname;
}
public void setNickname(String nickname) {
this.nickname = nickname;
}
}
创建Book类继承RealmObject
public class Book extends RealmObject {
private String name;
private String author;
private String publishing;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getAuthor() {
return author;
}
public void setAuthor(String author) {
this.author = author;
}
public String getPublishing() {
return publishing;
}
public void setPublishing(String publishing) {
this.publishing = publishing;
}
}
※ 注: 同时必须知道的注解说明
@PrimaryKey
- 字段必须是String、 integer、byte、short、 int、long 以及它们的封装类Byte, Short, Integer, and Long
- 使用了该注解之后可以使用copyToRealmOrUpdate()方法,通过主键查询它的对象,如果查询到了,则更新它,否则新建一个对象来代替。
- 使用了该注解将默认设置(@index)注解
- 使用了该注解之后,创建和更新数据将会慢一点,查询数据会快一点。
@Required
- 数据不能为null
@Ignore
- 忽略,即该字段不被存储到本地
@Index
- 为这个字段添加一个搜索引擎,这将使插入数据变慢、数据增大,但是查询会变快。建议在需要优化读取性能的情况下使用。
▲学生管理CRUD
一、增(添加学生)
可以使用事务操作或使用事务块,两种方法对数据库进行增加操作,同理,以下删,改操作同样可以使用以上两种方法。而增添学生可以使用以下三种方式
1.新建一个对象,并进行存储
Realm realm = Realm.getDefaultInstance();
realm.beginTransaction();
Student student = realm.createObject(Student.class);
student.setName("donkor");
student.setPassword(123456);
student.setNickname("aaa");
realm.commitTransaction();
2.复制一个对象到Realm数据库
Realm realm = Realm.getDefaultInstance();
realm.beginTransaction();
Student student=new Student();
student.setName("donkor");
student.setPassword(123456);
student.setNickname("aaa");
realm.copyToRealm(student);
realm.commitTransaction();
3.使用事务块
Realm realm = Realm.getDefaultInstance();
final Student student = new Student();
student.setName("donkor");
student.setPassword(123456);
student.setNickname("aaa");
realm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
realm.copyToRealm(student);
}
});
而为学生添加多本图书则可以使用以下两种方式
//数据库添加一本新书,同时为该同学添加该书
Book book = new Book();
book.setName("第一行代码");
book.setAuthor("路人甲");
book.setPublishing("图灵");
student.getBooks().add(book);
或者
//从数据库中找到某一本书,添加给该同学
Book b=realm.where(Book.class).equalTo("name","第一行代码").findFirst();
student.getBooks().add(b);
二、删(删除学生)
方法一使用事务操作
Realm realm = Realm.getDefaultInstance();
realm.beginTransaction();
Student student = realm.where(Student.class).equalTo("name", "donkor").findFirst();
//指定student从数据库中删除
student.deleteFromRealm();
realm.commitTransaction();
方法二使用事务块
final Realm realm = Realm.getDefaultInstance();
realm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
Student student=realm.where(Student.class).equalTo("name","donkor").findFirst();
//指定student从数据库中删除
student.deleteFromRealm();
}
});
※ 注:除了删除指定某项数据时,还提供以下方法进行删除数据库操作
RealmResults<Student> rrStudents = realm.where(Student.class).findAll();
//删除第一个Student数据
rrStudents.deleteFirstFromRealm();
//删除最后一个Student数据
rrStudents.deleteLastFromRealm();
//删除位置为1的Student数据
//坐标从0开始,0为第一项数据,1为第二项
rrStudents.deleteFromRealm(1);
//删除所有Student数据
rrStudents.deleteAllFromRealm();
三、改(修改学生)
方法一使用事务操作
Realm realm = Realm.getDefaultInstance();
Student student = realm.where(Student.class).equalTo("name", "donkor").findFirst();
realm.beginTransaction();
student.setName("newDonkor");
student.setPassword(132654);
student.setNickname("bbb");
realm.commitTransaction();
方法二使用事务块
Realm realm = Realm.getDefaultInstance();
final Student student = realm.where(Student.class).equalTo("name", "donkor").findFirst();
realm.executeTransaction(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
student.setName("newDonkor");
student.setPassword(132465);
student.setNickname("bbb");
}
});
四、查(查询学生)
查询全部
Realm realm = Realm.getDefaultInstance();
//查询全部学生
RealmResults<Student> students = realm.where(Student.class).findAll();
//realm.copyFromRealm(students)方法将它转为List<Student>
List<Student> studentList = realm.copyFromRealm(students);
条件查询
Realm realm = Realm.getDefaultInstance();
//根据name查找第一个student信息
Student student = realm.where(Student.class).equalTo("name", "donkor").findFirst();
※ 注: 常用的条件查询包括
- between(), greaterThan(), lessThan(), greaterThanOrEqualTo() 与 lessThanOrEqualTo()
- equalTo() 与 notEqualTo()
- contains()、beginsWith() 与 endsWith()
- isNull() 与 isNotNull()
- isEmpty() 与 isNotEmpty()
※ 注: 同时不仅支持对查询结果的排序(默认为升序排序),还支持聚合查询,包括sum,min,max,average
▲图书管理CRUD
一、异步增(添加图书)
Realm realm = Realm.getDefaultInstance();
RealmAsyncTask addTask = realm.executeTransactionAsync(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
Book book = new Book();
book.setName("第一行代码");
book.setAuthor("郭霖");
book.setPublishing("图灵");
realm.copyToRealm(book);
}
}, new Realm.Transaction.OnSuccess() {
@Override
public void onSuccess() {
Toast.makeText(AddBookActivity.this, "Add success", Toast.LENGTH_SHORT).show();
}
}, new Realm.Transaction.OnError() {
@Override
public void onError(Throwable error) {
Toast.makeText(AddBookActivity.this, "Add error", Toast.LENGTH_SHORT).show();
}
});
二、异步删(删除图书)
Realm realm = Realm.getDefaultInstance();
RealmAsyncTask addTask = realm.executeTransactionAsync(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
//删除指定图书
Book book = realm.where(Book.class).equalTo("name", "donkor").findFirst();
book.deleteFromRealm();
}
}, new Realm.Transaction.OnSuccess() {
@Override
public void onSuccess() {
Toast.makeText(AddBookActivity.this, "Delete success", Toast.LENGTH_SHORT).show();
}
}, new Realm.Transaction.OnError() {
@Override
public void onError(Throwable error) {
Toast.makeText(AddBookActivity.this, "Delete error", Toast.LENGTH_SHORT).show();
}
});
三、异步改(修改图书)
Realm realm = Realm.getDefaultInstance();
RealmAsyncTask addTask = realm.executeTransactionAsync(new Realm.Transaction() {
@Override
public void execute(Realm realm) {
//删改指定图书
Book book = realm.where(Book.class).equalTo("name", "donkor").findFirst();
book.setName("第二行代码");
book.setAuthor("郭霖");
book.setPublishing("图灵");
}
}, new Realm.Transaction.OnSuccess() {
@Override
public void onSuccess() {
Toast.makeText(AddBookActivity.this, "Update success", Toast.LENGTH_SHORT).show();
}
}, new Realm.Transaction.OnError() {
@Override
public void onError(Throwable error) {
Toast.makeText(AddBookActivity.this, "Update error", Toast.LENGTH_SHORT).show();
}
});
※ 注: 以上异步增删改操作在销毁Activity或Fragment时,都不要忘记了要取消掉异步任务
@Override
protected void onDestroy() {
super.onDestroy();
//取消异步操作
if (addTask != null && !addTask.isCancelled()) {
addTask.cancel();
}
}
四、异步查(查询图书)
Realm realm = Realm.getDefaultInstance();
//查询全部图书
RealmResults<Book> books = realm.where(Book.class).findAllAsync();
books.addChangeListener(callback);
private RealmChangeListener callback = new RealmChangeListener() {
@Override
public void onChange(Object element) {
List<Book> bookList = realm.copyFromRealm(books);
BookAdapter bookAdapter = new BookAdapter(QueryBookActivity.this, bookList);
lvBooks.setAdapter(bookAdapter);
}
};
RealmChangeListener 在退出程序的时候要注销监听
@Override
protected void onDestroy() {
super.onDestroy();
//注销指定的监听
books.removeChangeListener(callback);
//注销所有监听
books.removeChangeListeners();
}
最后看下我们实现了的功能和效果图
github下载地址:https://github.com/ChenYXin/RealmDemo
关于我:
- Android开发交流QQ群:537891203
- 邮箱:donkor@yeah.net