使用 Room 引用复杂数据

Room 提供了在原始类型和包装类型之间进行转换的功能，但不允许实体之间存在对象引用。本文档说明了如何使用类型转换器以及 Room 为什么不支持对象引用。

使用类型转换器

有时，您需要您的应用在一个数据库列中存储自定义数据类型。您可以通过提供 *类型转换器* 来支持自定义类型，类型转换器是告诉 Room 如何将自定义类型转换为 Room 可以持久化的已知类型，以及如何进行反向转换的方法。您可以使用 @TypeConverter 注解来标识类型转换器。

假设您需要在 Room 数据库中持久化 Date 实例。Room 不知道如何持久化 Date 对象，因此您需要定义类型转换器。

Kotlin

class Converters {
  @TypeConverter
  fun fromTimestamp(value: Long?): Date? {
    return value?.let { Date(it) }
  }

  @TypeConverter
  fun dateToTimestamp(date: Date?): Long? {
    return date?.time?.toLong()
  }
}

Java

public class Converters {
  @TypeConverter
  public static Date fromTimestamp(Long value) {
    return value == null ? null : new Date(value);
  }

  @TypeConverter
  public static Long dateToTimestamp(Date date) {
    return date == null ? null : date.getTime();
  }
}

此示例定义了两种类型转换器方法：一种将 Date 对象转换为 Long 对象，另一种执行从 Long 到 Date 的反向转换。由于 Room 知道如何持久化 Long 对象，因此它可以使用这些转换器来持久化 Date 对象。

接下来，您将 @TypeConverters 注解添加到 AppDatabase 类，以便 Room 知道您已定义的转换器类。

Kotlin

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

Java

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

定义了这些类型转换器后，您就可以在实体和 DAO 中像使用原始类型一样使用自定义类型。

Kotlin

@Entity
data class User(private val birthday: Date?)

@Dao
interface UserDao {
  @Query("SELECT * FROM user WHERE birthday = :targetDate")
  fun findUsersBornOnDate(targetDate: Date): List<User>
}

Java

@Entity
public class User {
  private Date birthday;
}

@Dao
public interface UserDao {
  @Query("SELECT * FROM user WHERE birthday = :targetDate")
  List<User> findUsersBornOnDate(Date targetDate);
}

在此示例中，Room 可以随处使用已定义的类型转换器，因为您使用 @TypeConverters 注解了 AppDatabase。但是，您也可以通过使用 @TypeConverters 注解您的 @Entity 或 @Dao 类，将类型转换器的范围限定为特定的实体或 DAO。

控制类型转换器初始化

通常情况下，Room 会为您处理类型转换器的实例化。但是，有时您可能需要向类型转换器类传递其他依赖项，这意味着您需要您的应用直接控制类型转换器的初始化。在这种情况下，请使用 @ProvidedTypeConverter 注解您的转换器类。

Kotlin

@ProvidedTypeConverter
class ExampleConverter {
  @TypeConverter
  fun StringToExample(string: String?): ExampleType? {
    ...
  }

  @TypeConverter
  fun ExampleToString(example: ExampleType?): String? {
    ...
  }
}

Java

@ProvidedTypeConverter
public class ExampleConverter {
  @TypeConverter
  public Example StringToExample(String string) {
    ...
  }

  @TypeConverter
  public String ExampleToString(Example example) {
    ...
  }
}

然后，除了在 @TypeConverters 中声明您的转换器类之外，还可以使用 RoomDatabase.Builder.addTypeConverter() 方法将转换器类的实例传递给 RoomDatabase 生成器。

Kotlin

val db = Room.databaseBuilder(...)
  .addTypeConverter(exampleConverterInstance)
  .build()

Java

AppDatabase db = Room.databaseBuilder(...)
  .addTypeConverter(exampleConverterInstance)
  .build();

了解 Room 为什么不允许对象引用

关键要点：Room 不允许实体类之间的对象引用。相反，您必须显式请求您的应用所需的数据。

将数据库中的关系映射到相应的对象模型是一种常见的做法，并且在服务器端运行良好。即使程序在访问时加载字段，服务器的性能仍然很好。

然而，在客户端，这种延迟加载方式不可行，因为它通常发生在UI线程上，而UI线程中查询磁盘信息会造成严重的性能问题。UI线程通常只有大约16毫秒来计算和绘制活动更新的布局，因此即使查询只需要5毫秒，您的应用也可能仍然没有足够的时间来绘制帧，从而导致明显的视觉故障。如果同时运行单独的事务，或者设备正在运行其他磁盘密集型任务，则查询可能需要更长时间才能完成。但是，如果不使用延迟加载，您的应用将获取比所需更多的数据，从而造成内存消耗问题。

对象关系映射通常将此决定权留给开发者，以便他们可以为其应用的用例选择最佳方案。开发者通常决定在应用和UI之间共享模型。但是，此解决方案的扩展性不佳，因为随着时间的推移，UI发生变化，共享模型会产生开发者难以预测和调试的问题。

例如，考虑一个加载Book对象列表的UI，每个图书都有一个Author对象。您最初可能设计查询使用延迟加载，以便Book实例检索作者。第一次检索author字段会查询数据库。一段时间后，您意识到还需要在应用的UI中显示作者姓名。您可以轻松访问此名称，如下面的代码片段所示。

Kotlin

authorNameTextView.text = book.author.name

Java

authorNameTextView.setText(book.getAuthor().getName());

但是，这个看似无害的更改会导致在主线程上查询Author表。

如果您提前查询作者信息，那么如果您不再需要这些数据，则很难更改数据的加载方式。例如，如果您的应用UI不再需要显示Author信息，您的应用实际上会加载它不再显示的数据，从而浪费宝贵的内存空间。如果Author类引用另一个表（例如Books），则应用的效率会进一步下降。

要使用Room同时引用多个实体，您可以创建一个包含每个实体的POJO，然后编写一个连接相应表的查询。这种结构良好的模型，结合Room强大的查询验证功能，使您的应用在加载数据时能够消耗更少的资源，从而提高应用的性能和用户体验。