avatar🐀
霂枯木霂枯木的小站

To witness the sunrise and the sea of blossoms.

行可兼知,而知不可兼行

Room框架的基本使用

依赖安装 ​

  1. 使用ksp(或kapt)读取注解
  2. room-runtime核心库
  3. room-ktx协程等kotlin扩展支持
  4. room-compiler编译时生成数据库实现代码
plugins {
    id("com.google.devtools.ksp")
}
dependencies {
    implementation("androidx.room:room-runtime:2.8.5")
    implementation("androidx.room:room-ktx:2.8.5")
    ksp("androidx.room:room-compiler:2.8.5")
}

Entity ​

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

Dao ​

@Dao
interface UserDao {
    @Insert
    suspend fun insert(user: User): Long
    @Query("SELECT * FROM user")
    suspend fun getAll(): List<User> //也可返回flow
    @Query("SELECT * FROM user WHERE id = :id")
    suspend fun getById(id: Int): User?
    @Update
    suspend fun update(user: User)
    @Delete
    suspend fun delete(user: User)
    @Query("DELETE FROM user WHERE id = :id")
    suspend fun deleteById(id: Int)
}

Database ​

使用hilt时,把getDatabase提取出来

@Database(
    entities = [User::class],
    version = 1,
    exportSchema = false
)
abstract class AppDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao
    companion object {
        @Volatile
        private var INSTANCE: AppDatabase? = null
        fun getDatabase(context: Context): AppDatabase {
            return INSTANCE ?: synchronized(this) {
                INSTANCE ?: Room.databaseBuilder(
                    context.applicationContext,
                    AppDatabase::class.java,
                    "student_database"
                ).build().also {
                    INSTANCE = it
                }
            }
        }
    }
}

使用 ​

userDao.getAll()
Hilt依赖注入
协程
由 Valaxy v1.2.0 驱动|主题-Yunv1.2.0