Jetpack第六篇：Room基本使用
1、什么是Room
轻量级 ORM 数据库，本质上是一个SQLite。首先ORM是：对象关系映射
具体看下ORM的解释：什么是ORM？为什么用ORM？浅析ORM的使用及利弊 - 简书 (jianshu.com)
对象关系映射（Object Relational Mapping，简bai称ORM）模式是一种du为了解决面向对象与关系zhi数据库存在的互不匹配的现象的技dao术。简单的说，ORM是通过使用描述对象和数据库之间映射的元数据，将程序中的对象自动持久化到关系数据库中。
2、Room的基本用法
Room可以直接使用，也可以和LiveData和RxJava联用。这个看个人的使用习惯。本文也会有LiveData和Rxjava的简单用法。
2.1、导入依赖
// room
implementation "androidx.room:room-runtime:2.3.0"
implementation "androidx.room:room-ktx:2.3.0"
kapt 'androidx.room:room-compiler:2.3.0'
// room-rxjava
implementation "androidx.room:room-rxjava2:2.3.0"
implementation "io.reactivex.rxjava2:rxandroid:2.1.0"
// liveData
implementation 'androidx.lifecycle:lifecycle-livedata-ktx:2.3.0'
// ViewModel
implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.3.0'
2.2、一些常用的注解
Room通过一些注解来标注一些类的作用，比如Database，Dao等等。
- Database(entities =[],version=0）这个是用于标记DataBase初始化的，被标注的这个类会继承RoomDatabase，entities是一个集合，里面是所有数据库表的类。version代表数据库的版本。
- @Entity 代表数据库表 里面包含 @PrimaryKey主键等等注解
- @Dao 代表数据库操作类，里面可以使用@Query查询，@Insert插入，@Update修改，@Delete删除等注解
2.3、创建DataBase类
@Database(entities = [User::class],version = 1)
abstract class AppDataBase : RoomDatabase() {
companion object{
private var instance:AppDataBase? = null
fun getInstance(context: Context):AppDataBase{
if(instance == null){
synchronized(AppDataBase::class){
instance = Room.databaseBuilder(context,AppDataBase::class.java,"app_db")
.allowMainThreadQueries()
.build()
}
}
return instance!!
}
}
}
这个类被@Database标记，继承RoomDataBase，这个类是数据库类，数据库的版本，升级和各项初始化配置都在这里进行。
2.4、添加表
@Entity
data class User(
@PrimaryKey
var id: Int,
var name: String,
var gender: Int
)
被注解@Entity标记，代表这个是一个数据库表，@PrimaryKey为主键
2.5、添加Dao
@Dao
interface UserDao {
/**
* 普通的获取数据
*/
@Query("SELECT * FROM user")
fun getUsers(): MutableList<User>
/**
* 和Rxjava联用的获取数据
*/
@Query("SELECT * FROM user")
fun getUsersByRxjava() :Single<MutableList<User>>
@Query("SELECT * FROM user where id=:id")
fun getUserById(id: Int): User
@Insert
fun insertUser(user: User):Long
@Update
fun updateUser(user: User):Int
@Delete
fun deleteUser(user:User):Int
}
被@Dao注解标记，这个是数据库操作类，可以使用增删改查的一些注解标记方法。
@Query：为查询表中的数据的意思
@Update：修改的表中的数据的意思
@Insert：插入新的表数据
@Delete： 删除表的数据
2.5、Room实战
我这边做了一个简单的用户管理系统，这是一个基本的使用demo，可以提供一些基本使用的参考。
代码地址放在了最后了，感兴趣可以看下。
2.6、与LiveData联用
Room是可以和LiveData联用的，我写了一个简单的demo来实现和LiveData联用。
实际上如果有看过我前面写的文章，接下来的代码应该非常通俗易懂。
ViewModel和LiveData代码：
class UserViewModel: ViewModel() {
// 获取用户列表的LiveData
var userLiveData: MutableLiveData<MutableList<User>> = MutableLiveData()
fun getUserList(context: Context) {
viewModelScope.launch {
val getUserListener = AppDataBase.getInstance(context).userDao().getUsers()
userLiveData.postValue(getUserListener)
}
}
}
private fun getUserListByLiveData() {
viewModel.userLiveData.observe(this , Observer {
userList.clear()
userList.addAll(it)
listAdapter.notifyDataSetChanged()
})
}
2.7、与Rxjava联用
如果要和Rxjava联用可以需要添加依赖：
implementation "androidx.room:room-rxjava2:2.3.0"
dao的方法需要改成这样：
/**
* 和Rxjava联用的获取数据
*/
@Query("SELECT * FROM user")
fun getUsersByRxjava() :Single<MutableList<User>>
private fun getUserListByRxJava() {
var disposable = AppDataBase.getInstance(this)
.userDao().getUsersByRxjava().subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe({
userList.clear()
userList.addAll(it)
listAdapter.notifyDataSetChanged()
}, {
})
mDisposables?.add(disposable)
}
Insert、update、delete操作可以返回Complete，Single，Maybe三种对象，如果query操作，可以返回single，maby，也可以返回Observable，Flowable。
这几个对象的区别：
Completable：只有onComplete和onError方法，即是只有“完成”和“错误”两种状态，不会返回具体的结果。
Single：其回调为onSuccess和onError，查询成功会在onSuccess中返回结果，需要注意的是，如果未查询到结果，即查询结果为空，会直接走onError回调，抛出EmptyResultSetException异常。
Maybe：其回调为onSuccess，onError，onComplete，查询成功，如果有数据，会先回调onSuccess再回调onComplete，如果没有数据，则会直接回调onComplete。
Flowable/Observable：这俩相信不用多介绍了，这是返回一个可观察的对象，每当查询语句查询的部分有变化时，都会回调它的onNext方法，直到Rx流断开。
以上引用CSDN文档。
————————————————
版权声明：本文为CSDN博主「@空大」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/Ricardo6/article/details/88385613
3、数据库升级
数据库升级在每一个版本上新的时候会经常遇到，一般是表字段进行了修改。一般新增一些字段的情况比较多。以下四步是完成数据库升级的基本步骤。
3.1、添加Entity字段
原Entity
@PrimaryKey
var id: Int,
var name: String,
var gender: Int
)
添加一个String类型的字段：
@Entity
data class User(
@PrimaryKey(autoGenerate = true)
var id: Int,
var name: String?,
var gender: Int,
var hobby:String?
)
3.2、修改AppDataBase的版本号
原来的版本号：
@Database(entities = [User::class], version = 1)
修改后的版本号：
@Database(entities = [User::class], version = 2)
注意：version的版本号要和下面提到的MIGRATION要对应上！
3.3、添加MIGRATION
添加一个MIGRATION，并且添加上修改数据库表字段的sql代码：
private val MIGRATION_1_2 = object : Migration(1, 2) {
override fun migrate(database: SupportSQLiteDatabase) {
database.execSQL("ALTER TABLE User ADD COLUMN hobby TEXT")
}
}
注意： Migration(1, 2)代表数据库版本从1升级到2，和前一步修改数据库版本对应。
3.4、将添加的MIGRATION添加到数据构造中去
fun getInstance(context: Context): AppDataBase {
if (instance == null) {
synchronized(AppDataBase::class.java) {
instance = Room.databaseBuilder(
context.applicationContext,
AppDataBase::class.java,
"app_db"
)
// MIGRATION添加到这里
.addMigrations(MIGRATION_1_2)
.allowMainThreadQueries()
.build()
}
}
return instance!!
}
// MIGRATION
private val MIGRATION_1_2 = object : Migration(2, 3) {
override fun migrate(database: SupportSQLiteDatabase) {
database.execSQL("ALTER TABLE User ADD COLUMN hobby TEXT")
}
}
如果有多个MIGRATION则往后添加：
.addMigrations(MIGRATION_1_2, MIGRATION_3_4, MIGRATION_4_5, MIGRATION_5_6, MIGRATION_6_7)
以上四步就是最基本的升级数据库的操作了，数据库升级操作还有很多种情况，这里推荐这些链接看看。
https://www.jianshu.com/p/a729f6ee37db?tdsourcetag=s_pcqq_aiomsg
https://www.jianshu.com/p/fae0245cf384
https://www.jianshu.com/p/633ffc49da92
以上就是room数据库的基本使用了，当了解一些基本的流程之后，实际上使用起来还是比较简单的。
因为简书不可以挂源码链接，所以源码没法挂到这里了。
