使用 Room 实体定义数据

当您使用 Room 持久性库 存储应用数据时，您需要定义实体来表示要存储的对象。每个实体对应于关联的 Room 数据库中的一个表，每个实体实例对应于该表中的一行数据。

这意味着您可以使用 Room 实体来定义您的 数据库模式，而无需编写任何 SQL 代码。

实体的结构

您将每个 Room 实体定义为一个用 @Entity 注解的类。Room 实体包含对应数据库表中每一列的字段，包括构成 主键 的一个或多个列。

以下代码是一个简单实体的示例，它定义了一个名为 User 的表，其中包含 ID、姓氏和名字列。

@Entity
data class User(
    @PrimaryKey val id: Int,

    val firstName: String?,
    val lastName: String?
)

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

    public String firstName;
    public String lastName;
}

默认情况下，Room 使用类名作为数据库表名。如果希望表具有不同的名称，请设置 tableName 属性，该属性是 @Entity 注解的一部分。类似地，Room 默认情况下使用字段名作为数据库中的列名。如果希望列具有不同的名称，请将 @ColumnInfo 注解添加到字段中，并设置 name 属性。以下示例演示了表及其列的自定义名称。

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

@Entity(tableName = "users")
public class User {
    @PrimaryKey
    public int id;

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

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

定义主键

每个 Room 实体必须定义一个 主键，用于唯一标识对应数据库表中的每一行。最直接的方法是在单个列上添加 @PrimaryKey 注解。

@PrimaryKey val id: Int

@PrimaryKey
public int id;

定义复合主键

如果需要通过多个列的组合来唯一标识实体实例，则可以通过在 primaryKeys 属性中列出这些列来定义复合主键。

@Entity(primaryKeys = ["firstName", "lastName"])
data class User(
    val firstName: String?,
    val lastName: String?
)

@Entity(primaryKeys = {"firstName", "lastName"})
public class User {
    public String firstName;
    public String lastName;
}

忽略字段

默认情况下，Room 会为实体中定义的每个字段创建一个列。如果实体包含您不想持久化的字段，可以使用 @Ignore 注解它们，如下面的代码片段所示。

@Entity
data class User(
    @PrimaryKey val id: Int,
    val firstName: String?,
    val lastName: String?,
    @Ignore val picture: Bitmap?
)

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

    public String firstName;
    public String lastName;

    @Ignore
    Bitmap picture;
}

如果实体从父实体继承字段，通常使用 ignoredColumns 属性更方便。

open class User {
    var picture: Bitmap? = null
}

@Entity(ignoredColumns = ["picture"])
data class RemoteUser(
    @PrimaryKey val id: Int,
    val hasVpn: Boolean
) : User()

@Entity(ignoredColumns = "picture")
public class RemoteUser extends User {
    @PrimaryKey
    public int id;

    public boolean hasVpn;
}

提供表格搜索支持

Room 支持多种类型的注解，可以帮助您更轻松地在数据库表格中搜索详细信息。请使用全文搜索，除非您的应用程序的 minSdkVersion 小于 16。

支持全文搜索

如果您的应用程序需要通过全文搜索 (FTS) 快速访问数据库信息，请让实体使用 FTS3 或 FTS4 SQLite 扩展模块 支持的虚拟表格。要使用此功能（Room 2.1.0 及更高版本可用），请在给定实体中添加 @Fts3 或 @Fts4 注解，如下面的代码片段所示。

// Use `@Fts3` only if your app has strict disk space requirements or if you
// require compatibility with an older SQLite version.
@Fts4
@Entity(tableName = "users")
data class User(
    /* Specifying a primary key for an FTS-table-backed entity is optional, but
       if you include one, it must use this type and column name. */
    @PrimaryKey @ColumnInfo(name = "rowid") val id: Int,
    @ColumnInfo(name = "first_name") val firstName: String?
)

// Use `@Fts3` only if your app has strict disk space requirements or if you
// require compatibility with an older SQLite version.
@Fts4
@Entity(tableName = "users")
public class User {
    // Specifying a primary key for an FTS-table-backed entity is optional, but
    // if you include one, it must use this type and column name.
    @PrimaryKey
    @ColumnInfo(name = "rowid")
    public int id;

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

如果表格支持多种语言的内容，请使用 languageId 选项指定存储每行语言信息的列。

@Fts4(languageId = "lid")
@Entity(tableName = "users")
data class User(
    // ...
    @ColumnInfo(name = "lid") val languageId: Int
)

@Fts4(languageId = "lid")
@Entity(tableName = "users")
public class User {
    // ...

    @ColumnInfo(name = "lid")
    int languageId;
}

Room 提供了多种其他选项用于定义支持 FTS 的实体，包括结果排序、标记器类型和作为外部内容管理的表格。有关这些选项的更多详细信息，请参阅 FtsOptions 参考。

索引特定列

如果您的应用程序必须支持不支持支持 FTS3 或 FTS4 的表格实体的 SDK 版本，您仍然可以对数据库中的某些列进行索引，以加快查询速度。要向实体添加索引，请在 @Entity 注解中包含 indices 属性，并列出要包含在索引或复合索引中的列的名称。以下代码片段演示了此注解过程。

@Entity(indices = [Index(value = ["last_name", "address"])])
data class User(
    @PrimaryKey val id: Int,
    val firstName: String?,
    val address: String?,
    @ColumnInfo(name = "last_name") val lastName: String?,
    @Ignore val picture: Bitmap?
)

@Entity(indices = {@Index("name"),
        @Index(value = {"last_name", "address"})})
public class User {
    @PrimaryKey
    public int id;

    public String firstName;
    public String address;

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

    @Ignore
    Bitmap picture;
}

有时，数据库中某些字段或字段组必须是唯一的。您可以通过将 unique 属性设置为 true 来强制执行此唯一性属性。以下代码示例可防止表格包含两行具有相同 firstName 和 lastName 列值的集合。

@Entity(indices = [Index(value = ["first_name", "last_name"],
        unique = true)])
data class User(
    @PrimaryKey val id: Int,
    @ColumnInfo(name = "first_name") val firstName: String?,
    @ColumnInfo(name = "last_name") val lastName: String?,
    @Ignore var picture: Bitmap?
)

@Entity(indices = {@Index(value = {"first_name", "last_name"},
        unique = true)})
public class User {
    @PrimaryKey
    public int id;

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

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

    @Ignore
    Bitmap picture;
}

包含基于 AutoValue 的对象

在 Room 2.1.0 及更高版本中，您可以使用基于 Java 的 不可变值类（使用 @AutoValue 注解）作为应用程序数据库中的实体。当实体的两个实例在其列包含相同值时被视为相等时，这种支持特别有用。

当使用使用 @AutoValue 注解的类作为实体时，可以使用 @PrimaryKey、@ColumnInfo、@Embedded 和 @Relation 注解类的抽象方法。但是，使用这些注解时，必须始终包含 @CopyAnnotations 注解，以便 Room 能够正确解释方法的自动生成的实现。

以下代码片段展示了使用 @AutoValue 注解的类示例，Room 将其识别为实体。

User.java

@AutoValue
@Entity
public abstract class User {
    // Supported annotations must include `@CopyAnnotations`.
    @CopyAnnotations
    @PrimaryKey
    public abstract long getId();

    public abstract String getFirstName();
    public abstract String getLastName();

    // Room uses this factory method to create User objects.
    public static User create(long id, String firstName, String lastName) {
        return new AutoValue_User(id, firstName, lastName);
    }
}