Android Jetpack组件之数据库Room详解(一)

本文涉及Library的版本如下:

  • androidx.room:room-runtime:2.1.0-alpha03
  • androidx.room:room-compiler:2.1.0-alpha03(注解编译器)
  • androidx.room:room-rxjava2:2.1.0-alpha03

Room的介绍

Room为了SQLite提供了一个抽象层,对Android SQLite进行了封装 , 更加方便地进行数据库访问。

Room主要有3个组件:

  • Database: 数据库的持有者。
  • Entity: 代表数据库一张表
  • DAO: 数据访问对象

Room架构图如下:

room_architecture

从上图可以知道,应用层需要定义有哪些表; 定义数据访问对象; 定义数据库,比如说数据库名称,有哪些些表等。下面结合一些简单的代码例子:

1
2
3
4
5
6
7
8
9
10
// 定义User表, 用Entity注解来表示这个类是一个数据库表
@Entity
public class User {
// 使用ColumnInfo注解定义一个字段名, 不用注解默认去变量名
@ColumnInfo(name = "first_name")
public String firstName;

@PrimaryKey // 主键
public int id;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// 定义数据访问对象的接口
@Dao
public interface UserDao { // 定义成接口
// Query注解定义查询, 参数是sql语句
@Query("SELECT * FROM user")
List<User> getAll();

// 根据id查询user, :id这里意思是引用findById方法里参数id。是room定义固定写法:冒号+参数名称
@Query("SELECT * FROM user WHERE id = :id")
User findById(String id);
//Update注解定义更新User
@Update
void udapte(User user);
//Insert注解定义插入User
@Insert
void insert(User user);
//Delete注解定义删除User
@Delete
void delete(User user);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
//定义AppDatabase类,需要是abstract的,继承RoomDatabase
//使用Database注解,定义entities类, entities参数是一个class[],version是数据库的版本号
@Database(entities = {User.class, Favorite.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase {
public abstract UserDao userDao();
public abstract FavoriteDao favoriteDao();

private static final String DB_NAME = "room_demo";
private static volatile AppDatabase sInstance;

//通常定义一个单例持有AppDatabase引用
//DB_NAME是数据库文件名称
public static AppDatabase getInstance(Application app){
if(sInstance == null){
synchronized (AppDatabase.class){
if(sInstance == null){
sInstance = Room.databaseBuilder(app,
AppDatabase.class, DB_NAME).build();
}
}
}
return sInstance;
}
}

//操作数据库增删查
mAppDatabase = AppDatabase.getInstance(this.getApplication());
mAppDatabase.userDao().delete(user);
mAppDatabase.userDao().insert(user);
mAppDatabase.userDao().getAll();

数据库迁移

通过RoomDatabase.Builder.addMigrations()添加Migration去实现。代码示例如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
    static final Migration MIGRATION_1_2 = new Migration(1, 2) {
@Override
public void migrate(SupportSQLiteDatabase database) {
// database.execSQL("");执行sql语句
}
};

static final Migration MIGRATION_2_3 = new Migration(2, 3) {
@Override
public void migrate(SupportSQLiteDatabase database) {
// database.execSQL("");执行sql语句
}
};

Room.databaseBuilder(app,AppDatabase.class, DB_NAME)
.addMigrations(MIGRATION_1_2, MIGRATION_2_3)
.build();

支持RxJava、LiveData的扩展

在定义Dao接口时,可以直接LiveData和Flowable来作为返回数据类型。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
@Dao
public interface UserDao {
@Query("SELECT * FROM user")
LiveData<List<User>> getUsersLiveData();

@Query("SELECT * FROM user")
Flowable<List<User>> getUsersFlowable();
}

//LiveData使用例子
public class RoomActivity extends AppCompatActivity {

protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mRoomModel = ViewModelProviders.of(this).get(RoomModel.class);
mRoomModel.getUsersLiveData().observe(this, new Observer<List<User>>() {
@Override
public void onChanged(List<User> users) {
adapter.setData(users);//更新UI
}
});
}
}

public class RoomModel extends AndroidViewModel {
private final AppDatabase mAppDatabase;
public RoomModel(@NonNull Application application) {
super(application);
mAppDatabase = AppDatabase.getInstance(this.getApplication());
}

public LiveData<List<User>> getUsersLiveData() {
return mAppDatabase.userDao().getUsersLiveData();
}
}

//RxJava使用例子
mAppDatabase.userDao().getUsersFlowable()
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Consumer<List<User>>() {
@Override
public void accept(List<User> users) throws Exception {
adapter.setData(users);//更新UI
}
});

对RxJava不熟悉自己去了解, 对 LiveData不了解可以我之前的文章LiveData

一些遗留的问题

  • 利用注解Database并且继承RoomDatabase,到底是怎么生存数据库

  • 数据访问只需要定义一个DAO接口, Dao接口真正实现是怎样的,增删改查是如何实现的

  • 是如何扩展RxJava和LiveData, 并且如何能监听Flowable和LiveData数据的变更

参考:*

Loading comments box needs to over the wall