JetPack中的Room

2020-01-08 18:49:43

2018年谷歌I/O 发布了一系列辅助android开发者的实用工具，合称Jetpack，以帮助开发者构建出色的 Android 应用。
这次发布的 Android Jetpack 组件覆盖以下 4 个方面：Architecture、Foundation、Behavior 以及 UI。该系列博客介绍一下Jetpack中常用组件，本篇介绍Room，结合ViewModel和LiveData完成上图的结构。最后借助于https://github.com/android/sunflower 来写一个完整的应用

Room简介

原文地址：https://developer.android.google.cn/training/data-storage/room/index.html

Room 持久性库在 SQLite 的基础上提供了一个抽象层，让用户能够在充分利用 SQLite 的强大功能的同时，获享更强健的数据库访问机制。
Room 包含 3 个主要组件：

• 数据库：包含数据库持有者，并作为应用已保留的持久关系型数据的底层连接的主要接入点。

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

  • 是扩展 RoomDatabase 的抽象类。

  • 在注释中添加与数据库关联的实体列表。

  • 包含具有 0 个参数且返回使用 @Dao 注释的类的抽象方法。

  在运行时，您可以通过调用 Room.databaseBuilder() 或 Room.inMemoryDatabaseBuilder() 获取 Database 的实例。

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

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

添加依赖

选择合适的版本

// Room components
implementation "androidx.room:room-runtime:2.2.3"
annotationProcessor "androidx.room:room-compiler:2.2.3"
androidTestImplementation "androidx.room:room-testing:2.2.3"

// Lifecycle components
implementation "androidx.lifecycle:lifecycle-extensions:2.1.0"
annotationProcessor "androidx.lifecycle:lifecycle-compiler:2.1.0"

// UI
implementation "com.google.android.material:material:1.0.0"

创建实体类

@Entity(tableName = "word_table")
public class Word {
   

   @PrimaryKey
   @NonNull
   @ColumnInfo(name = "word")
   private String mWord;

   public Word(String word) {
   this.mWord = word;}

   public String getWord(){
   return this.mWord;}
}

解释一下常用的注解：

@Entity :数据表的实体类。
@PrimaryKey: 每一个实体类都需要一个唯一的标识。
@ColumnInfo :数据表中字段名称。
@Ignore :标注不需要添加到数据表中的属性。
@Embedded :实体类中引用其他实体类。
@ForeignKey:外键约束。

创建DAO

@Dao
public interface WordDao {
   

   // allowing the insert of the same word multiple times by passing a 
   // conflict resolution strategy
   @Insert(onConflict = OnConflictStrategy.IGNORE)
   void insert(Word word);

   @Query("DELETE FROM word_table")
   void deleteAll();

   @Query("SELECT * from word_table ORDER BY word ASC")
   List<Word> getAlphabetizedWords();
}

@Dao ：数据库操作的类。
@Query ： 包含所有Sqlite语句操作。
@Insert ： 插入操作。
@Delete ： 删除操作。
@Update ： 更新操作。

冲突条款 :我们在@Insert中添加的属性值。 就是针对出现**约束异常(ROLLBACK, ABORT, FAIL, IGNORE, and REPLACE)**的非标准处理。

ABORT ： 默认值，不处理约束异常。
ROLLBACK： 与ABORT相似，不常用。
FAIL ： 在批量更新或者修改时，中途出现了约束异常，就会终止后续执行，但会保留已执行的sql语句。
IGNORE ： 忽略约束异常，不做任何处理保留原数据。
REPLACE： 当出现约束异常时，移除原数据 & 将新数据覆盖。

解释一波：

• 被@Dao注解的类一定是接口或者抽象类，
• void insert(Word word);声明一个插入的方法，不需要我们提供SQL语句，只需要用@Insert标记一下就好
• @Query("DELETE FROM word_table"):@Query需要我们提供一下SQL语句

这里的WordDao会在编译时生成WordDAO_Impl类，

Room database

我们自己定义的Room database必须是继承自RoomDatabase的抽象类，通常我们会把该类做成单例模式

@Database(entities = {
   Word.class}, version = 1, exportSchema = false)
public abstract class WordRoomDatabase extends RoomDatabase {
   

   public abstract WordDao wordDao();

   private static volatile WordRoomDatabase INSTANCE;
   private static final int NUMBER_OF_THREADS = 4;
   static final ExecutorService databaseWriteExecutor =
        Executors.newFixedThreadPool(NUMBER_OF_THREADS);

   static WordRoomDatabase getDatabase(final Context context) {
   
        if (INSTANCE == null) {
   
            synchronized (WordRoomDatabase.class) {
   
                if (INSTANCE == null) {
   
                    INSTANCE = Room.databaseBuilder(context.getApplicationContext(),
                            WordRoomDatabase.class, "word_database")
                            .build();
                }
            }
        }
        return INSTANCE;
    }