初探Jetpack(四) -- ROOM 数据库

初探Jetpack(一) – ViewModel
初探Jetpack(二) – Lifecycles
初探Jetpack(三) – LiveData
Demo工程

Android 虽然自身携带SQLite,但是操作比较麻烦,而且如果再大型项目,会变得比较混乱且难以维护,除非你设计了一套非常好的架构和封装。
当然,如果要操作简单的话,郭老师的 Litepal 算不错的,不过我们今天学习 google 在 Jetpack 中带的组件 — ROOM ,今天一起来学习。

一 、ROOM 的基本使用

首先,ROOM 由 Entity ,Dao 和 Database 三个部分组成:

  • Entity:用于定义iFeng准给实际数据的实体类,每个实体类都会在数据库中对应一张表,并且表中的列是根据实体类的字段自动生成的。
  • Dao :Dao 是数据访问对象的意思,通常会在这里对数据库的各项操作进行封装,比如 增删查改,这样,访问数据时,就不用去管底层数据库了,只需要跟Dao打交道即可
  • Database:用于定义数据库中的关键信息,包括版本号,包含哪些实体类以及 提供 Dao 的访问层

如果你需要使用 ROOM ,需要在你的moudle build.gradle 添加插件

apply plugin: 'kotlin-kapt'

关联依赖:

//room
implementation 'androidx.room:room-runtime:2.1.0'
kapt 'androidx.room:room-compiler:2.1.0'

kpt 为注解的意思,相当于 java 的 annotationProcessor。

1.2 创建实体类

接着,我们创建一个实体类,User:

@Entity
data class UserData (
    @PrimaryKey val uid: Int,
    @ColumnInfo(name = "first_name") val firstName: String?,
    @ColumnInfo(name = "last_name") var lastName: String?
)

可以看到,我们用了 @Entity 注解,将它申明成一个实体类,然后添加了一个 id 字段,并使用 @PrimaryKey 注解将它设置成主键,然后参数使用 @ColumnInfo 注解,表示表的列。

1.3 设置 Dao

在数据库中,最常见的就是 增删查改了,但业务是千变万化的,而 Dao 要做的事情就是覆盖这些业务,这样我们的逻辑就只要和 Dao 打交道,而不用去理会底层数据库。

新建一个 UserDao ,注意必须是接口,然后编写以下代码:

@Dao
interface UserDao {

    @Query("SELECT * FROM userdata")
    fun getAll(): List

    @Update
    fun updateUser(user: UserData)

    @Query("SELECT * FROM userdata WHERE first_name LIKE :first AND " +
            "last_name LIKE :last LIMIT 1")
    fun findByName(first: String, last: String): UserData

    @Insert
    fun insertAll(vararg users: UserData)

    @Delete
    fun delete(user: UserData)

    @Query("delete from UserData where last_name = :lastName")
    fun deleteByLastName(lastName:String) :Int
}

可以看到,UserDao 用 @Dao 注解,ROOM 才会识别成 Dao,并提供了 @Insert、@Update、 @Delete, @Query 四种对应的注解。

其中 @Insert 插入数据后,会返回自动生辰的主键 id,而特别要注意则是 @Query 注解,ROOM 无法知道我们要查询哪些数据,因此必须编写 SQL 语句才行。
如果我们不是用实体类参数去 增删改 数据,那么也要编写SQL 语句才行,这个时候,不能使用 @Inset @Delete @update 注解,而都是使用 @Query 注解才行,比如上面的 deleteByLastName 方法。

虽然要编写 SQL 语句这点不太友好,但Room是编译时动态检查 SQL 语句的,也就是说,如果你的SQL 没有写对,编译时就会报错。

1.3 编写 Database

Database 需要定义版本号啊,包含了哪些实体类,以及提供 Dao 层的访问实例即可。新建一个 AppDatabase.kt ,代码如下:


@Database(version = 1,entities = [UserData::class])
abstract class AppDataBase : RoomDatabase(){
    abstract fun userDao() : UserDao

    companion object{
        private var instance : AppDataBase ? = null;
        @Synchronized
        fun getDatabase(context:Context) : AppDataBase{
            instance?.let {
                return it
            }

            val db = Room.databaseBuilder(
                context.applicationContext,
                AppDataBase::class.java, "AppDataBase"
            ).build()
            return db.apply {
                instance = this;
            }
        }
    }
}

可以看到,AppDataBase 类的头部使用了 @Database 的注解,并填写了版本号,以及实体类,如果有多个实体类,用逗号隔开即可。

需要注意的是,AppDataBase 需要申明为抽象类,并申明 Dao 的抽象方法,比如 userDao()。

接着,由于Dao 理论上应该就是一个单例模式,所以这里用 companion objec 修饰,当 getDatabase 中,如果已经存在,则直接返回,如果不存在,则通过 Room.databaseBuilder 去创建build,它接收三个参数:

  1. context:这里最好用 applicationContext 防止内存泄漏
  2. class 类型,这里传递 AppDataBase::class.java
  3. 数据库名
    然后通过 apply 拿到实例,并赋值给 instance 即可。

ok,Room 的配置已经完成了,接着,我们在 xml 中添加 4 个按钮:

    

