【Jetpack】ORM 数据库访问框架 Room 简介 ( 对象关系映射 ORM 概念简介 | Room 框架的组成部分 - 实体、数据库访问对象、数据库持有者 | Room 框架使用步骤 )

一、对象关系映射 - ORM / Object Relational Mapping

Android 系统中使用的数据库是 SQLite 关系型数据库 , 使用 Android 提供的 api 访问 SQLite 数据库非常繁琐 , 由此出现了很多 ORM 框架 ;

ORM 英文全称 Object Relational Mapping , 对象关系映射 ;

对象关系映射 ORM 是一种编程技术 , 面向对象编程语言 与 关系型数据库 之间的 映射 ;

• 对象 指的是 面向对象编程语言 ,
• 关系 指的是 关系型数据库 ;

借助 ORM 对象关系映射 框架 访问数据库 , 可以 简化数据库操作流程 , 开发人员使用面向对象 API 与 数据库进行交互 , 比编写复杂的 SQL 语句操作数据库 要简单很多 ;

ORM 框架常使用 元数据 将 数据库表 与 编程语言中的类 进行映射 , 数据库表字段 与 类中的字段 一一对应 , 常用的元数据有 :

• 注解
• 配置文件

ORM 框架优点 :

• 提高了开发效率 : 使用 ORM 操作数据库 简化了数据库操作过程 , 令代码更容易开发维护 ;
• 提高了可移植性 : 使用 ORM 框架操作数据库 , 可以在 不改变代码的前提下 , 更换底层数据库 ;
• 提高了性能 : 可以 总体优化 ORM 框架的 增删查改 操作性能 ;
• 提高了安全性 : 可避免直接使用 SQL 语句查询时 , 产生的 SQL 注入攻击 ;

常见的 ORM 框架 :

• Android 平台 : GreenDao / ORMLite ;
• JavaEE 平台 : Hibernate ;
• .NET 平台 : Entity Framework ;
• Python 平台 : DiangoORM ;

在 Android 中 , Google 官方提供了一个基于 SQLite 关系型数据库操作封装的 ORM 框架 , Room 框架 ;

二、Room 框架的组成部分

1、@Entity / @Dao / @Database 注解

Room 框架中的重要注解 :

• @Entity 注解 : 用于修饰 JavaBean 实体类 , 对应数据库中的一张表结构 ;
• @Dao 注解 : 用于修饰 数据库访问对象 类 ， 其中定义了 数据库的 增删改查 函数 ;
• @Database 注解 : 修饰 数据库持有者 , 数据库持有者 就是 数据库链接对象 , 是 应用持久化数据底层连接的接入点 ;
  • 使用 @Database 注解 修饰的类 , 该类必须继承 RoomDatabase 抽象类 ;
  • 在该注解中 , 需要定义 数据库 相关的 实体类 列表 ;
  • 数据库持有者 包含 没有参数的抽象方法 , 该方法返回 Dao 对象 ;

2、Entity 实体类 / Dao 数据库访问对象 / Database 数据库持有者 之间的关系

Database 数据库持有者 , Dao ( Data Access Objects ) 数据库访问对象 , Entity 实体类 , 三者之间的关系如下 :

• 首先 , 在 Android 应用中 , 通过 Room 框架的 Database 拿到 数据库持有者 对象 ;
• 然后 , 通过 数据库持有者 Database 拿到 Dao ( Data Access Objects ) 数据库访问对象 ;
• 最后 , 通过 Dao ( Data Access Objects ) 数据库访问对象 访问 数据库中每个表对应的 Entity 实体类对象 ;

三、Room 框架使用步骤

Room 框架使用步骤 ：

• 添加 Room 框架依赖
• 创建 Entity 实体类
• 创建 Dao 实体类
• 创建 RoomDatabase 数据库实例对象
• 初始化 Room 数据库
• 调用 Dao 执行数据库增删改查操作

1、添加 Room 框架依赖

在 Module 模块下的 build.gradle 构建脚本 中 , 配置如下依赖项 :

