简介
Room 持久性库在 SQLite 上提供了一个抽象层，以便在充分利用 SQLite 的强大功能的同时，能够流畅地访问数据库。具体来说，Room 具有以下优势：
- 针对 SQL 查询的编译时验证。
- 可最大限度减少重复和容易出错的样板代码的方便注解。
- 简化了数据库迁移路径。
dependencies {
val roomVersion = "2.4.2"
implementation("androidx.room:room-runtime:$roomVersion")
//在java中使用这个编译注解
annotationProcessor("androidx.room:room-compiler:$roomVersion")
//在kotlin 项目中使用这个编译注解
// To use Kotlin annotation processing tool (kapt)
kapt("androidx.room:room-compiler:$roomVersion")
// To use Kotlin Symbolic Processing (KSP)
ksp("androidx.room:room-compiler:$roomVersion")
// optional - Kotlin Extensions and Coroutines support for Room
implementation("androidx.room:room-ktx:$roomVersion")
// optional - RxJava2 support for Room
implementation("androidx.room:room-rxjava2:$roomVersion")
// optional - RxJava3 support for Room
implementation("androidx.room:room-rxjava3:$roomVersion")
// optional - Guava support for Room, including Optional and ListenableFuture
implementation("androidx.room:room-guava:$roomVersion")
// optional - Test helpers
testImplementation("androidx.room:room-testing:$roomVersion")
// optional - Paging 3 Integration
implementation("androidx.room:room-paging:2.5.0-alpha01")
}
Room 包含三个主要组件：
- 数据库类，用于保存数据库并作为应用持久性数据底层连接的主要访问点。
- 数据实体 ，(Entity)用于表示应用的数据库中的表, 一个Entity 对应数据库中的一个表，Entity类时sqlite 表结构对Java类的映射，在Java中，可以被看做一个Model
- 数据访问对象 (DAO)，提供您的应用可用于查询、更新、插入和删除数据库中的数据的方法。
room_architecture.png
总的来说，一个Entity就是一张表，而没张表都需要一个Dao对象，用于对表进行增删改查。Room 数据库在被实例化之后，我们就可以通过数据库实例得到Dao 对象，然后同Dao对象对数据库进行操作。
Room 的具体使用
创建一个表
//设置表名字
@Entity(tableName = "person_table")
data class Person (
//设置主键，并且该字段由 SQLite 自动生成
@PrimaryKey(autoGenerate = true)
/**设置字段名称，类型为INTEGER 类型：
* UNDEFINED ：未定义的类型。 将根据类型进行解析。
* TEXT : 字符串类型
* INTEGER: 整数或者bool类型
* REAL: float 或者 double 类型
* BLOB: 二进制数据类型
*/
@ColumnInfo(name = "id", typeAffinity = ColumnInfo.INTEGER)
val id :Int,
@ColumnInfo(name = "name", typeAffinity = ColumnInfo.TEXT)
val name:String,
@ColumnInfo(name="age", typeAffinity = ColumnInfo.INTEGER)
val age:Int,
/**
* 该类型不会被持久化
* 由于Room 只能识别一个构造器，如果希望多个构造器，可以使用@Ignore 修饰这个构造器，让Roow忽略这个构造器，
*/
@Ignore
val sex:String
)
创建表的处理方法
//定义表的操作
@Dao
interface PersonDao {
//插入一条数据
@Insert
fun insert(p: Person)
//删除一条数据
@Delete
fun delete(p: Person)
//更新一条数据
@Update
fun update(p: Person)
//查询全部数据
@Query("SELECT * FROM person_table")
fun queryAll(): List<Person>
}
创建数据库
@Database(entities = [Person::class], version = 1)
abstract class PersonDatabase : RoomDatabase() {
abstract fun personDao(): PersonDao
companion object {
private var instance: PersonDatabase? = null
fun get(context: Context?): PersonDatabase? {
if (instance == null) {
context?.applicationContext?.let {
instance = Room.databaseBuilder(it, PersonDatabase::class.java, "Sample.db")
.allowMainThreadQueries().build()
}
}
return instance
}
}
}