初探Jetpack(四) -- ROOM 数据库_第1张图片
在 activity 中添加代码:

        val userDao = AppDataBase.getDatabase(this).userDao();
        val user1 = UserData(1,"z","sr")
        val user2 = UserData(2,"w","y")

        //添加数据
        addDataBtn.setOnClickListener{
            thread {
                userDao.insertAll(user1,user2)
            }
        }
        //更新数据
        updateBtn.setOnClickListener{
            thread {
                 user2.lastName = "san"
                 userDao.updateUser(user2)
            }
        }

        //删除
        deleteBtn.setOnClickListener{
            thread {
               // userDao.delete(user1)
                userDao.deleteByLastName("sr")
            }
        }

        //查询
        queryBtn.setOnClickListener{
            thread {
                for (user in userDao.getAll()){
                    Log.d(TAG, "zsr onCreate: "+user.toString())
                }
            }
        }

ROOM 要求查询数据库在 线程中,所以这里用了 thread{},如果你觉得需要在主线程中去更新,可以在配置中设置:

val db = Room.databaseBuilder(
            context.applicationContext,
            AppDataBase::class.java, "AppDataBase"
        ).allowMainThreadQueries().build()

点击增加,然后按查询:
在这里插入图片描述
点击更新,然后查询:
在这里插入图片描述
点击删除,然后查询:
在这里插入图片描述

二、数据库升级

ROOM 的数据库升级比较麻烦,如果在测试阶段,可以使用 fallbackToDestructiveMigration() 强制升级

val db = Room.databaseBuilder(
    context.applicationContext,
    AppDataBase::class.java, "AppDataBase"
).fallbackToDestructiveMigration().build()

2.1 、新增一张表

但,仅限于测试,如果我要增加一张表呢?比如增加一个 Book:

@Entity
data class Book(var name:String,var pages:Int) {
    @PrimaryKey(autoGenerate = true)
    var id:Long = 0;
}

并添加一个 BookDao 接口:

@Dao
interface BookDao  {
    @Insert
    fun insertBook(book: Book)
    
    @Query("select * from Book")
    fun loadAllBooks() : List
}

然后修改 AppDataBase:

@Database(version = 2, entities = [UserData::class, Book::class])
abstract class AppDataBase : RoomDatabase() {
    abstract fun userDao(): UserDao
    abstract fun bookDao(): BookDao
    companion object {

	val Migration1_2 = object : Migration(1, 2) {
                override fun migrate(database: SupportSQLiteDatabase) {
                    database.execSQL("create table Book (id integer primary key autoincrement not null," +
                            "name text not null ,pages integer not null)")
                }
            }

        private var instance: AppDataBase? = null;

        @Synchronized
        fun getDatabase(context: Context): AppDataBase {
            instance?.let {
                return it
            }
            
            val db = Room.databaseBuilder(
                context.applicationContext,
                AppDataBase::class.java, "AppDataBase"
            ).addMigrations(Migration1_2).build()
            return db.apply {
                instance = this;
            }
        }
    }
}

可以看到,我们在 @Database 注解中,修改版本为2,并添加 BookDao 类。

接着,实现一个 Migration 匿名类,重写 migrate 方法,并在里面编写 SQL 语句,添加一个 Book 表;接着,在 Room.databaseBuilder() 那里,通过 addMigrations(Migration1_2) 添加进去。
这样,当 SQL 版本从1变到2 的时候,就会执行 Migration1_2 里面的方法。

接着,调用一下:

        val bookDao = AppDataBase.getDatabase(this).bookDao()

        //添加数据
        addDataBtn.setOnClickListener{
            thread {
                 bookDao.insertBook(Book("android",100))
            }
        }
    

        //查询
        queryBtn.setOnClickListener{
            thread {
                for (book in bookDao.loadAllBooks()){
                    Log.d(TAG, "zsr onCreate: "+book.toString())
                }
            }
        }

点击插入,并查询:
在这里插入图片描述

2.2 、新增字段

但不是每次升级都升级一张表,假如要加赠一个字段呢?比如新增 Book 的作者名,author,修改 Book 类:

@Entity
data class Book(var name:String,var pages:Int,var author:String) {
    @PrimaryKey(autoGenerate = true)
    var id:Long = 0;
}

由于 Book 变动了,所以,AppDatabase 也需要改变:

@Database(version = 3, entities = [UserData::class, Book::class])
abstract class AppDataBase : RoomDatabase() {
    abstract fun userDao(): UserDao
    abstract fun bookDao(): BookDao

    companion object {
	... 
    val Migration2_3 = object : Migration(2, 3) {
                override fun migrate(database: SupportSQLiteDatabase) {
                    database.execSQL("alter table Book add column author text not null default 'unknown'")
                }
            }
        private var instance: AppDataBase? = null;

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

        

            val db = Room.databaseBuilder(
                context.applicationContext,
                AppDataBase::class.java, "AppDataBase"
            ).addMigrations(Migration1_2,Migration2_3).build()
            return db.apply {
                instance = this;
            }
        }
    }
}

可以看到,版本改称3,且增加了一个 Migration2_3 ,SQL 语句使用 alert 插入一个列。

这样,我们就学习完成了。

参考:
第一行代码,第三版
官网 ROOM

你可能感兴趣的:(Jetpack)