dependencies {
	// 配置 Room 框架版本号
    def room_version = "2.4.0"
	
	// 核心运行时依赖库 在应用运行时提供 Room 框架的数据库相关核心功能
    implementation "androidx.room:room-runtime:$room_version"
    // 编译时依赖项 在编译时实时生成 Room 代码 如 : Dao 实现类 / AppDatabase 子类 / Entity 实体类映射器
    annotationProcessor "androidx.room:room-compiler:$room_version"

    // 可选配置项 - 支持 Kotlin 扩展和协程的 Room 框架 如果使用的是 Kotlin 语言必须导入该依赖
    implementation "androidx.room:room-ktx:$room_version"
}

androidx.room:room-runtime 依赖库 是 运行时核心依赖库 , 在应用运行时提供 Room 框架的数据库相关核心功能 ; 该依赖库 包含了 Room 持久化库的核心功能 , 如 :

• RoomDatabase 类：用于表示数据库，可以包含一个或多个表，并提供了一些方法来操作数据库，例如插入、删除和查询数据等。
• Entity 注解：用于标记实体类，指定实体类对应的数据库表的名称和字段信息等。
• Dao 数据库访问对象：用于定义访问数据库的方法，例如查询、插入和删除等操作。
• Query 注解：用于标记 DAO 接口中的方法，并指定 SQL 查询语句。
• PrimaryKey 注解：用于指定实体类中的主键字段。
• TypeConverters 注解：用于标记类型转换器类，将特定类型的数据转换为数据库中的原生类型。

androidx.room:room-compiler 依赖库 是 Room 持久化库中的一个 编译时依赖项 , 用于 在编译时生成 Room 的如下实现代码 :

• AppDatabase 的子类 , 用于创建和访问数据库 ;
• Dao 数据库访问对象实现类 , 用于执行 SQL 查询和操作 ;
• 实体类 Entity 的映射器 , 用于将数据库中的数据映射到实体类中 ;

androidx.room:room-ktx 依赖库 , 提供了 Kotlin 扩展功能 , 如果使用的是 Kotlin 语言 , 则必须导入该依赖库 ;

2、创建 Entity 实体类

创建 Entity 实体类 , 该实体类对应着数据库中的一张表 , 需要使用如下注解修饰

• 使用 @Entity 注解修饰实体类 , 并指定 数据库表名 ;
• 使用 @PrimaryKey 注解修饰主键值 ,
• 使用 @ColumnInfo 注解修饰 数据库表 列名 对应的字段 ;

@Entity(tableName = "users")
data class User(
    @PrimaryKey val id: Int,
    @ColumnInfo(name = "name") val name: String,
    @ColumnInfo(name = "age") val age: Int
)

3、创建 Dao 实体类

创建 Dao 实体类 : 创建用于访问数据库的 DAO 接口 , 并使用注解指定 SQL 查询语句等信息 ;

• 使用 @Dao 注解修饰整个 Dao 实体类 ;
• 使用 @Query 注解修饰查询函数 ;
• 使用 @Insert 注解修饰插入函数 ;
• 使用 @Delete 注解修饰删除函数 ;

@Dao
interface UserDao {
    @Query("SELECT * FROM users")
    fun getAll(): List<User>

    @Insert
    fun insert(user: User)

    @Delete
    fun delete(user: User)
}

4、创建 RoomDatabase 数据库实例对象

创建 RoomDatabase 数据库实例对象 : 创建 RoomDatabase 的子类实例对象 , 并定义抽象方法以获取 DAO 实例 ;

@Database(entities = arrayOf(User::class), version = 1)
abstract class AppDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao
}

5、初始化 Room 数据库

初始化数据库 : 在应用程序中使用 Room 数据库之前 , 必须先创建数据库实例 ;

val db = Room.databaseBuilder(
    applicationContext,
    AppDatabase::class.java, "database-name"
).build()

6、调用 Dao 执行数据库增删改查操作

调用 Dao 执行数据库增删改查操作 :

db.userDao().insert(User(1, "John", 25))
val users = db.userDao().getAll()