Android Room的使用详解

news2024/9/21 17:21:04

Android Room的使用详解

一：Room的基本介绍

 Room 是 Android 架构组件的一部分，Room 持久性库在 SQLite
 上提供了一个抽象层，以便在充分利用 SQLite 的强大功能的
 同时，能够流畅地访问数据库。具体来说，Room 具有以下优势：

针对 SQL 查询的编译时验证。
可最大限度减少重复和容易出错的样板代码的方便注解。
简化了数据库迁移路径

二：Room 库由 3 个主要组件组成：

实体：

Entity 表示数据库中的一个表，必须用@Entity 进行注释。每个实体至少包含一个字段，必须定义一个主键。

DAO（数据库访问对象）：

在 Room 中，您可以使用数据访问对象来访问和管理您的数据。DAO 是 Room 的主要组件，包括提供对您的应用程序数据库的访问的方法，它必须用@Dao注释。使用 DAO 代替查询构建器，让您分离数据库的不同组件，例如当前数据和统计信息，这使您可以轻松测试数据库。

数据库：

作为数据库持有者，是关系数据的主要访问点。它必须用@Database注释并扩展RoomDatabase。它还包含并返回 Dao（数据库访问对象）。

在这里插入图片描述

三：在 Android 应用程序中实现Room数据库

第一步：创建一个 Empty Activity 项目

    创建一个空的活动项目，并选择Kotlin作为语言。

第二步：添加所需的依赖项

    将以下依赖添加到应用级gradle 文件中。通过转到

    ProjectName -> src -> build.gradle.

dependencies {
    val room_version = "2.4.3"

    implementation("androidx.room:room-runtime:$room_version")
    annotationProcessor("androidx.room:room-compiler:$room_version")

    // To use Kotlin annotation processing tool (kapt)
    kapt("androidx.room:room-compiler:$room_version")
    // To use Kotlin Symbol Processing (KSP)
    ksp("androidx.room:room-compiler:$room_version")

    // optional - Kotlin Extensions and Coroutines support for Room
    implementation("androidx.room:room-ktx:$room_version")

    // optional - RxJava2 support for Room
    implementation("androidx.room:room-rxjava2:$room_version")

    // optional - RxJava3 support for Room
    implementation("androidx.room:room-rxjava3:$room_version")

    // optional - Guava support for Room, including Optional and ListenableFuture
    implementation("androidx.room:room-guava:$room_version")

    // optional - Test helpers
    testImplementation("androidx.room:room-testing:$room_version")

    // optional - Paging 3 Integration
    implementation("androidx.room:room-paging:2.5.0-beta02")
}

第三步：创建数据实体

    创建一个名为 User.kt的示例数据类。

    并调用以下代码，其中包含实体User作为实体，它表示行，first_ name、last_name、 age 表示表的列名。

import androidx.room.ColumnInfo
import androidx.room.Entity
import androidx.room.PrimaryKey
 
@Entity
data class User(
	@PrimaryKey(autoGenerate = true) val uid: Int,
	@ColumnInfo(name = "name") val firstName: String?,
	@ColumnInfo(name = "city") val lastName: String?
)

第四步：创建数据访问对象(DA0)：

    现在创建一个名为UserDao.kt的接口。

    并调用以下代码，它提供了应用程序用来与用户交互的各种方法。

import androidx.room.Dao
import androidx.room.Delete
import androidx.room.Insert
import androidx.room.Query
 
@Dao
interface UserDao {
	@Query("SELECT * FROM user")
	fun getAll(): List<User>
 
	@Query("SELECT * FROM user WHERE uid IN (:userIds)")
	fun loadAllByIds(userIds: IntArray): List<User>
 
	@Insert
	fun insertAll(vararg users: User)
 
	@Delete
	fun delete(user: User)
}

第五步：创建数据库

    现在创建定义实际应用程序数据库的数据库，它是应用程序持久数据的主要访问点。这个类必须满足：

    1、类必须是抽象的。

    2、该类应该用@Database注释。

    3、数据库类必须定义一个带有零参数的抽象方法并返回一个 DAO 实例。

    现在在AppDatabase.kt文件中调用以下代码。

import androidx.room.Database
import androidx.room.RoomDatabase
  
@Database(entities = arrayOf(User::class), version = 1)
abstract class UserDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao
}

第六步：Room 数据库的使用

在MainActivity.kt文件中，我们可以通过为数据库提供自定义名称来创建数据库

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import androidx.room.Room
 
class MainActivity : AppCompatActivity() {
 
	// application's Database name
	private val DATABASE_NAME: String = "USER_DATABASE"
 
	override fun onCreate(savedInstanceState: Bundle?) {
		super.onCreate(savedInstanceState)
		setContentView(R.layout.activity_main)
 
		// get the instance of the application's database
		val db = Room.databaseBuilder(
			applicationContext, UserDatabase::class.java, DATABASE_NAME
		).build()
 
		// create instance of DAO to access the entities
		val userDao = db.userDao()
 
		// using the same DAO perform the Database operations
		val users: List<User> = userDao.getAll()
	}
}