使用 Room 在本地数据库中保存数据   属于 Android Jetpack 的一部分。

处理大量结构化数据的应用可以从在本地持久化这些数据中获益匪浅。最常见的用例是缓存相关数据，以便当设备无法访问网络时，用户仍然可以在脱机状态下浏览这些内容。

Room 持久性库在 SQLite 之上提供了一个抽象层，允许流畅地访问数据库，同时利用 SQLite 的全部功能。特别是，Room 提供以下优点

• SQL 查询的编译时验证。
• 方便的注释，最大程度地减少重复且容易出错的样板代码。
• 简化的数据库迁移路径。

由于这些原因，我们强烈建议您使用 Room，而不是 直接使用 SQLite API。

设置

要在您的应用中使用 Room，请将以下依赖项添加到您的应用的 build.gradle 文件中

dependencies {
    def room_version = "2.6.1"

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

    // To use Kotlin annotation processing tool (kapt)
    kapt "androidx.room:room-compiler:$room_version"
    // To use Kotlin Symbol Processing (KSP)
    ksp "androidx.room:room-compiler:$room_version"

    // optional - RxJava2 support for Room
    implementation "androidx.room:room-rxjava2:$room_version"

    // optional - RxJava3 support for Room
    implementation "androidx.room:room-rxjava3:$room_version"

    // optional - Guava support for Room, including Optional and ListenableFuture
    implementation "androidx.room:room-guava:$room_version"

    // optional - Test helpers
    testImplementation "androidx.room:room-testing:$room_version"

    // optional - Paging 3 Integration
    implementation "androidx.room:room-paging:$room_version"
}

dependencies {
    val room_version = "2.6.1"

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

    // To use Kotlin annotation processing tool (kapt)
    kapt("androidx.room:room-compiler:$room_version")
    // To use Kotlin Symbol Processing (KSP)
    ksp("androidx.room:room-compiler:$room_version")

    // optional - Kotlin Extensions and Coroutines support for Room
    implementation("androidx.room:room-ktx:$room_version")

    // optional - RxJava2 support for Room
    implementation("androidx.room:room-rxjava2:$room_version")

    // optional - RxJava3 support for Room
    implementation("androidx.room:room-rxjava3:$room_version")

    // optional - Guava support for Room, including Optional and ListenableFuture
    implementation("androidx.room:room-guava:$room_version")

    // optional - Test helpers
    testImplementation("androidx.room:room-testing:$room_version")

    // optional - Paging 3 Integration
    implementation("androidx.room:room-paging:$room_version")
}

主要组件

Room 中有三个主要组件

• 用于保存数据库并用作您的应用持久化数据的底层连接的主要访问点的 数据库类。
• 代表应用数据库中表的 数据实体。
• 提供您的应用可以使用的方法来查询、更新、插入和删除数据库中的数据的 数据访问对象 (DAO)。

数据库类为您的应用提供了与该数据库关联的 DAO 的实例。然后，应用可以使用 DAO 来检索数据库中作为关联数据实体对象的实例的数据。应用还可以使用定义的数据实体来更新相应表中的行，或创建要插入的新行。图 1 说明了 Room 的不同组件之间的关系。

示例实现

本节介绍具有单个数据实体和单个 DAO 的 Room 数据库的示例实现。

数据实体

以下代码定义了 User 数据实体。每个 User 实例代表应用数据库中 user 表中的一行。

@Entity
data class User(
    @PrimaryKey val uid: Int,
    @ColumnInfo(name = "first_name") val firstName: String?,
    @ColumnInfo(name = "last_name") val lastName: String?
)

@Entity
public class User {
    @PrimaryKey
    public int uid;

    @ColumnInfo(name = "first_name")
    public String firstName;

    @ColumnInfo(name = "last_name")
    public String lastName;
}

要详细了解 Room 中的数据实体，请参见 使用 Room 实体定义数据.

数据访问对象 (DAO)

以下代码定义了一个名为 UserDao 的 DAO。 UserDao 提供了应用程序其余部分用于与 user 表中的数据进行交互的方法。

@Dao
interface UserDao {
    @Query("SELECT * FROM user")
    fun getAll(): List<User>

    @Query("SELECT * FROM user WHERE uid IN (:userIds)")
    fun loadAllByIds(userIds: IntArray): List<User>

    @Query("SELECT * FROM user WHERE first_name LIKE :first AND " +
           "last_name LIKE :last LIMIT 1")
    fun findByName(first: String, last: String): User

    @Insert
    fun insertAll(vararg users: User)

    @Delete
    fun delete(user: User)
}

@Dao
public interface UserDao {
    @Query("SELECT * FROM user")
    List<User> getAll();

    @Query("SELECT * FROM user WHERE uid IN (:userIds)")
    List<User> loadAllByIds(int[] userIds);

    @Query("SELECT * FROM user WHERE first_name LIKE :first AND " +
           "last_name LIKE :last LIMIT 1")
    User findByName(String first, String last);

    @Insert
    void insertAll(User... users);

    @Delete
    void delete(User user);
}

要详细了解 DAO，请参见 使用 Room DAO 访问数据.

数据库

以下代码定义了一个 AppDatabase 类来保存数据库。 AppDatabase 定义数据库配置，并充当应用程序对持久化数据的访问主入口。数据库类必须满足以下条件

• 该类必须使用 @Database 注解进行注解，该注解包含一个 entities 数组，该数组列出了与数据库关联的所有数据实体。
• 该类必须是一个扩展了 RoomDatabase 的抽象类。
• 对于与数据库关联的每个 DAO 类，数据库类必须定义一个零参数的抽象方法，并返回 DAO 类的实例。

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

@Database(entities = {User.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase {
    public abstract UserDao userDao();
}

用法

定义完数据实体、DAO 和数据库对象后，可以使用以下代码创建数据库实例

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

AppDatabase db = Room.databaseBuilder(getApplicationContext(),
        AppDatabase.class, "database-name").build();

然后，您可以使用 AppDatabase 中的抽象方法获取 DAO 的实例。反过来，您可以使用 DAO 实例中的方法与数据库进行交互。

val userDao = db.userDao()
val users: List<User> = userDao.getAll()

UserDao userDao = db.userDao();
List<User> users = userDao.getAll();

其他资源

要详细了解 Room，请参阅以下其他资源

示例

Codelabs

• 带有视图的 Android Room (Java) (Kotlin)

博客

• Room 的 7 个专业技巧
• 从 SQLite 逐步迁移到 Room