Android Jetpack Room 的使用

官网链接 使用 Room 将数据保存到本地数据库 | Android 开发者 | Android Developers
https://developer.android.google.cn/training/data-storage/room?hl=zh_cn

Room 用于处理数据库。它在 SQLite 上提供了一个抽象层，以便在充分利用 SQLite 的强大功能的同时，能够流畅地访问数据库。

Google 推荐使用 Room 而不是 SQLite 。

借用官网说明，
Room 包含 3 个主要组件：

• 数据库：包含数据库持有者，并作为应用已保留的持久关系型数据的底层连接的主要接入点。

  使用 @Database 注释的类应满足以下条件：

  • 是扩展 RoomDatabase 的抽象类。
  • 在注释中添加与数据库关联的实体列表。
  • 包含具有 0 个参数且返回使用 @Dao 注释的类的抽象方法。
  • 在运行时，您可以通过调用 Room.databaseBuilder() 或 Room.inMemoryDatabaseBuilder() 获取 Database 的实例。

• Entity：表示数据库中的表。

• DAO：包含用于访问数据库的方法。

开始使用。

1.添加依赖

在 app 的 build.gradle 中添加依赖，

dependencies {
    def room_version = "2.3.0"

    // Room
    implementation "androidx.room:room-runtime:$room_version"
    kapt "androidx.room:room-compiler:$room_version" //不添加会报错
}

添加插件 kotlin-kapt

plugins {
    id 'com.android.application'
    id 'kotlin-android'
    id 'kotlin-android-extensions'
    id 'kotlin-kapt' //这行
}

2.实现 Entity

Entity 标识数据库中的表，其实也就是对应的 JavaBean 。

import androidx.room.Entity
import androidx.room.PrimaryKey

@Entity
data class Customer(var name:String ,var profession:String, var deposit: Long) {

    @PrimaryKey(autoGenerate = true)
    var id:Long = 0

}

这里创建了 Customer 类，并用 @Entity 注解，将它声明为实体类。

在类中添加 id 字段，使用 @PrimaryKey 注解将它设为主键，autoGenerate = true 是使得主键是自动生成的。

3.定义 Dao 接口

Dao 是访问数据库的方法，一般是增删改查，但要覆盖所有的业务需求。

import androidx.room.*

@Dao
interface MyCustomerDao {

    @Insert
    fun insertCustomer(customer: Customer):Long

    @Update
    fun updateCustomer(newCustomer: Customer)

    @Query("select * from Customer")
    fun getAllCustomer(): List<Customer>

    @Query("select * from Customer where name = :name")
    fun queryCustomerByName(name: String): List<Customer>

    @Query("select * from Customer where deposit >= :deposit")
    fun queryCustomerByDeposit(deposit: Long): List<Customer>

    @Delete
    fun deleteCustomer(customer: Customer)

    @Query("delete from Customer where name = :name")
    fun deleteCustomerByName(name: String)
}

声明一个接口，使用 @Dao 注解，这样 Room 就知道它是 Dao 了。

增删改查方法分别用注解 @Insert 、@Delete 、@Update 、@Query 。

需要用到一些 SQL 语句。Room 支持编译时检查，如果 SQL 语句有错误，编译时就报错了，可以及时发现。

4.实现自定义 RoomDatabase

编写抽象类，继承 RoomDatabase ，

import android.content.Context
import androidx.room.Database
import androidx.room.Room
import androidx.room.RoomDatabase

@Database(version = 1, entities = [Customer::class])
abstract class MyDatabase: RoomDatabase(){

    abstract fun myCustomerDao() : MyCustomerDao

    companion object {
        private var instant: MyDatabase ?= null

        @Synchronized
        fun getDatabase(context: Context): MyDatabase {
            instant?.let { return it }

            return Room.databaseBuilder(
                context.applicationContext,
                MyDatabase::class.java,
                "my_database"
            )
            	.allowMainThreadQueries()
                .build()
                .apply {
                    instant = this
                }
        }
    }
}

声明为抽象类 MyDatabase ，类的头部使用 @Database 注解，并在注解中声明版本号和包含的实体类（也就是Entity）。

类中提供对应的抽象方法，用户获取 Dao 的实例。
在 companion object { } 中编写一个单例，使用 Room.databaseBuilder() 方法创建 MyDatabase 实例，传入3个参数，第一个是 context ，第二个参数是 MyDatabase 的 class 类型，第三个参数是数据库名。

数据库操作是耗时的，Room 默认不允许在主线程中操作，所以这些操作要放到子线程。
为了方便调试，在创建数据库实例时使用 allowMainThreadQueries() 方法，就可以在主线程操作。这个方法建议调试时使用，毕竟主线程执行耗时操作是不好的。

5.使用

获取 Dao 实例，

val dao = MyDatabase.getDatabase(this).myCustomerDao()

调用定义好的 Dao 接口来实现增删改查，

增（也就是插入数据）

var customer1 = Customer("Zhang", "Student", 100)
var customer2 = Customer("Li", "Student", 200)
var customer3 = Customer("Wang", "Student", 300)

customer1.id = dao.insertCustomer(customer1)
customer2.id = dao.insertCustomer(customer2)
customer3.id = dao.insertCustomer(customer3)

删

dao.deleteCustomerByName("Wang")
dao.deleteCustomer(customer3)

改 （也就是更新）

customer3.deposit = 500
dao.updateCustomer(customer3)

查

val list = dao.getAllCustomer()
val list = dao.queryCustomerByDeposit(200)