翻译自android官网,可直接去官网观看
Jetpack系列之Room----入门(一)
使用 Room 将数据保存到本地数据库
Android的Jetpack的一部分。
处理大量数据的应用程序可以从本地持久存储这些数据中受益匪浅。最常见的用例是缓存相关数据,以便当设备无法访问网络时,用户仍可以在脱机时浏览该内容。设备重新连接到网络后,用户发起的所有内容更改都会同步到服务器。
Room 在 SQLite 上提供了一个抽象层,以便在充分利用 SQLite 的强大功能的同时,能够流畅地访问数据库。Room特别提供以下好处:
- SQL查询的编译时验证。
- 方便注释,可最大程度减少重复和容易出错的样板代码。
- 简化的数据库迁移路径。
由于 Room 负责为您处理这些问题,因此我们强烈建议您使用 Room(而不是 SQLite)。不过,如果您想直接使用 SQLite API,请参阅使用 SQLite 保存数据。
Setup
如需在应用中使用 Room,请将以下依赖项添加到应用的 build.gradle 文件。
dependencies {
def room_version = "2.2.5"
implementation "androidx.room:room-runtime:$room_version"
annotationProcessor "androidx.room:room-compiler:$room_version"
// optional - RxJava support for Room
implementation "androidx.room:room-rxjava2:$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"
}
主要组件
Room 包含 3 个主要组件:
- 保存数据库的 database 类,并用作与应用程序的持久数据的基础连接的主要访问点。
- 代表应用程序数据库中的表的Data entities。
- 数据访问对象(DAO),提供您的应用程序可用来查询,更新,插入和删除数据库中数据的方法。
数据库类为您的应用程序提供了与该数据库关联的DAO实例。反过来,应用程序可以使用DAO作为关联数据实体对象的实例从数据库检索数据。该应用程序还可以使用定义的数据实体来更新对应表中的行,或创建要插入的新行。图1说明了Room的不同组件之间的关系。
图1.Room 架构图
实施范例
本节介绍了具有单个数据实体和单个DAO的Room数据库的示例实现。
数据实体
以下代码定义了一个User数据实体。每个的实例User 代表user应用程序数据库中表中的一行。
@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
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);
}
数据库
以下代码定义了一个AppDatabase用于保存数据库的类。 AppDatabase定义数据库配置,并用作应用程序对持久数据的主要访问点。数据库类必须满足以下条件:
- 该类必须使用@Database注释进行注释,该 @Database注释包括一个entities 列出与数据库关联的所有数据实体的数组。
- 该类必须是可扩展的抽象类 RoomDatabase。
- 对于与数据库关联的每个DAO类,数据库类必须定义一个抽象方法,该方法的参数为零,并返回DAO类的实例。
@Database(entities = {
User.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase {
public abstract UserDao userDao();
}
注意:如果您的应用程序在单个进程中运行,则在实例化AppDatabase 对象时应遵循单例设计模式。每个RoomDatabase实例都非常昂贵,您几乎不需要在单个进程中访问多个实例。
如果您的应用程序在多个进程中运行,请在数据库构建器调用中包含 enableMultiInstanceInvalidation()。这样,当AppDatabase 在每个进程中都有一个实例时,可以在一个进程中使共享数据库文件无效,并且这种无效性会自动传播到AppDatabase其他进程中的实例 。
用法
定义数据实体,DAO和数据库对象之后,可以使用以下代码创建数据库实例:
AppDatabase db = Room.databaseBuilder(getApplicationContext(),
AppDatabase.class, "database-name").build();
然后,您可以使用AppDatabase中的抽象方法获得DAO的实例。反过来,您可以使用DAO实例中的方法与数据库进行交互:
UserDao userDao = db.