Android Jetpack之Room数据库的使用(Kotlin+Room)

作者：舒呐

一、基本介绍

Room 持久性库在 SQLite 上提供了一个抽象层，以便在充分利用 SQLite 的强大功能的同时，能够流畅地访问数据库。具体来说，Room 具有以下优势：

• 针对 SQL 查询的编译时验证。
• 可最大限度减少重复和容易出错的样板代码的方便注解。
• 简化了数据库迁移路径。

Room包含三个主要组件：

• 数据库类 (DataBase)， 用于保存数据库并作为应用持久性数据底层连接的主要访问点。
• 数据实体(Entity)， 用于表示应用的数据库中的表。
• 数据访问对象(DAO) ，提供您的应用可用于查询、更新、插入和删除数据库中的数据的方法。

二、使用详解

1、引入依赖， 在app文件夹下的build.gradle中的dependencies中引入依赖，注意添加id 'kotlin-kapt', kapt是必要的，不添加会报错。

plugins {
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
    id 'kotlin-kapt'
}

    implementation 'androidx.lifecycle:lifecycle-extensions:2.2.0'
    implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.4.0'
    implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.4.0'

    def room_version = "2.5.0"

    implementation "androidx.room:room-runtime:$room_version"
    kapt "androidx.room:room-compiler:$room_version"
    implementation("androidx.room:room-rxjava2:$room_version")

    // optional - RxJava3 support for Room
    implementation("androidx.room:room-rxjava3:$room_version")

    // optional - Guava support for Room, including Optional and ListenableFuture
    implementation("androidx.room:room-guava:$room_version")

    // optional - Test helpers
    testImplementation("androidx.room:room-testing:$room_version")

    // optional - Paging 3 Integration
    implementation("androidx.room:room-paging:$room_version")

2、@Entity，使用Room定义一个数据实体User(带Entity注解的类)，一个Entity表由主键和一个或多个列组成，User中的每个实例都代表着User表中的一行，tableName后面为表名，在不指定表名的情况下，默认将类名作为数据表的名称。Room默认使用字段名称作为列名称，如需更改，采用@ColumnInfo注解设置name属性(列名)。

/**
 * @PrimaryKey(autoGenerate = true)表示主键自增，参数autoGenerate表示主键可以由数据库自动生成
 * @ColumnInfo(name = "id"）表示列的名字为id
 * @Ignore表示会忽略这个字段，不进行记录
 */
@Entity(tableName = "user")
data class User(
    @PrimaryKey(autoGenerate = true)
    @ColumnInfo(name = "id")
    var id: Int = 0,

    @ColumnInfo(name = "userNum")
    val userNum: String,
    @ColumnInfo(name = "userPwd")
    val userPwd: String= null,
    @ColumnInfo(name = "sex")
    val sex: String= null,
    @ColumnInfo(name = "age")
    val age: Int ,
    @ColumnInfo(name = "school")
    val school: String= null,
)

3、@Dao， 使用@Dao注解定义为一个BaseDao接口，增加基本的插入、删除、修改方法，再定义一个UserDao去扩展BaseDao接口，增加需要的方法。

• @Insert，插入，可以定义将其参数插入数据库中的相应表的方法
• @Delete，删除，可以定义用于从数据库表中删除特定行的方法
• @Update，修改，可以定义用于更新数据库表中特定行的方法
• @Query， 查询，可以从应用的数据库查询指定数据，用于更加复杂的插入、删除、更新操作

@Dao
interface BaseDao<T> {
    @Insert
    fun insert(bean: T)

    @Insert
    fun insertAll(bean: T)

    @Delete
    fun delete(bean:T)

    @Update
    fun update(bean: T)

}

@Dao
interface UserDao : BaseDao<User> {

    @Query("select * from user where userNum = :userNum")
    fun getByNum(userNum: String): User?

    /**
     * 查询表里所有数据
     */
    @Query("select * from user")
    fun getAllUser(): User?

    /**
     * 根据字段删除记录
     */
    @Query("delete from user where userNum = :userNum")
    fun deleteByNum(userNum: String)


    /**
     * 修改指定用户的密码
     */
    @Query("update user set userPwd =:userPwd where userNum =:userNum")
    fun updatePwd(userNum: String, userPwd: String)

}

4、@DataBase， 定义用户保存数据库的MyDataBase类，定义数据库配置。@DateBase类需满足如下条件：

• 必须带有DataBase注解，此注解中需列出与数据库相关联的实体类数组。
• 必须是抽象类，用于扩展RoomDataBase
• 对于每个与数据库关联DAO 类，在该类中必须定义一个具有零参数的抽象方法，并返回 DAO 类的实例。

@Database(
    entities = [User::class],
    version = 1,
    exportSchema = false
)
abstract class MyDataBase : RoomDatabase() {

    abstract fun userDao(): UserDao


    companion object {
        val instance = Room.databaseBuilder(appContext, MyDataBase::class.java, "chat_db").build()
    }
}

5、 在MainActivity中进行调用

import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import androidx.lifecycle.lifecycleScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        insertData()
        updateData()
        deleteData()
        queryData()
    }

    /**
     * 插入一条数据
     */
    private fun insertData() {
        lifecycleScope.launch(Dispatchers.IO) {
            MyDataBase.instance.userDao().insert(
                User(
                    userNum = "GSHD",
                    userPwd = "1231343",
                    sex = "女",
                    age = 18,
                    school = "XXXXX"
                )
            )
        }
    }

    /**
     * 查询 userNum = "GSHD" 的记录
     */
    private fun queryData() {
        lifecycleScope.launch(Dispatchers.IO) {
            MyDataBase.instance.userDao().getByNum(
                userNum = "GSHD"
            )
        }
    }

    /**
     * 修改 userNum = "GSHD" 的userPwd
     */
    private fun updateData() {
        lifecycleScope.launch(Dispatchers.IO) {
            MyDataBase.instance.userDao().updatePwd(
                userNum = "GSHD",
                userPwd = "111111",
            )
        }
    }

    /**
     * 删除 userNum = "GSHD" 的数据
     */
    private fun deleteData() {
        lifecycleScope.launch(Dispatchers.IO) {
            MyDataBase.instance.userDao().deleteByNum(userNum = "GSHD")
        }
    }
}