Android开发笔记（一百七十五）利用Room简化数据库操作

Posted 2022-12-07 aqi00

虽然android提供了数据库帮助器，但是开发者在进行数据库编程时仍有诸多不便，比如每次增加一张新表，开发者都得手工实现以下代码逻辑：
1、重写数据库帮助器的onCreate方法，添加该表的建表语句；
2、在插入记录之时，必须将数据实例的属性值逐一赋给该表的各字段；
3、在查询记录之时，必须遍历结果集游标，把各字段值逐一赋给数据实例；
4、每次读写操作之前，都要先开启数据库连接；读写操作之后，又要关闭数据库连接；
上述的处理操作无疑存在不少重复劳动，数年来引得开发者叫苦连连。为此各类数据库处理框架纷纷涌现，包括GreenDao、OrmLite、Realm等等，可谓百花齐放。眼见SQLite渐渐乏人问津，谷歌公司干脆整了个自己的数据库框架名叫Room，该框架同样基于SQLite，但通过注解技术极大简化了数据库操作，减少了原来相当一部分编码工作量。
由于Room并未集成到SDK中，而是作为第三方框架提供，因此首先要修改模块的build.gradle文件，往dependencies节点添加下面两行配置，表示导入指定版本的Room库：

implementation 'androidx.room:room-runtime:2.2.5'
annotationProcessor 'androidx.room:room-compiler:2.2.5'

导入Room库之后，还要编写若干对应的代码文件。以录入书籍信息为例，此时要对书籍信息表进行增删改查，则具体的编码过程分为下列五个步骤：

一、编写书籍信息表对应的实体类

假设书籍信息类名叫BookInfo，且它的各属性与书籍信息表的各字段一一对应，那么要给该类添加“@Entity”注解，表示该类是Room专用的数据类型，对应的表名称也叫BookInfo。如果BookInfo表的name字段是该表的主键，则需给BookInfo类的name属性添加“@PrimaryKey”与“@NonNull”两个注解，表示该字段是个非空的主键。下面是BookInfo类的定义代码例子：

@Entity
public class BookInfo 
    @PrimaryKey // 该字段是主键，不能重复
    @NonNull // 主键必须是非空字段
    private String name;  // 书籍名称
    private String author;  // 作者
    private String press;  // 出版社
    private double price;  // 价格
    // 以下省略各属性的set***方法和get***方法

二、编写书籍信息表对应的持久化类

所谓持久化，指的是将数据保存到磁盘而非内存，其实等同于增删改查等SQL语句。假设书籍信息表的持久化类名叫做BookDao，那么该类的记录查询方法必须添加“@Query”注解，记录插入方法必须添加“@Insert”注解，记录更新方法必须添加“@Update”注解，记录删除方法必须添加“@Delete”注解（带条件的删除方法除外）。对于记录查询方法，允许在@Query之后补充具体的查询语句以及查询条件；对于记录插入方法与记录更新方法，需明确出现重复记录时要采取哪种处理策略。下面是BookDao类的定义代码例子：

@Dao
public interface BookDao 
    @Query("SELECT * FROM BookInfo")  // 设置查询语句
    List<BookInfo> getAllBook();  // 加载所有书籍信息

    @Query("SELECT * FROM BookInfo WHERE name = :name")  // 设置带条件的查询语句
    BookInfo getBookByName(String name);  // 根据名字加载书籍

    @Insert(onConflict = OnConflictStrategy.REPLACE)  // 出现重复记录时替换原记录
    void insertOneBook(BookInfo book);  // 插入一条书籍信息

    @Insert
    void insertBookList(List<BookInfo> bookList);  // 插入多条书籍信息

    @Update(onConflict = OnConflictStrategy.REPLACE)// 出现重复记录时替换原记录
    int updateBook(BookInfo book);  // 更新书籍信息

    @Delete
    void deleteBook(BookInfo book);  // 删除书籍信息

    @Query("DELETE FROM BookInfo WHERE 1=1")  // 设置删除语句
    void deleteAllBook();  // 删除所有书籍信息

三、编写书籍信息表对应的数据库类

因为先有数据库然后才有表，所以书籍信息表还得放到某个数据库里，这个默认的书籍数据库只要从RoomDatabase派生而来即可。下面是数据库类BookDatabase的定义代码例子：

@Database(entities = BookInfo.class,version = 1, exportSchema = false)
public abstract class BookDatabase extends RoomDatabase 
    // 获取该数据库中某张表的持久化对象
    public abstract BookDao bookDao();

四、在自定义的Application类中声明书籍数据库的唯一实例

为了避免重复打开数据库造成的内存泄漏问题，每个数据库在App运行过程中理应只有一个实例，此时要求开发者自定义新的Application类，在该类中声明并获取书籍数据库的实例，并将自定义的Application类设为单例模式，保证App运行之时有且仅有一个应用实例。下面是自定义Application类的代码例子：

public class MainApplication extends Application 
    private static MainApplication mApp;  // 声明一个当前应用的静态实例
    private BookDatabase bookDatabase;  // 声明一个书籍数据库对象

    // 利用单例模式获取当前应用的唯一实例
    public static MainApplication getInstance() 
        return mApp;
    

    @Override
    public void onCreate() 
        super.onCreate();
        mApp = this;  // 在打开应用时对静态的应用实例赋值
        // 构建书籍数据库的实例
        bookDatabase = Room.databaseBuilder(mApp, BookDatabase.class,"BookInfo")
                .addMigrations()  // 允许迁移数据库（发生数据库变更时，Room默认删除原数据库再创建新数据库）
                .allowMainThreadQueries()  // 允许在主线程中操作数据库（Room默认不能在主线程中操作数据库）
                .build();
    

    // 获取书籍数据库的实例
    public BookDatabase getBookDB()
        return bookDatabase;
    

五、在操作书籍信息表的地方获取数据库下的持久化对象

持久化对象的获取代码很简单，只需下面一行代码就够了：

// 从App实例中获取唯一的书籍持久化对象
BookDao bookDao = MainApplication.getInstance().getBookDB().bookDao();

完成以上五个编码步骤之后，接着调用持久化对象的query***、insert***、update***、delete***等方法，就能实现书籍信息的增删改查操作了。
运行测试App，先打开记录保存页面，依次录入并将两本书籍信息保存至数据库，如下面两图所示。

  

再打开记录读取页面，从数据库读取书籍信息并展示在页面上，如下图所示。

点此查看Android开发笔记的完整目录