Jetpack学习12-Room使用指南

[TOC]

Room使用指南

使用Room将数据保存在本地数据库中

Room在SQLite上提供了一个抽象层，以便在利用SQLite的全部功能的同时进行流畅的数据库访问。

​ 处理大量结构化数据的应用程序可以从本地持久化这些数据中获益良多。最常见的用例是缓存相关的数据。这样，当设备无法访问网络时，用户仍然可以在离线时浏览该内容。任何用户发起的内容更改都将在设备重新联机后同步到服务器。

​ 因为Room为您解决了这些问题，所以我们强烈建议使用Room而不是SQLite。但是，如果您喜欢直接使用SQLite api，请阅读Save Data Using SQLite。

​ 注意：要在应用程序中使用Room， 请将Architecture Components 组件添加到应用程序的build.gradle文件中。

Room有3个主要组成部分:

• Database:包含数据库持有者，并作为应用程序持久关系数据的底层连接的主要访问点。

  使用@Database注释的类应该满足以下条件:

  • 是一个继承RoomDatabase的抽象类。
  • 在注释中包含与数据库关联的实体列表。
  • 包含一个具有0个参数的抽象方法，并返回用@Dao注释的类。

• Entity:表示数据库中的表。

• DAO:包含用于访问数据库的方法。

该应用程序使用Room数据库来获取与该数据库关联的数据访问对象或DAO。然后，应用程序使用每个DAO从数据库中获取实体，并将对这些实体的任何更改保存回数据库。最后，应用程序使用一个实体来获取和设置与数据库中的表列对应的值。

Room不同组件之间的种关系如图1所示：

[图片上传失败...(image-406472-1552355990776)]

图1.Room架构图

以下代码片段包含一个entity和一个DAO的数据库配置示例:

User

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

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

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

UserDao

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

    @Query("SELECT * FROM user WHERE uid IN (:userIds)")
    List 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);
}

AppDatabase

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

在创建上述文件之后，您可以使用以下代码获得所创建数据库的一个实例:

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

注意：如果您的应用程序在单个进程中运行，则在实例化AppDatabase 对象时应遵循单例设计模式。每个 RoomDatabase实例都相当昂贵，您很少需要在单个进程中访问多个实例。

如果您的应用程序在多个进程中运行，则在数据库构建器调用中包含enableMultiInstanceInvalidation()。这样，当您在每个进程中都有一个AppDatabase实例时，您就可以在一个进程中使共享数据库文件失效，这种失效会自动传播到其他进程中的AppDatabase实例。

要获得Room的实际操作体验，请试用Android Room with a View和Android Persistencecodelabs。要浏览Room代码示例，请参阅Android Architecture Components samples。