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

2024-06-07 20:08
文章标签 数据库 初探 jetpack room

本文主要是介绍初探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<UserData>@Updatefun 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@Insertfun insertAll(vararg users: UserData)@Deletefun 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() : UserDaocompanion object{private var instance : AppDataBase ? = null;@Synchronizedfun 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 个按钮：

    <Buttonandroid:id="@+id/addDataBtn"android:layout_width="match_parent"android:layout_height="wrap_content"android:text="Add data"/><Buttonandroid:id="@+id/updateBtn"android:layout_width="match_parent"android:layout_height="wrap_content"android:text="Update data"/><Buttonandroid:id="@+id/deleteBtn"android:layout_width="match_parent"android:layout_height="wrap_content"android:text="delete data"/><Buttonandroid:id="@+id/queryBtn"android:layout_width="match_parent"android:layout_height="wrap_content"android:text="query data"/>

在这里插入图片描述
在 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  {@Insertfun insertBook(book: Book)@Query("select * from Book")fun loadAllBooks() : List<Book>
}

然后修改 AppDataBase：

@Database(version = 2, entities = [UserData::class, Book::class])
abstract class AppDataBase : RoomDatabase() {abstract fun userDao(): UserDaoabstract fun bookDao(): BookDaocompanion 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;@Synchronizedfun 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(): UserDaoabstract fun bookDao(): BookDaocompanion 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;@Synchronizedfun 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(四) -- ROOM 数据库的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1040170。

相关文章

Druid连接池实现自定义数据库密码加解密功能

Druid连接池实现自定义数据库密码加解密功能

《Druid连接池实现自定义数据库密码加解密功能》在现代应用开发中,数据安全是至关重要的,本文将介绍如何在​​Druid​​连接池中实现自定义的数据库密码加解密功能,有需要的小伙伴可以参考一下... 目录1. 环境准备2. 密码加密算法的选择3. 自定义 ​​DruidDataSource​​ 的密码解密3
阅读更多...
Maven项目中集成数据库文档生成工具的操作步骤

Maven项目中集成数据库文档生成工具的操作步骤

《Maven项目中集成数据库文档生成工具的操作步骤》在Maven项目中,可以通过集成数据库文档生成工具来自动生成数据库文档,本文为大家整理了使用screw-maven-plugin（推荐）的完... 目录1. 添加插件配置到 pom.XML2. 配置数据库信息3. 执行生成命令4. 高级配置选项5. 注意事
阅读更多...
在Java中基于Geotools对PostGIS数据库的空间查询实践教程

在Java中基于Geotools对PostGIS数据库的空间查询实践教程

《在Java中基于Geotools对PostGIS数据库的空间查询实践教程》本文将深入探讨这一实践,从连接配置到复杂空间查询操作,包括点查询、区域范围查询以及空间关系判断等,全方位展示如何在Java环... 目录前言一、相关技术背景介绍1、评价对象AOI2、数据处理流程二、对AOI空间范围查询实践1、空间查
阅读更多...
Python+PyQt5实现MySQL数据库备份神器

Python+PyQt5实现MySQL数据库备份神器

《Python+PyQt5实现MySQL数据库备份神器》在数据库管理工作中,定期备份是确保数据安全的重要措施,本文将介绍如何使用Python+PyQt5开发一个高颜值,多功能的MySQL数据库备份工具... 目录概述功能特性核心功能矩阵特色功能界面展示主界面设计动态效果演示使用教程环境准备操作流程代码深度解
阅读更多...
MySQL数据库实现批量表分区完整示例

MySQL数据库实现批量表分区完整示例

《MySQL数据库实现批量表分区完整示例》通俗地讲表分区是将一大表,根据条件分割成若干个小表,：本文主要介绍MySQL数据库实现批量表分区的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考... 目录一、表分区条件二、常规表和分区表的区别三、表分区的创建四、将既有表转换分区表脚本五、批量转换表为分区
阅读更多...
MySQL Workbench工具导出导入数据库方式

MySQL Workbench工具导出导入数据库方式

《MySQLWorkbench工具导出导入数据库方式》：本文主要介绍MySQLWorkbench工具导出导入数据库方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝... 目录mysql Workbench工具导出导入数据库第一步 www.chinasem.cn数据库导出第二步
阅读更多...
Mysql数据库中数据的操作CRUD详解

Mysql数据库中数据的操作CRUD详解

《Mysql数据库中数据的操作CRUD详解》：本文主要介绍Mysql数据库中数据的操作（CRUD）,详细描述对Mysql数据库中数据的操作（CRUD）,包括插入、修改、删除数据,还有查询数据,包括... 目录一、插入数据（insert）1.插入数据的语法2.注意事项二、修改数据（update）1.语法2.有
阅读更多...
查看MySQL数据库版本的四种方法

查看MySQL数据库版本的四种方法

《查看MySQL数据库版本的四种方法》查看MySQL数据库的版本信息可以通过多种方法实现,包括使用命令行工具、SQL查询语句和图形化管理工具等,以下是详细的步骤和示例代码,需要的朋友可以参考下... 目录方法一：使用命令行工具1. 使用 mysql 命令示例：方法二：使用 mysqladmin 命令示例：方
阅读更多...
MySQL数据库约束深入详解

MySQL数据库约束深入详解

《MySQL数据库约束深入详解》：本文主要介绍MySQL数据库约束,在MySQL数据库中,约束是用来限制进入表中的数据类型的一种技术,通过使用约束,可以确保数据的准确性、完整性和可靠性,需要的朋友... 目录一、数据库约束的概念二、约束类型三、NOT NULL 非空约束四、DEFAULT 默认值约束五、UN
阅读更多...
数据库面试必备之MySQL中的乐观锁与悲观锁

数据库面试必备之MySQL中的乐观锁与悲观锁

《数据库面试必备之MySQL中的乐观锁与悲观锁》：本文主要介绍数据库面试必备之MySQL中乐观锁与悲观锁的相关资料,乐观锁适用于读多写少的场景,通过版本号检查避免冲突,而悲观锁适用于写多读少且对数... 目录一、引言二、乐观锁（一）原理（二）应用场景（三）示例代码三、悲观锁（一）原理（二）应用场景（三）示例
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2