Android架构组件Room指南

下面就为大家详细讲解“Android架构组件Room指南”的完整攻略。

什么是Room

Room是Google推出的一个轻量级的ORM（Object-Relational Mapping）框架，是Android架构组件之一，用于替代Android存储数据库的SQLite语句。

Room提供了一个对象映射层，让您可以使用Java方法调用来访问您的数据库。它旨在提供更容易的使用方式，同时也是类型安全的。 它的优点包括：自动映射、编译时错误检查、简化查询等。

如何使用Room

使用Room需要添加以下依赖：

implementation "androidx.room:room-runtime:$room_version"
annotationProcessor "androidx.room:room-compiler:$room_version"

其中，room_version是您所使用的Room版本的版本号。

定义数据实体

数据实体是Room中的一个重要概念。它是用于描述实际数据模型的简单Java类，它映射到数据库表中的列。定义数据实体的步骤如下：

@Entity(tableName = "user")
data class UserEntity(
    @PrimaryKey(autoGenerate = true) val id: Int,
    val name: String,
    val age: Int
)

• @Entity：用于将实体类映射到数据库中的表格；
• tableName：设置表格的名称；
• 主键使用@PrimaryKey注解标识；
• autoGenerate: 是否自动生成主键。

定义数据访问对象（DAO）

数据访问对象（DAO）是一个接口，用于访问数据库中的数据。它提供了一些方法来执行各种数据库操作。它不是具体的类，这使得它非常适合使用单元测试。

@Dao
interface UserDao {
    @Insert(onConflict = OnConflictStrategy.REPLACE)
    suspend fun insertUser(user: UserEntity)

    @Query("SELECT * FROM user")
    fun getUsers(): List<UserEntity>

    @Query("SELECT * FROM user WHERE name = :name")
    fun getUserByName(name: String): UserEntity?
}

• @Dao：用于标记DAO接口类；
• @Insert：用于插入实体类对象，OnConflictStrategy.REPLACE表示如果有数据重复时则替换；
• @Query：用于自定义查询语句，在语句中可以使用变量，如:name。

定义Room数据库

定义Room数据库的步骤如下：

@Database(entities = [UserEntity::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao
}

• @Database：用于标记数据库中数据实体的集合，以及它们与数据库版本的关系；
• entities：用于定义实体类，值为这些实体类的数组；
• version：用于定义数据库的版本号；
• abstract关键字用于定义数据库关联Dao。

初始化AppDatabase

要初始化AppDatabase，可以使用如下代码：

val db = Room.databaseBuilder(
    context.applicationContext,
    AppDatabase::class.java, "database-name"
).build()

以上代码将创建一个新的AppDatabase实例，数据库名称为“database-name”。

示例1：插入数据

创建User对象并插入用户：

val userEntity = UserEntity(1, "张三", 25)
db.userDao().insertUser(userEntity)

示例2：查询数据

从数据库中获取User实例：

val userList = db.userDao().getUsers()

总结

以上就是关于如何使用Room的教程。如果您对Room有更深入的了解，您可以充分使用它来简化数据库操作。