Android Jetpack架构组件 — Room入坑详解

本文首发于微信公众号「Android开发之旅」，欢迎关注 ，获取更多技术干货

Room是Jetpack组件库一员，属于ORM库，主要是对Sqlite做了一层抽象，从而简化开发者对数据库操作。Room支持编译时的语法检查，并且支持返回LiveData。

添加依赖

在app的build.gradle中添加如下依赖：

def room_version = "2.2.0-rc01"
    
implementation "androidx.room:room-runtime:$room_version"
// For Kotlin use kapt instead of annotationProcessor (注意这个注释)
kapt "androidx.room:room-compiler:$room_version"

如果项目是使用Kotlin语言来开发的，在添加room-compiler的时候使用kapt关键字，java语言开发的就使用annotationProcessor关键。否则会导致访问出错。

重要概念

要想使用Room，必须要了解最基础的三个概念：

• Entity：实体类，对应的是数据库的一张表结构。需要使用注解 @Entity 标记。
• Dao：包含访问一系列访问数据库的方法。需要使用注解 @Dao 标记。
• Database：数据库持有者，作为与应用持久化相关数据的底层连接的主要接入点。需要使用注解 @Database 标记。
  使用@Database注解需满足以下条件：
  定义的类必须是一个继承于RoomDatabase的抽象类。
  在注解中需要定义与数据库相关联的实体类列表。
  包含一个没有参数的抽象方法并且返回一个带有注解的 @Dao。

三者之间和应用的对应关系如下图：

Entity

使用 @Entity注解定义的类会被映射为数据库中的一张表。默认实体类的类名为表名，字段名为表名。当然我们也是可以修改的。

@Entity(tableName = "users")
data class User(
    @PrimaryKey(autoGenerate = true) var userId: Long,
    @ColumnInfo(name = "user_name")var userName: String,
    @ColumnInfo(defaultValue = "china") var address: String,
    @Ignore var sex: Boolean
)

比如这里我们定义了一个User类。这里使用了@Entity、@PrimaryKey、@ColumnInfo和@Ignore

在@Entity注解中我们传入了一个参数 tableName用来指定表的名称。@PrimaryKey注解用来标注表的主键，并且使用autoGenerate = true 来指定了主键自增长。@ColumnInfo注解用来标注表对应的列的信息比如表名、默认值等等。@Ignore 注解顾名思义就是忽略这个字段，使用了这个注解的字段将不会在数据库中生成对应的列信息。也可以使用@Entity注解中的 ignoredColumns 参数来指定，效果是一样的。

除了以上使用的参数字段外，注解还有其他的参数，下面我来看下相关源码了解下其他的参数。

Entity注解：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface Entity {

    String tableName() default "";

    Index[] indices() default {};

    boolean inheritSuperIndices() default false;

    String[] primaryKeys() default {};

    String[] ignoredColumns() default {};
}

PrimaryKey注解：

@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.CLASS)
public @interface PrimaryKey {
  
    boolean autoGenerate() default false;
}

ColumnInfo注解：

@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.CLASS)
public @interface ColumnInfo {
   
    String name() default INHERIT_FIELD_NAME;

    @SuppressWarnings("unused") @SQLiteTypeAffinity int typeAffinity() default UNDEFINED;

    boolean index() default false;

    @Collate int collate() default UNSPECIFIED;

    String defaultValue() default VALUE_UNSPECIFIED;
   
    String INHERIT_FIELD_NAME = "[field-name]";
 
    int UNDEFINED = 1;
    int TEXT = 2;
    int INTEGER = 3;
    int REAL = 4;
   
    int BLOB = 5;

    @IntDef({UNDEFINED, TEXT, INTEGER, REAL, BLOB})
    @Retention(RetentionPolicy.CLASS)
    @interface SQLiteTypeAffinity {
    }

    int UNSPECIFIED = 1;
    int BINARY = 2;
    int NOCASE = 3;
    int RTRIM = 4;
       
    @RequiresApi(21)
    int LOCALIZED = 5;
    
    @RequiresApi(21)
    int UNICODE = 6;

    @IntDef({UNSPECIFIED, BINARY, NOCASE, RTRIM, LOCALIZED, UNICODE})
    @Retention(RetentionPolicy.CLASS)
    @interface Collate {
    }

    String VALUE_UNSPECIFIED = "[value-unspecified]";
}

Ignore注解：

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR})
@Retention(RetentionPolicy.CLASS)
public @interface Ignore {
}

Dao

Dao类是一个 interface，其中定义了一系列的操作数据库的方法。通常我们操作数据库无非就是增删改查。Room也为我们的提供了相关的注解，有@Insert、@Delete、@Update 和 @Query。

@query

我们先来看下 @Query 查询注解，它的参数时String类型，我们直接写SQL语句进行执行，而且编译的时候可以进行语法检查。比如我们根据ID查询某个用户的信息：

@Query("select * from user where userId = :id")
fun getUserById(id: Long): User

SQL语句引用传递的参数直接使用 ：符号进行引用。

@Insert

如果我们需要向表中插入一条数据,我们直接定义一个方法并用 @Insert注解标注就可以：

@Insert(onConflict = OnConflictStrategy.REPLACE)
fun addUser(user: User)

