### 前言： > 🏀在我们日常开发中，经常要和数据打交道，所以存储数据是很重要的事。Android从最开始使用SQLite作为数据库存储数据，再到许多的开源的数据库，例如QRMLite，DBFlow，郭霖大佬开发的Litepal等等，都是为了方便SQLite的使用而出现的，因为SQLite的使用繁琐且容易出错。Google当然也意识到了SQLite的一些问题，于是在Jetpack组件中推出了Room，本质上Room也是在SQLite上提供了一层封装。因为它官方组件的身份，和良好的开发体验，现在逐渐成为了最主流的数据库ORM框架。 🌟Room官方文档： 🌟SQL语法教程： 🚀本文代码地址： ### 为什么要使用Room？Room具有什么优势？ Room在SQLite上提供了一个抽象层，以便在充分利用SQLite的强大功能的同时，能够享有更强健的数据库访问机制。 **Room的具体优势：** - 有可以最大限度减少重复和容易出错的样板代码的注解 - 简化了数据库迁移路径 - 针对编译期`SQL`的语法检查 - API设计友好，更容易上手，理解 - 与`SQL`语句的使用更加贴近，能够降低学习成本 - 对`RxJava`、 `LiveData` 、 `Kotlin`协程等都支持 ### Room具有三个主要模块 - **Entity:** `Entity`用来表示数据库中的一个表。需要使用`@Entity(tableName = "XXX")`注解，其中的参数为表名。 - **Dao:** 数据库访问对象，用于访问和管理数据（增删改查）。在使用时需要`@DAO`注解 - **Database:** 它作为数据库持有者，用`@Database`注解和`Room Database`扩展的类 ### 如何使用Room呢？ ##### ①添加依赖 | 最近更新时间（文章发布时的最新版本） | 稳定版 | Alpha 版 | | ------------------ | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | 2022 年 6 月 1 日 | [2.4.2](https://developer.android.google.cn/jetpack/androidx/releases/room#2.4.2) | [2.5.0-alpha02](https://developer.android.google.cn/jetpack/androidx/releases/room#2.5.0-alpha02) | ```groovy plugins { ... id 'kotlin-kapt' } def room_version = "2.4.2" implementation "androidx.room:room-runtime:$room_version" annotationProcessor "androidx.room:room-compiler:$room_version" kapt 'androidx.room:room-compiler:$room_version' ``` ##### ②创建`Entity`实体类，用来表示数据库中的一张表（table） ```kotlin @Entity(tableName = "user") data class UserEntity( //主键定义需要用到@PrimaryKey(autoGenerate = true)注解，autoGenerate参数决定是否自增长 @PrimaryKey(autoGenerate = true) val id:Int = 0, //默认值为0 @ColumnInfo(name = "name", typeAffinity = ColumnInfo.TEXT) val name:String?, @ColumnInfo(name = "age", typeAffinity = ColumnInfo.INTEGER) val age:Int? ) ``` 其中，每个表的字段都要加上`@ColumnInfo(name = "xxx", typeAffinity = ColumnInfo.xxx)`，`name`属性表示这张表中的字段名，`typeAffinity`表示改字段的数据类型。 **其他常用注解：** - **@Ignore** :`Entity`中的所有属性都会被持久化到数据库，除非使用`@Ignore` ```kotlin @Ignore val name: String? ``` - **@ForeignKey**:外键约束，不同于目前存在的大多数ORM库，Room不支持Entitiy对象间的直接引用。Google也做出了解释，具体原因请查看：，不过`Room`允许通过外键来表示`Entity`之间的关系。`ForeignKey`我们文章后面再谈，先讲简单的使用。 - **@Embedded** :实体类中引用其他实体类，在某些情况下，对于一张表的数据，我们用多个`POJO`类来表示，所以在这种情况下，我们可以使用`Embedded`注解嵌套对象。 ##### ③创建数据访问对象（Dao）处理增删改查 ```kotlin @Dao interface UserDao { //添加用户 @Insert fun addUser(vararg userEntity: UserEntity) //删除用户 @Delete fun deleteUser(vararg userEntity: UserEntity) //更新用户 @Update fun updateUser(vararg userEntity: UserEntity) //查找用户 //返回user表中所有的数据 @Query("select * from user") fun queryUser(): List } ``` `Dao`负责提供访问`DB`的`API`，我们每一张表都需要一个`Dao`。在这里使用`@Dao`注解定义`Dao`类。 - `@Insert`, `@Delete`需要传一个`entity()`进去 - ```kotlin Class entity() default Object.class; ``` - `@Query`则是需要传递`SQL`语句 - ```kotlin public @interface Query { //要运行的SQL语句 String value(); } ``` > ☀注意：Room会在编译期基于Dao自动生成具体的实现类，UserDao_Impl（实现增删改查的方法）。 > > 🔥Dao所有的方法调研都在当前线程进行，需要避免在UI线程中直接访问！ ##### ④创建Room database ```kotlin @Database(entities = [UserEntity::class], version = 1) abstract class UserDatabase : RoomDatabase() { abstract fun userDao(): UserDao } ``` 通过`Room.databaseBuilder()`或者 `Room.inMemoryDatabaseBuilder()`获取`Database`实例 ```kotlin val db = Room.databaseBuilder( applicationContext, UserDatabase::class.java, "userDb" ).build() ``` > ☀注意：创建`Database`的成本较高，所以我们最好使用单例的`Database`，避免反复创建实例所带来的开销。 **单例模式创建Database：** ```kotlin @Database(entities = [UserEntity::class], version = 1) abstract class UserDatabase : RoomDatabase() { abstract fun getUserDao(): UserDao companion object { @Volatile private var INSTANCE: UserDatabase? = null @JvmStatic fun getInstance(context: Context): UserDatabase { val tmpInstance = INSTANCE if (tmpInstance != null) { return tmpInstance } //锁 synchronized(this) { val instance = Room.databaseBuilder(context, UserDatabase::class.java, "userDb").build() INSTANCE = instance return instance } } } } ``` ##### ⑤在Activity中使用，进行一些可视化操作 **activity_main:** ```xml