之前我们学习了SQLite数据库的使用方法,不过当时仅仅是使用了一些原生的API来进行数据的增删改查操作。这些原生API虽然简单易用,但是如果放到大型项目当中的话,会非常容易让项目的代码变得混乱,除非你进行了很好的封装,为此市面上出现了诸多专门为Android数据库设计的ORM框架。
ORM也叫对象关系映射。简单来说,我们使用的编程语言是面向对象语言,而使用的数据库则是关系数据库,将面向对象的语言和面向关系的数据库之间建立一种映射关系,这就是ORM了。
ORM赋予我们一个强大的功能,就是可以用面向对象的思维来和数据库进行交互,绝大多数情况下不用再和SQL语言打交道了,同时也不用担心操作数据库的逻辑会让项目的整体代码变得混乱。Android官方推出了一个ORM框架,并把它加入了Jetpack当中,就是我们今天的重点Room。
它主要由Entity、Dao和Database这3部分组成,每个部分都有明确的职责,详细说明如下。
plugins {
id 'com.android.application'
id 'org.jetbrains.kotlin.android'
id 'kotlin-kapt'
}
dependencies {
...
implementation 'androidx.room:room-runtime:2.1.0'
kapt "androidx.room:room-compiler:2.1.0"
}
@Entity注解将User声明成一个实体类, @PrimaryKey注解将id设置为主键,autoGenerate = true使得主键的值是自动的。
@Entity
data class User(var firstName: String, var lastName: String, var age: Int) {
@PrimaryKey(autoGenerate = true)
var id: Long = 0
}
数据库操作通常有增删改查这四种,因此Room也提供了@Insert,@Delete,@Update和@Query这四种相应的注解。
@Dao
interface UserDao {
@Insert
fun insertUser(user: User): Long
@Update
fun updateUser(newUser: User)
@Query("select * from User")
fun loadAllUsers(): List
@Query("select * from User where age > :age")
fun loadUsersOlderThan(age: Int): List
@Delete
fun deleteUser(user: User)
@Query("delete from User where lastName = :lastName")
fun deleteUserByLastName(lastName: String): Int
}
只需要定义好3个部分的内容:数据库的版本号,包含哪些实体类,以及提供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 {
instance?.let {
return it
}
return Room.databaseBuilder(context.applicationContext, AppDatabase::class.java, "app_database").build().apply {
instance = this
}
}
}
}
val user1 = User("Tom", "Brady", 40)
val userDao = AppDatabase.getDatabase(this).userDao()
insertbutton.setOnClickListener{
thread{
userDao.insertUser(user1)
}
}
deletebutton.setOnClickListener{
thread{
userDao.deleteUserByLastName("Brady")
}
}
由于数据库操作属于耗时操作,Room默认是不允许在主线程中进行数据库操作的,因此上诉代码中我们将增减改查的功能放在子线程中。不过在测试中为了方便,可以加入allowMainThreadQueries()方法,这样Room就允许在主线程上进行数据库操作了。
Room.databaseBuilder(
context.applicationContext,
WordDatabase::class.java, "word_database"
).allowMainThreadQueries()
.build()
.apply {
instance = this
}
加入fallbackToDestructiveMigration()方法,只要数据库升级,Room就会将当前的数据销毁,然后再重新创建,副作用就是之前数据库中的所有数据就全部丢失。
Room.databaseBuilder(
context.applicationContext,
WordDatabase::class.java, "word_database"
).allowMainThreadQueries().fallbackToDestructiveMigration()
.build()
.apply {
instance = this
}
创建Book的实体类
@Entity
data class Book(var name: String, var pages: Int) {
@PrimaryKey(autoGenerate = true)
var id: Long = 0
}
创建BookDao接口
@Dao
interface UserDao {
@Insert
fun insertBook(book:Book): Long
@Query("select * from Book")
fun loadAllBooks(): List
}
修改AppDatabase中的代码
@Database(version = 2, entities = [User::class,Book::class])
abstract class AppDatabase : RoomDatabase() {
abstract fun bookDao(): BookDao
abstract fun userDao(): UserDao
companion object {
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)")
}
}
private var instance: AppDatabase? = null
@Synchronized
fun getDatabase(context: Context): AppDatabase {
instance?.let {
return it
}
return Room.databaseBuilder(context.applicationContext, AppDatabase::class.java, "app_database").addMigrations(MIGRATION_1_2)
.build().apply {
instance = this
}
}
}
}
Book实体类中添加作者字段
@Entity
data class Book(var name: String, var pages: Int,var author:String) {
@PrimaryKey(autoGenerate = true)
var id: Long = 0
}
@Database(version = 3, entities = [User::class,Book::class])
abstract class AppDatabase : RoomDatabase() {
...
companion object {
...
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'")
}
}
private var instance: AppDatabase? = null
@Synchronized
fun getDatabase(context: Context): AppDatabase {
instance?.let {
return it
}
return Room.databaseBuilder(context.applicationContext, AppDatabase::class.java, "app_database").addMigrations(MIGRATION_1_2,MIGRATION_2_3)
.build().apply {
instance = this
}
}
}
}