我们看到直接中有个参数onConflict，表示的是当插入的数据已经存在时候的处理逻辑，有三种操作逻辑：REPLACE、ABORT和IGNORE。如果不指定则默认为ABORT终止插入数据。这里我们将其指定为REPLACE替换原有数据。

@Delete

如果需要删除表的数据则使用 @Delete注解：

@Delete
fun deleteUserByUser(user: User)

使用主键来查找要删除的实体。

@Update

如果需要修改某一条数据则使用 @Update注解，和@Delete一样也是根据主键来查找要删除的实体。

@Update
fun updateUserByUser(user: User)

上面说的 @Query 查询接受的参数是一个字符串，所以像删除或者更新我们也可以使用 @Query 注解来使用SQL语句来直接执行。比如根据userid来查询某个用户或者根据userid更新某个用户的姓名：

@Query("delete  from user where userId = :id ")
fun deleteUserById(id:Long)

@Query("update  user set userName = :updateName where userID =  :id")
fun update(id: Long, updateName: String)

效果是完全一样的。

Database

首先定义一个抽象类继承RoomDatabase类，并添加注解 @Database 来标识：

@Database(entities = [User::class], version = 1)
abstract class AppDatabase : RoomDatabase() {

    abstract fun userDao(): UserDao

    companion object {
        private var instance: AppDatabase? = null
        fun getInstance(context: Context): AppDatabase {
            if (instance == null) {
                instance = Room.databaseBuilder(
                    context.applicationContext,
                    AppDatabase::class.java,
                    "user.db" //数据库名称
                ).allowMainThreadQueries().build()
            }
            return instance as AppDatabase
        }
    }
}

还记得上文中说Database需要满足的是那个要求吗？这里可以和上文联系起来对比看下。

使用entities来映射相关的实体类，version来指明当前数据库的版本号。这里使用了单例模式来返回Database，以防止新建过多的实例造成内存的浪费。Room.databaseBuilder(context,klass,name).build()来创建Database，其中第一个参数为上下文，第二个参数为当前Database的class字节码文件，第三个参数为数据库名称。

默认情况下Database是不可以在主线程中进行调用的。因为大部分情况，操作数据库都还算是比较耗时的动作。如果需要在主线程调用则使用allowMainThreadQueries进行说明。

使用

以上都定义好后，就是如何调用了。我们在Activity中使用：

class RoomActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        val userDao = AppDatabase.getInstance(this).userDao()

        //insert数据
        for (i in (0 until 10)) {
            val user = User(userName = "李四$i", userPhone = "110$i")
            userDao.addUser(user)
        }

        //query所有数据
        userDao.getAllUsers().forEach {
            Log.e("room", "==query==${it.userId},${it.userName},${it.userPhone}")
        }

        //update数据
        userDao.updateUserById(2, "张三")
        val updateUser = userDao.getUserById(2)
        Log.e("room", "==update==${updateUser.userId},${updateUser.userName},${updateUser.userPhone}")
        
        //Delete数据
        val row = userDao.deleteUserById(10)
        Log.e("room", "删除了 $row 行")

    }
}

我们来看下数据

插入的10条数据
room: ==query==1,李四0,1100
room: ==query==2,李四1,1101
room: ==query==3,李四2,1102
room: ==query==4,李四3,1103
room: ==query==5,李四4,1104
room: ==query==6,李四5,1105
room: ==query==7,李四6,1106
room: ==query==8,李四7,1107
room: ==query==9,李四8,1108
room: ==query==10,李四9,1109

更新了id为2的这条数据
room: ==update==2,张三,1101

删除了id为10的数据
room: 删除了 1 行

生成的数据库在data/data/packageName/databases 目录中。

Dao和Database相关文件在编译后会在build目录下生成 UserDao_Impl和AppDatabase_Impl文件，有兴趣的可以自己去看下。

数据库升级和降级

在使用数据库的时候避免不了的就是数据库的更新。数据库的升级或者降级使用addMigrations方法进行操作：

instance = Room.databaseBuilder(
            context.applicationContext,
            AppDatabase::class.java,
            "user.db"
        ).addMigrations(object :Migration(1,2){
            override fun migrate(database: SupportSQLiteDatabase) {
               database.execSQL("ALTER TABLE user ADD age INTEGER Default 0 not null ")
            }

        })allowMainThreadQueries().build()

其中Migration需要两个参数，startVersion表示的是升级开始的版本，endVersion表示要升级到的版本。同时需要将@Database注解中的version的值修改为和endVersion相同。

比如上面代码将数据库从版本1升级到版本2，并在版本2上增加了age一列：

数据库降级使用也是一样。也是使用addMigrations只是startVersion > endVersion 。

当在升级或者降级的过程中出现版本未匹配到的情况的时候，默认情况下会直接抛异常出来。当然我们也可以处理异常。

升级的时候可以添加fallbackToDestructiveMigration方法，当未匹配到版本的时候就会直接删除表然后重新创建。

降级的时候添加fallbackToDestructiveMigrationOnDowngrade方法，当未匹配到版本的时候就会直接删除表然后重新创建。

推荐阅读

还不知道Android Jetpack是什么？你就out了

Android Jetpack架构组件 — Lifecycle入坑指南

Android Jetpack架构组件 — LiveData与ViewModel入坑详解

扫描下方二维码关注公众号，获取更多技术干货。