初探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。

相关文章

Oracle数据库定时备份脚本方式(Linux)

Oracle数据库定时备份脚本方式(Linux)

《Oracle数据库定时备份脚本方式(Linux)》文章介绍Oracle数据库自动备份方案,包含主机备份传输与备机解压导入流程,强调需提前全量删除原库数据避免报错,并需配置无密传输、定时任务及验证脚本... 目录说明主机脚本备机上自动导库脚本整个自动备份oracle数据库的过程（建议全程用root用户）总结
阅读更多...
虚拟机Centos7安装MySQL数据库实践

虚拟机Centos7安装MySQL数据库实践

《虚拟机Centos7安装MySQL数据库实践》用户分享在虚拟机安装MySQL的全过程及常见问题解决方案,包括处理GPG密钥、修改密码策略、配置远程访问权限及防火墙设置,最终通过关闭防火墙和停止Net... 目录安装mysql数据库下载wget命令下载MySQL安装包安装MySQL安装MySQL服务安装完成
阅读更多...
MySQL进行数据库审计的详细步骤和示例代码

MySQL进行数据库审计的详细步骤和示例代码

《MySQL进行数据库审计的详细步骤和示例代码》数据库审计通过触发器、内置功能及第三方工具记录和监控数据库活动,确保安全、完整与合规,Java代码实现自动化日志记录,整合分析系统提升监控效率,本文给大... 目录一、数据库审计的基本概念二、使用触发器进行数据库审计1. 创建审计表2. 创建触发器三、Java
阅读更多...
SQL server数据库如何下载和安装

SQL server数据库如何下载和安装

《SQLserver数据库如何下载和安装》本文指导如何下载安装SQLServer2022评估版及SSMS工具,涵盖安装配置、连接字符串设置、C#连接数据库方法和安全注意事项,如混合验证、参数化查... 目录第一步：打开官网下载对应文件第二步：程序安装配置第三部：安装工具SQL Server Manageme
阅读更多...
C#连接SQL server数据库命令的基本步骤

C#连接SQL server数据库命令的基本步骤

《C#连接SQLserver数据库命令的基本步骤》文章讲解了连接SQLServer数据库的步骤,包括引入命名空间、构建连接字符串、使用SqlConnection和SqlCommand执行SQL操作,... 目录建议配合使用：如何下载和安装SQL server数据库-CSDN博客1. 引入必要的命名空间2.
阅读更多...
Java通过驱动包(jar包)连接MySQL数据库的步骤总结及验证方式

Java通过驱动包(jar包)连接MySQL数据库的步骤总结及验证方式

《Java通过驱动包(jar包)连接MySQL数据库的步骤总结及验证方式》本文详细介绍如何使用Java通过JDBC连接MySQL数据库,包括下载驱动、配置Eclipse环境、检测数据库连接等关键步骤,... 目录一、下载驱动包二、放jar包三、检测数据库连接JavaJava 如何使用 JDBC 连接 mys
阅读更多...
MySQL数据库中ENUM的用法是什么详解

MySQL数据库中ENUM的用法是什么详解

《MySQL数据库中ENUM的用法是什么详解》ENUM是一个字符串对象,用于指定一组预定义的值,并可在创建表时使用,下面：本文主要介绍MySQL数据库中ENUM的用法是什么的相关资料,文中通过代码... 目录mysql 中 ENUM 的用法一、ENUM 的定义与语法二、ENUM 的特点三、ENUM 的用法1
阅读更多...
Java中调用数据库存储过程的示例代码

Java中调用数据库存储过程的示例代码

《Java中调用数据库存储过程的示例代码》本文介绍Java通过JDBC调用数据库存储过程的方法,涵盖参数类型、执行步骤及数据库差异,需注意异常处理与资源管理,以优化性能并实现复杂业务逻辑,感兴趣的朋友... 目录一、存储过程概述二、Java调用存储过程的基本javascript步骤三、Java调用存储过程示
阅读更多...
Go语言数据库编程GORM 的基本使用详解

Go语言数据库编程GORM 的基本使用详解

《Go语言数据库编程GORM的基本使用详解》GORM是Go语言流行的ORM框架,封装database/sql,支持自动迁移、关联、事务等,提供CRUD、条件查询、钩子函数、日志等功能,简化数据库操作... 目录一、安装与初始化1. 安装 GORM 及数据库驱动2. 建立数据库连接二、定义模型结构体三、自动迁
阅读更多...
嵌入式数据库SQLite 3配置使用讲解

嵌入式数据库SQLite 3配置使用讲解

《嵌入式数据库SQLite3配置使用讲解》本文强调嵌入式项目中SQLite3数据库的重要性,因其零配置、轻量级、跨平台及事务处理特性,可保障数据溯源与责任明确,详细讲解安装配置、基础语法及SQLit... 目录0、惨痛教训1、SQLite3环境配置（1）、下载安装SQLite库（2）、解压下载的文件（3）、
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2