Jetpack系列1——Room 数据库

前言：今天开始为大家打来Jetpack系列的学习，首先今天开始学习Jetpack中很重要的组件Room数据库。

如有兴趣可了解下本人的Jetpack系列文章：

Jetpack系列1——Room 数据库
Jetpack系列2——ViewBinding数据绑定

1. Room

Room是一个数据库对象映射库，可轻松访问Android应用程序上的数据库。

1.1 Room介绍

• 介绍：Room是Jetpack组件库一员，属于ORM库，主要是对Sqlite做了一层抽象，从而简化开发者对数据库操作。Room支持编译时的语法检查，并且支持返回LiveData。简单来说就是封装了Sqlite方便使用。

1.1.1 Room中三个主要组件介绍

• Database、Entity、DAO

下面是其三者和数据库的关系图：

image.png

1.1.2 Database 组件

• 此组件用于创建数据库的持有者，同时在类层级上使用注解来定义一系列的Entity，这些Entity对应着数据库中的表格。
• Database类中的方法则用来获取对应的Dao列表。Database是App层与底层SQLite之间的连接点。在应用中要使用此组件的话需要继承RoomDatabase。然后通过Room.databaseBuilder()或者Room.inMemoryDatabaseBuilder().获得该类的实例。

1.1.3 Entity 组件

• 此组件的一个实例表示数据库的一行数据，对于每个Entity类来说，都会有对应的table被创建。想要这些Entity被创建，就需要写在上面Database的注解参数entities列表中。默认Entity中的所有字段都会拿来创建表，除非在该字段上加上@Ignore注解。

• 注意：Entity默认都只有空的构造方法（如果DAO类可以访问每个持久化字段），或者构造方法的参数与Entity中的字段的类型和名字相匹配。

Room可以使用全字段构造方法，也可以使用部分字段构造方法。

1.1.4 DAO 组件

• 这个组件用来表示具有Data Access Object(DAO)功能的类或接口。

• DAO类是Room的重要组件，负责定义访问数据库的方法。继承RoomDatabase的类必须包含一个0参数且返回DAO类的方法。当在编译期生成代码的时候，Room会创建实现此DAO的类。

• 注意：通过使用DAO类而不是传统的查询接口来访问数据库，可以做到数据库组件的分离。同时DAO可以在测试APP时支持Mock数据。

1.2 使用方式

1.2.1 如何引用（以下均为Kotlin写法）

• 导入依赖

def room_version = "2.2.5"
implementation "androidx.room:room-runtime:$room_version"
kapt "androidx.room:room-compiler:$room_version"

1.2.3 创建数据库实体类 Entity

• 实体类中可能用到注解有：

• @Entity 将实体类定义为数据库实类

• @Entity(tableName = "表名") 将数据库名称进行修改

• @PrimaryKey(autoGenerate = true) 设置主键自增

• @ColumnInfo(name = "列名称") 将列名称进行修改

• @Ignore 忽略字段

• 使用如下

image.png

1.2.4 创建Dao类

• @Dao 指定类为使用的Dao类

image.png

• @Insert 插入数据到数据库中

image.png

• @Update 从数据库中修改数据

image.png

• @Delete 从数据库中删除数据

image.png

• @Query("查询数据SQL") 从查询数据库中数据

image.png

1.2.5 创建Database对象

• @Database(entities = [User::class], version = 1)
• 使用entities来映射相关的实体类，version来指明当前数据库的版本号。

image.png

• 这里使用了单例模式来返回Database，以防止新建过多的实例造成内存的浪费。
  image.png

以上为数据库使用前所需要创建的所有工作了，接下来就可以进行使用了~

1.2.6 在Activity中使用

image.png

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

1.2.7 数据库升级

第一步：修改数据库类

image.png

第二步：在Database中将version值加一

image.png

第三步：通过addMigrations方法进行升级

image.png

按照步骤实现后，重新运行程序即可。

image.png

PS：使用Room配合AndroidStudio自带插件Database Inspector(数据库查询插件)有奇效！

查看数据

[图片上传失败...(image-a6bede-1614061323362)]

查询数据

image.png

修改数据

image.png

1.3 参考文章

• 官方介绍地址：https://developer.android.google.cn/jetpack/androidx/releases/room
• 知乎学习文章：https://zhuanlan.zhihu.com/p/94008969
• 博客文章：https://www.jianshu.com/p/82a06f579e52