Android Roomの使い方を詳しく解説
1: Room の基本的な紹介
Room 是 Android 架构组件的一部分，Room 持久性库在 SQLite
上提供了一个抽象层，以便在充分利用 SQLite 的强大功能的
同时，能够流畅地访问数据库。具体来说，Room 具有以下优势：
- SQL クエリのコンパイル時の検証。
- 反復的でエラーが発生しやすい定型コードを最小限に抑える便利な注釈。
- 簡素化されたデータベース移行パス
2: Room ライブラリは 3 つの主要コンポーネントで構成されます。
実在物：
Entity はデータベース内のテーブルを表し、@Entity の注釈を付ける必要があります。すべてのエンティティには少なくとも 1 つのフィールドが含まれており、主キーを定義する必要があります。
DAO (データベース アクセス オブジェクト):
Room では、データ アクセス オブジェクトを使用してデータにアクセスし、管理できます。DAO は Room の主要コンポーネントであり、アプリケーションのデータベースへのアクセスを提供するメソッドが含まれており、これには @Dao の注釈を付ける必要があります。クエリ ビルダーの代わりに DAO を使用すると、現在のデータや統計などのデータベースのさまざまなコンポーネントを分離できるため、データベースを簡単にテストできます。
データベース:
データベース所有者として、これはリレーショナル データへの主要なアクセス ポイントです。@Database の注釈を付け、RoomDatabase を拡張する必要があります。また、Dao (データベース アクセス オブジェクト) も含まれており、これを返します。
3: Android アプリケーションに Room データベースを実装する
ステップ 1: 空のアクティビティ プロジェクトを作成する
创建一个空的活动项目，并选择Kotlin作为语言。
ステップ 2: 必要な依存関係を追加する
将以下依赖添加到应用级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")
}
ステップ3
创建一个名为 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?
)
ステップ 4: データ アクセス オブジェクト (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)
}
ステップ 5: データベースを作成する
现在创建定义实际应用程序数据库的数据库，它是应用程序持久数据的主要访问点。这个类必须满足：
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
}
ステップ 6: 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()
}
}
著者: 林江鵬
元リンク: https://blog.csdn.net/m0_52768965/article/details/128064067?spm=1001.2014.3001.5501