Android Room数据库使用介绍

1.简介

---

Room是Google提供的Android架构组件之一，旨在简化数据库操作。它是SQLite的一个抽象层，提供了更易用和安全的API。

Room的总体架构:

2.Room数据库的基础概念

---

Entity

Entity是Room中的数据表，每个Entity类对应一个SQLite表。

DAO (Data Access Object)

DAO是用于访问数据库的方法接口，定义了与数据库交互的操作。

Database

Database是Room数据库的抽象类，持有数据库并作为数据访问的主要入口点。

3.Room数据库的配置

---

添加依赖

在build.gradle文件中添加Room的依赖项。

1. dependencies {
2. implementation "androidx.room:room-runtime:2.5.0"
3. annotationProcessor "androidx.room:room-compiler:2.5.0"
4. // 可选 - 支持Lifecycle的LiveData
5. implementation "androidx.room:room-ktx:2.5.0"
6. }

复制代码

定义Entity

1. // tableName 指定了数据库中对应的表名为 "users"。如果不指定，默认使用类名作为表名
2. @Entity(tableName = "users")
3. data class User(
4. // 使用默认值 0，autoGenerate = true 表示自动生成主键
5. @PrimaryKey(autoGenerate = true)
6. val id: Int = 0,
7. // 如果不使用 @ColumnInfo 注解，默认情况下 Room 将使用属性名作为数据库中的列名
8. @ColumnInfo(name = "first_name")
9. val firstName: String,
10. @ColumnInfo(name = "last_name")
11. val lastName: String
12. )

复制代码

创建DAO

1. @Dao
2. interface UserDao {
3. @Insert
4. fun insert(user: User)
5. //@Insert(onConflict = OnConflictStrategy.REPLACE)：用于定义插入操作，并指定了替换策略为 OnConflictStrategy.REPLACE。这意味着如果插入的数据在数据库中已存在（根据主键判断），则旧数据会被新数据替换。
6. @Insert(onConflict = OnConflictStrategy.REPLACE)
7. fun insert(user: User)
9. @Query("SELECT * FROM users WHERE id = :id")
10. fun getUserById(id: Int): User?
12. @Update
13. fun update(user: User)
15. @Delete
16. fun delete(user: User)
17. }

复制代码

tips: OnConflictStrategy.REPLACE：如果插入的数据在数据库中已存在（即主键冲突），则会替换原有的数据。

创建Database

1. @Database(entities = [User::class], version = 1, exportSchema = false)
2. abstract class UserRoomDatabase : RoomDatabase() {
4. abstract fun userDao(): UserDao
6. companion object {
7. @Volatile
8. private var INSTANCE: ItemRoomDatabase? = null
10. fun getDatabase(context: Context): UserRoomDatabase {
11. return INSTANCE ?: synchronized(this) {
12. val instance = Room.databaseBuilder(
13. context.applicationContext,
14. UserRoomDatabase::class.java,
15. "user_database"
16. )
17. .fallbackToDestructiveMigration()
18. .build()
19. INSTANCE = instance
20. instance
21. }
22. }
23. }
24. }

复制代码

tips:注意fallbackToDestructiveMigration() 一般在调试中使用，如果你修改了数据库表结构，而没有升级数据库通常程序再次运行会报错，使用fallbackToDestructiveMigration() 表示将老的数据库表结构和数据全部删除，使用新的结构，允许破坏性迁移，即销毁旧数据库并创建新数据库。

初始化数据库

1. val db: UserRoomDatabase by lazy { UserRoomDatabase.getDatabase(this) }

复制代码

4.Room数据库的使用

---

插入数据

1. val user = User().apply {
2. firstName = "John"
3. lastName = "Doe"
4. }
5. db.userDao().insert(user)

复制代码

查询数据

1. val user = db.userDao().getUserById(1)

复制代码

更新数据

1. user.lastName = "Smith"
2. db.userDao().update(user)

复制代码

删除数据

1. db.userDao().delete(user)

复制代码

5.Room数据库的高级特性

---

使用LiveData和Flow

1. @Query("SELECT * FROM users")
2. LiveData<List<User>> getAllUsers();
4. @Query("SELECT * FROM users")
5. Flow<List<User>> getAllUsersFlow();

复制代码

数据库迁移

