文章目錄
一、簡介
Room 是 Google 官方推出的數據庫 ORM 框架。ORM 是指 Object Relational Mapping，即對象關係映射，也就是將關係型數據庫映射爲面向對象的語言。使用 ORM 框架，我們就可以用面向對象的思想操作關係型數據庫，不再需要編寫 SQL 語句。
二、導入
apply plugin: 'kotlin-kapt'
dependencies {
...
implementation 'androidx.room:room-runtime:2.2.5'
kapt 'androidx.room:room-compiler:2.2.5'
}
三、使用
Room 的使用可以分爲三步：
- 創建 Entity 類：也就是實體類，每個實體類都會生成一個對應的表，每個字段都會生成對應的一列。
- 創建 Dao 類：Dao 是指
Data Access Object，即數據訪問對象，通常我們會在這裏封裝對數據庫的增刪改查操作，這樣的話，邏輯層就不需要和數據庫打交道了，只需要使用 Dao 類即可。 - 創建 Database 類：定義數據庫的版本，數據庫中包含的表、包含的 Dao 類，以及數據庫升級邏輯。
3.1 創建 Entity 類
新建一個 User 類，並添加 @Entity 註解，使 Room 爲此類自動創建一個表。在主鍵上添加 @PrimaryKey(autoGenerate = true) 註解，使得 id 自增，不妨將這裏的主鍵 id 記作固定寫法。
@Entity
data class User(var firstName: String, var lastName: String, var age: Int) {
@PrimaryKey(autoGenerate = true)
var id: Long = 0
}
3.2 創建 Dao 類
創建一個接口類 UserDao，並在此類上添加 @Dao 註解。增刪改查方法分別添加 @Insert、@Delete、@Update、@Query 註解，其中，@Query 需要編寫 SQL 語句才能實現查詢。Room 會自動爲我們生成這些數據庫操作方法。
@Dao
interface UserDao {
@Insert
fun insertUser(user: User): Long
@Update
fun updateUser(newUser: User)
@Query("select * from user")
fun loadAllUsers(): List<User>
@Query("select * from User where age > :age")
fun loadUsersOlderThan(age: Int): List<User>
@Delete
fun deleteUser(user: User)
@Query("delete from User where lastName = :lastName")
fun deleteUserByLastName(lastName: String): Int
}
@Query 方法不僅限於查找，還可以編寫我們自定義的 SQL 語句，所以可以用它來執行特殊的 SQL 操作，如上例中的 deleteUserByLastName 方法所示。
3.3 創建 Database 抽象類
新建 AppDatabase 類，繼承自 RoomDatabase 類，添加 @Database 註解，在其中聲明版本號，包含的實體類。並在抽象類中聲明獲取 Dao 類的抽象方法。
@Database(version = 1, entities = [User::class])
abstract class AppDatabase : RoomDatabase() {
abstract fun userDao(): UserDao
companion object {
private var instance: AppDatabase? = null
@Synchronized
fun getDatabase(context: Context): AppDatabase {
return instance?.let { it }
?: Room.databaseBuilder(context.applicationContext, AppDatabase::class.java, "app_database")
.build()
.apply { instance = this }
}
}
}
在 getDatabase 方法中，第一個參數一定要使用 applicationContext，以防止內存泄漏，第三個參數表示數據庫的名字。
3.4 測試
佈局中只有四個 id 爲 btnAdd，btnDelete，btnUpdate，btnQuery 的按鈕，故不再給出佈局代碼。
MainActivity 代碼如下：
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
val userDao = AppDatabase.getDatabase(this).userDao()
val teacher = User("lin", "guo", 66)
val student = User("alpinist", "wang", 3)
btnAdd.setOnClickListener {
thread {
teacher.id = userDao.insertUser(teacher)
student.id = userDao.insertUser(student)
}
}
btnDelete.setOnClickListener {
thread {
userDao.deleteUser(student)
}
}
btnUpdate.setOnClickListener {
thread {
teacher.age = 666
userDao.updateUser(teacher)
}
}
btnQuery.setOnClickListener {
thread {
Log.d("~~~", "${userDao.loadAllUsers()}")
}
}
}
}
每一步操作我們都開啓了一個新線程來操作，這是由於數據庫操作涉及到 IO，所以不推薦在主線程執行。在開發環境中，我們也可以通過 allowMainThreadQueries() 方法允許主線程操作數據庫，但一定不要在正式環境使用此方法。
Room.databaseBuilder(context.applicationContext, AppDatabase::class.java, "app_database")
.allowMainThreadQueries()
.build()
點擊 btnAdd，再點擊 btnQuery，Log 如下：
~~~: [User(firstName=lin, lastName=guo, age=66), User(firstName=alpinist, lastName=wang, age=3)]
點擊 btnDelete，再點擊 btnQuery，Log 如下：
~~~: [User(firstName=lin, lastName=guo, age=66)]
點擊 btnUpdate，再點擊 btnQuery，Log 如下：
~~~: [User(firstName=lin, lastName=guo, age=666)]
由此可見，我們的增刪改查操作都成功了。
四、數據庫升級
4.1 簡單升級
使用 fallbackToDestructiveMigration() 可以簡單粗暴的升級，也就是直接丟棄舊版本數據庫，然後創建最新的數據庫
Room.databaseBuilder(context.applicationContext, AppDatabase::class.java, "app_database")
.fallbackToDestructiveMigration()
.build()
注：此方法過於暴力，開發階段可使用，不可在正式環境中使用，因爲會導致舊版本數據庫丟失。
4.2 規範升級
4.2.1 新增一張表
創建 Entity 類
@Entity
data class Book(var name: String, var pages: Int) {
@PrimaryKey(autoGenerate = true)
var id: Long = 0
}
創建 Dao 類
@Dao
interface BookDao {
@Insert
fun insertBook(book: Book)
@Query("select * from Book")
fun loadAllBooks(): List<Book>
}
修改 Database 類：
@Database(version = 2, entities = [User::class, Book::class])
abstract class AppDatabase : RoomDatabase() {
abstract fun userDao(): UserDao
abstract fun bookDao(): BookDao
companion object {
private var instance: AppDatabase? = null
private val MIGRATION_1_2 = object : Migration(1, 2) {
override fun migrate(database: SupportSQLiteDatabase) {
database.execSQL(
"""
create table Book (
id integer primary key autoincrement not null,
name text not null,
pages integer not null)
""".trimIndent()
)
}
}
@Synchronized
fun getDatabase(context: Context): AppDatabase {
return instance?.let { it }
?: Room.databaseBuilder(context.applicationContext, AppDatabase::class.java, "app_database")
.addMigrations(MIGRATION_1_2)
.build()
.apply { instance = this }
}
}
}
注：這裏的修改有：
- version 升級
- 將 Book 類添加到 entities 中
- 新增抽象方法 bookDao
- 創建
Migration對象，並將其添加到 getDatabase 的 builder 中
現在如果再操作數據庫，就會新增一張 Book 表了。
4.2.2 修改一張表
比如在 Book 中新增 author 字段
@Entity
data class Book(var name: String, var pages: Int, var author: String) {
@PrimaryKey(autoGenerate = true)
var id: Long = 0
}
修改 Database，增加版本 2 到 3 的遷移邏輯：
@Database(version = 3, entities = [User::class, Book::class])
abstract class AppDatabase : RoomDatabase() {
abstract fun userDao(): UserDao
abstract fun bookDao(): BookDao
companion object {
private var instance: AppDatabase? = null
private val MIGRATION_1_2 = object : Migration(1, 2) {
override fun migrate(database: SupportSQLiteDatabase) {
database.execSQL(
"""
create table Book (
id integer primary key autoincrement not null,
name text not null,
pages integer not null)
""".trimIndent()
)
}
}
private val MIGRATION_2_3 = object : Migration(2, 3) {
override fun migrate(database: SupportSQLiteDatabase) {
database.execSQL(
"""
alter table Book add column author text not null default "unknown"
""".trimIndent()
)
}
}
@Synchronized
fun getDatabase(context: Context): AppDatabase {
return instance?.let { it }
?: Room.databaseBuilder(context.applicationContext, AppDatabase::class.java, "app_database")
.addMigrations(MIGRATION_1_2, MIGRATION_2_3)
.build()
.apply { instance = this }
}
}
}
注：這裏的修改有：
- version 升級
- 創建
Migration對象，並將其添加到 getDatabase 的 builder 中
4.3 測試
修改 MainActivity：
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
val bookDao = AppDatabase.getDatabase(this).bookDao()
btnAdd.setOnClickListener {
thread {
bookDao.insertBook(Book("第一行代碼", 666, "guolin"))
}
}
btnQuery.setOnClickListener {
thread {
Log.d("~~~", "${bookDao.loadAllBooks()}")
}
}
}
}
點擊 btnAdd，再點擊 btnQuery，Log 如下：
~~~: [Book(name=第一行代碼, pages=666, author=guolin)]
這就說明我們對數據庫的兩次升級都成功了。