原生移动开发 / 系统课时

DAO 与 Room Database

DAO 与 Room Database

Entity 只描述“数据长什么样”,真正的增删改查由 DAO 执行,而 RoomDatabase 负责把 Entity 与 DAO 组合成可打开的数据库。本节完成一套最小离线笔记存储,并用内存数据库测试验证插入与查询链路。

学习目标

  • 能使用 @Dao、@Insert、@Update、@Delete 与 @Query 定义数据访问接口。
  • 能声明 RoomDatabase 并以线程安全的单例方式创建数据库实例。
  • 能用内存数据库测试验证 DAO 的读写结果。

把数据库操作收口到 DAO

DAO 是应用代码访问 Room 的边界。写操作可以直接使用 Room 提供的注解,查询则使用 @Query 编写 SQL。把 SQL 集中在 DAO 中,可以避免 UI 或业务层直接操作 SQLite。

下面的片段示例依赖 Room,并假设工程已经启用 Kotlin 协程支持。

kotlin
package com.example.offline

import androidx.room.ColumnInfo
import androidx.room.Dao
import androidx.room.Delete
import androidx.room.Entity
import androidx.room.Insert
import androidx.room.PrimaryKey
import androidx.room.Query
import androidx.room.Update

@Entity(tableName = "notes")
data class NoteEntity(
    @PrimaryKey(autoGenerate = true)
    val id: Long = 0,
    val title: String,
    val body: String,
    @ColumnInfo(name = "created_at")
    val createdAt: Long
)

@Dao
interface NoteDao {
    @Insert
    suspend fun insert(note: NoteEntity): Long

    @Query("SELECT * FROM notes WHERE id = :id LIMIT 1")
    suspend fun findById(id: Long): NoteEntity?

    @Update
    suspend fun update(note: NoteEntity): Int

    @Delete
    suspend fun delete(note: NoteEntity): Int
}

insert 返回新行的主键,update 和 delete 返回受影响行数,findById 在没有结果时返回 null。这些返回值比“调用后不检查”更适合做错误判断和测试断言。

用 RoomDatabase 统一创建数据库

RoomDatabase 声明数据库包含哪些 Entity,并暴露对应 DAO。真实应用通常只保留一个数据库实例,避免同时打开多个连接池和重复初始化。

DAO、RoomDatabase 与 SQLite 的调用关系

kotlin
package com.example.offline

import android.content.Context
import androidx.room.Database
import androidx.room.Room
import androidx.room.RoomDatabase

@Database(
    entities = [NoteEntity::class],
    version = 1,
    exportSchema = true
)
abstract class AppDatabase : RoomDatabase() {
    abstract fun noteDao(): NoteDao

    companion object {
        @Volatile
        private var instance: AppDatabase? = null

        fun getInstance(context: Context): AppDatabase {
            return instance ?: synchronized(this) {
                instance ?: Room.databaseBuilder(
                    context.applicationContext,
                    AppDatabase::class.java,
                    "app.db"
                ).build().also { instance = it }
            }
        }
    }
}

这里使用 applicationContext,避免数据库单例间接持有 Activity。@Volatile 与 synchronized 组合用于保证多线程首次初始化时只创建一个实例。Room 默认禁止主线程数据库访问,DAO 使用 suspend 后应从协程中调用,不要通过 allowMainThreadQueries() 绕过生产环境限制。

用内存数据库验证读写链路

内存数据库很适合 DAO 测试:测试结束后数据即消失,不会污染真实 app.db。下面是片段示例,依赖 AndroidX Test、JUnit、协程测试运行环境以及前面的 NoteEntity、NoteDao、AppDatabase。

kotlin
package com.example.offline

import androidx.room.Room
import androidx.test.core.app.ApplicationProvider
import androidx.test.ext.junit.runners.AndroidJUnit4
import kotlinx.coroutines.runBlocking
import org.junit.After
import org.junit.Assert.assertEquals
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith

@RunWith(AndroidJUnit4::class)
class AppDatabaseTest {
    private lateinit var db: AppDatabase

    @Before
    fun setUp() {
        db = Room.inMemoryDatabaseBuilder(
            ApplicationProvider.getApplicationContext(),
            AppDatabase::class.java
        ).build()
    }

    @After
    fun tearDown() {
        db.close()
    }

    @Test
    fun insertThenQuery_returnsSavedNote() = runBlocking {
        val id = db.noteDao().insert(
            NoteEntity(
                title = "offline",
                body = "cached",
                createdAt = 1_700_000_000_000
            )
        )

        val saved = db.noteDao().findById(id)
        assertEquals("offline", saved?.title)
    }
}

在已启动模拟器或连接测试设备后执行:

bash
./gradlew connectedDebugAndroidTest

预期输出(精简):

text
BUILD SUCCESSFUL in <TIME>

实际任务日志和耗时会随 Gradle、Android Gradle Plugin 与设备而变化。这个测试通过说明“创建数据库 → 获取 DAO → 插入 Entity → 按主键查询”的主链路可工作;上线前还应为版本升级补迁移测试,而不是依赖破坏性重建数据库。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

DAO 与 Room Database

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通