1. @Database(entities = [User::class], version = 2, exportSchema = false)
2. abstract class UserRoomDatabase : RoomDatabase() {
4. abstract fun userDao(): UserDao
6. companion object {
7. @Volatile
8. private var INSTANCE: ItemRoomDatabase? = null
9. //迁移代码 用于从版本 1 迁移到版本 2。
10. val MIGRATION_1_2: Migration = object : Migration(1, 2) {
11. override fun migrate(database: SupportSQLiteDatabase) {
12. //为users表增加age属性
13. database.execSQL("ALTER TABLE users ADD COLUMN age INTEGER")
14. }
15. }
17. fun getDatabase(context: Context): UserRoomDatabase {
18. return INSTANCE ?: synchronized(this) {
19. val instance = Room.databaseBuilder(
20. context.applicationContext,
21. UserRoomDatabase::class.java,
22. "user_database"
23. )
24. .addMigrations(AppDatabase.MIGRATION_1_2) //在此处添加
25. .build()
26. INSTANCE = instance
27. instance
28. }
29. }
30. }
31. }

复制代码

使用TypeConverters

1. @Database(entities = [User::class], version = 1)
2. @TypeConverters(Converters::class)
3. abstract class UserRoomDatabase: RoomDatabase() {
4. abstract fun userDao(): UserDao
5. ...
6. }
8. object Converters {
9. @TypeConverter
10. @JvmStatic
11. fun fromTimestamp(value: Long?): Date? {
12. return value?.let { Date(it) }
13. }
15. @TypeConverter
16. @JvmStatic
17. fun dateToTimestamp(date: Date?): Long? {
18. return date?.time
19. }
20. }

复制代码

User 中增加 Date类型 createdAt属性

1. @Entity(tableName = "users")
2. data class User(
3. @PrimaryKey(autoGenerate = true)
4. val id: Long = 0,
5. val name: String,
6. val createdAt: Date
7. )

复制代码

说明：

• 类型转换器 (Converters)：使用 Room 持久化库时，有时需要在数据库存储和应用程序中的对象之间进行转换。例如，将 Date 对象存储为 Long 类型的时间戳或从时间戳恢复为 Date 对象，其他对象类型同理。
• @TypeConverter 注解：用于标记类型转换器的方法，告诉 Room 如何在持久化过程中执行对象到数据库兼容格式之间的转换。
• @Database 和 @TypeConverters 注解：用于在 UserRoomDatabase中指定数据库的配置，包括数据库版本号和要使用的类型转换器。

示例：

1. class Converters {
3. //enum 类型
4. @TypeConverter
5. fun toDownloadStatus(value: String): DownloadStatus = enumValueOf(value)
7. @TypeConverter
8. fun fromDownloadStatus(status: DownloadStatus): String = status.name
11. @TypeConverter
12. fun fromHashMap(value: HashMap<Int, Int>): String {
13. val gson = Gson()
14. return gson.toJson(value)
15. }
17. @TypeConverter
18. fun toHashMap(value: String): HashMap<Int, Int> {
19. val gson = Gson()
20. val type = object : TypeToken<HashMap<Int, Int>>() {}.type
21. return gson.fromJson(value, type)
22. }
24. //自定义对象
25. @TypeConverter
26. fun fromDownloadException(downloadException: DownloadException?): String? {
27. if (downloadException == null) {
28. return null
29. }
30. return Gson().toJson(downloadException)
31. }
33. @TypeConverter
34. fun toDownloadException(value: String?): DownloadException? {
35. if (value == null) {
36. return null
37. }
38. val type = object : TypeToken<DownloadException>() {}.type
39. return Gson().fromJson(value, type)
40. }
41. }

复制代码

6. Room数据库的实践

---

线程管理

确保数据库操作在后台线程中完成，在主线程中操作数据库会报错。

1. Executors.newSingleThreadExecutor().execute {
2. db.userDao().insert(user)
3. }

复制代码

数据库性能优化

• 使用批量插入和更新。
• 使用索引提高查询性能。

处理大型数据集

使用分页库（Paging Library）处理大型数据集。

1. @Query("SELECT * FROM users ORDER BY id ASC")
2. fun getAllUsers(): PagingSource<Int, User>

复制代码

使用分页库需要增加依赖

1. implementation "androidx.paging:paging-runtime-ktx:$paging_version"

复制代码

…
后面单独写篇文章介绍分页库使用，敬请期待…