room数据库最佳实践

特性

1.SQL语句高亮
2. 简单入门
3. 功能强大
4. 数据库监听
5. 支持Kotlin协程/RxJava/Guava

依赖

dependencies{
    val room_version = "2.2.0-rc01"

    implementation("androidx.room:room-runtime:$room_version")
    annotationProcessor "androidx.room:room-compiler:$room_version" 
    // Kotlin 使用 kapt 替代 annotationProcessor (需要在插件中应用kapt)
    //kapt ("androidx.room:room-compiler:2.6.1")

    // 可选 - Kotlin扩展和协程支持
    implementation("androidx.room:room-ktx:$room_version")
}

使用

ROOM会在创建数据库对象时就会创建好所有已注册的数据表结构

创建数据库
创建操作接口
创建数据类: 一般为JSON反序列出的data class

实体类

@Entity(tableName = "todo_item")
data class ToDoItem(
    @PrimaryKey(autoGenerate = true)
    val id: Int = 0,
    val title: String = "",
    val date: String = System.currentTimeMillis().toString(),
    var completed: Boolean = false,
    var archived: Boolean = false
)

Dao接口

@Dao
interface ToDoItemDao {


    @Query("SELECT * FROM todo_item WHERE archived = 0  ORDER BY id DESC")
    fun getAll(): List<ToDoItem>
    @Insert
    suspend fun insert(toDoItem: ToDoItem):Long

    @Update
    suspend fun update(toDoItem: ToDoItem)
}

数据库实体

@Database(entities = [ToDoItem::class], version = 2, exportSchema = false)
abstract class RoomDB : RoomDatabase() {

    abstract fun ToDoItemDao(): ToDoItemDao
    companion object {
        private var INSTANCE: RoomDB? = null

        fun getInstance(context: Context): RoomDB {
            return runBlocking(Dispatchers.IO) {
                var instance = INSTANCE
                if (instance == null) {
                    instance = Room.databaseBuilder(context, RoomDB::class.java, "todo_db")
                        .allowMainThreadQueries()//允许在主线程操作
                        .addCallback(DbCreateCallBack())//增加回调监听
                        .addMigrations(MIGARATION_1_2)//增加数据库迁移
                        .build()
                }
                instance
            }
        }
        val MIGARATION_1_2 = object : Migration(1, 2) {
            override fun migrate(db: SupportSQLiteDatabase) {
                db.execSQL("ALTER TABLE todo_item ADD COLUMN archived INTEGER NOT NULL DEFAULT 0")
            }
        }

        private fun DbCreateCallBack(): RoomDatabase.Callback {
            return object : RoomDatabase.Callback() {
                //第一次创建数据库时调用
                override fun onCreate(db: SupportSQLiteDatabase) {
                    super.onCreate(db)
                    Log.d("First", "first onCreate db version: " + db.version)
                }
            }
        }

    }
}

DQL

ROOM支持查询函数返回四种类型

Single/Mabye/Completable/Observable/Flowable 等RxJava的被观察者
LiveData: JetPack库中的活跃观察者
Flow: Kotlin协程中的流
Cursor: SQLite在Android中最原始的查询结果集, 此返回对象无法监听数据库变化

我不再推荐在项目中使用RxJava, 因为无法方便实现并发并且容易产生回调地域. 这里建议使用协程

@Query("select * from Book")
fun find(): Flow<Array<Book>>

@Query("select * from Book")
fun find(): Observable<Array<Book>>

@Query("select * from Book")
fun find(): LiveData<Array<Book>>

@Query("select * from Book")
fun find(): LiveData<List<Book>> // List 或者 Array都是可以的

@Query("select * from Book")
fun find(): Flow<Array<Book>>

@Query("select * from Book")
fun find(): Cursor