快捷導(dǎo)航

Android開發(fā)Jetpack組件Room使用講解

更新時間：2022年08月11日 09:18:56 作者：Android技術(shù)棧

Room是一個數(shù)據(jù)庫訪問組件；對SqLite數(shù)據(jù)庫做了友好的封裝，使我們在編碼的時候，只需要注重邏輯的部分即可，數(shù)據(jù)庫就交給Room去流暢的訪問即可

簡介

Room 是 Google 官方推出的數(shù)據(jù)庫 ORM 框架。ORM 是指 Object Relational Mapping，即對象關(guān)系映射，也就是將關(guān)系型數(shù)據(jù)庫映射為面向?qū)ο蟮恼Z言。使用 ORM 框架，我們就可以用面向?qū)ο蟮乃枷氩僮麝P(guān)系型數(shù)據(jù)庫，不再需要編寫 SQL 語句。

Room使用步驟

1 添加依賴

build.gradle {
apply plugin: 'kotlin-kapt'

dependencies {
   kapt "androidx.room:room-compiler:$rootProject.roomVersion"
   implementation "androidx.room:room-runtime:$rootProject.roomVersion"
   }

}

2 創(chuàng)建Entity實體類

@Entity(tableName = "apps")
data class AppEntity(
        @ColumnInfo(name = "packageName") @PrimaryKey val packageName: String,
        @ColumnInfo(name = "app_id") val id: Int,
        @ColumnInfo(name = "versionCode") val versionCode: String,
        @ColumnInfo(name = "versionLabel") val versionLabel: String,
        @ColumnInfo(name = "versionName") val versionName: String,
        @ColumnInfo(name = "description") val description: String,
        @ColumnInfo(name = "icon") val icon: String)
 @Entity(tableName = "comments",
        foreignKeys = [
            ForeignKey(entity = AppEntity::class,
                    parentColumns = ["packageName"],
                    childColumns = ["packageName"],
                    onDelete = ForeignKey.CASCADE)
        ],
    	indices = [Index("packageName")])
class CommentEntity(@PrimaryKey(autoGenerate = true) val id: Int = 0,
                val packageName: String,
                val comment: String = "this is comment for $packageName")

實體類我們采用的是注解Entity來標記，其中有很多屬性：

tableName：用來設(shè)置數(shù)據(jù)庫中表名字。如果不設(shè)置這個值的話，默認是類的名字
indices：用來設(shè)置索引，索引用于提高數(shù)據(jù)庫表的數(shù)據(jù)訪問速度的，有單列索引和組合索引
inheritSuperIndices：父類的索引是否會自動被當(dāng)前類繼承
primaryKeys：用來設(shè)置主鍵，如果這個主鍵的值可以唯一確定這個對象，就可以只設(shè)置一個主鍵。如果一個字段值不能夠唯一確定對象，就需要復(fù)合主鍵，這里primaryKeys可以設(shè)置數(shù)組；另外每一個Entity都需要設(shè)置一個主鍵，如果父類和子類都設(shè)置了主鍵，則子類的主鍵會覆蓋父類的主鍵
foreignKeys：用來設(shè)置外鍵，也就是FOREIGN KEY約束。因為Sqlite數(shù)據(jù)庫屬于關(guān)系型數(shù)據(jù)庫，所以表于表之間會有關(guān)系存在，那么這個屬性值就用來聯(lián)系兩個表單之間的關(guān)系；如上CommentEntity中設(shè)置了外鍵為AppEntity中的packageName
ignoredColumns：被忽略的字段

類中還使用了ColumnInfo注解；其中的屬性值name用來標記的是表中一個字段在數(shù)據(jù)庫中的存儲的字段值，如果不設(shè)置的話默認為聲明的字段的值

另外還有Embedded，表示的是嵌套對象；我們可以把類A放入另外一個類B中，只需要在B中對A使用注解Embedded即可，這樣的話，B就可以正常使用A中所有的屬性值

3 聲明Dao對象

@Dao
interface AppsDao {
    @Query("SELECT * FROM apps")
    fun loadApps(): LiveData<List<AppEntity>>
    @Query("SELECT * FROM apps WHERE packageName = :packageName")
    fun loadApp(packageName: String): LiveData<AppEntity>
    @Insert(onConflict = OnConflictStrategy.REPLACE)
    fun insertAll(apps: List<AppEntity>)
    @Insert(onConflict = OnConflictStrategy.REPLACE)
    fun insert(app: AppEntity)
    @Delete
    fun delete(app: AppEntity)
    @Update
    fun update(app: AppEntity)
}

這個Dao對象的聲明必須使用interface修飾；另外我們看到提供了四種增刪改查的注解，只有查詢的注解需要輸入少量的SQL語句，定義接口的返回值還可以是LiveData等可觀察的數(shù)據(jù)，操作起來是非常方便的

當(dāng)我們同步代碼之后會在generated中生成一個xxx_Impl.java對象，里面將我們聲明的接口方法都做了實現(xiàn)，不需要我們自己處理了

4 聲明Database對象

@Database(entities = [AppEntity::class, CommentEntity::class], version = 1, exportSchema = false)
abstract class AppDatabase : RoomDatabase() {
    abstract fun appsDao(): AppsDao
    abstract fun commentsDao(): CommentsDao
    companion object {
        private const val DATABASE_NAME = "forward-db"
        private val executors: ExecutorService = Executors.newSingleThreadExecutor()
        @Volatile
        private var instance: AppDatabase? = null
        fun getInstance(context: Context): AppDatabase {
            return instance ?: synchronized(this) {
                instance ?: buildDatabase(context.applicationContext).also {
                    instance = it
                }
            }
        }
        private fun buildDatabase(context: Context): AppDatabase {
            return Room.databaseBuilder(context, AppDatabase::class.java, DATABASE_NAME)
                    .addCallback(object : Callback() {
                        override fun onCreate(db: SupportSQLiteDatabase) {
                            executors.execute {
                                Thread.sleep(3000)
                                val request: OneTimeWorkRequest = OneTimeWorkRequestBuilder<AppsWorker>().build()
                                WorkManager.getInstance(context).enqueue(request)
                            }
                        }
                    })
                    .build()
        }
    }
}

使用Database注解需要傳入我們聲明的所有的Entity對象，版本號version，以及是否導(dǎo)出Schema等屬性值

這個類是要繼承RoomDatabase的，一般將這個類使用單例的形式提供使用；并且采用建造者模式創(chuàng)建對象，我們可以將數(shù)據(jù)的獲取放在某一個地方，這里是放在了數(shù)據(jù)庫的onCreate方法中，這里采用的是WorkManager的方式，如下所示

5 獲取數(shù)據(jù)

class AppsWorker(context: Context, workerParameters: WorkerParameters)
    : CoroutineWorker(context, workerParameters) {
    private val TAG by lazy {
        AppsWorker::class.java.simpleName
    }
    override suspend fun doWork(): Result = coroutineScope {
        try {
            applicationContext.assets.open("apps.json").use {
                JsonReader(it.reader()).use { reader ->
                    val appsType = object : TypeToken<List<AppEntity>>() {}.type
                    val appsList: List<AppEntity> = Gson().fromJson(reader, appsType)
                    val comments = DataGenerator.getComments(appsList)
                    val appsDao = RepositoryProvider.providerAppsRepository(applicationContext)
                    val commentDao = RepositoryProvider.providerCommentsRepository(applicationContext)
                    appsDao.insertAll(appsList)
                    commentDao.insertAll(comments)
                }
                Result.success()
            }
        } catch (e: Exception) {
            Result.failure()
        }
    }
    private fun insertData(database: AppDatabase, apps: List<AppEntity>, comments: List<CommentEntity>) {
        database.runInTransaction {
            database.appsDao().insertAll(apps)
            database.commentsDao().insertAll(comments)
        }
    }
}

WorkManager的使用不是這一節(jié)的重點，它的使用比較簡單，但是源碼分析卻是比較復(fù)雜的；后面會單獨的進行講解

6 最終使用

   viewModel.apps.observe(viewLifecycleOwner, Observer {
        if (it.isNullOrEmpty()) {
            binding.loading = true
        } else {
            binding.loading = false
            adapter.setList(it)
        }
        binding.executePendingBindings()
    })

調(diào)用了上述的代碼就將我們的數(shù)據(jù)和生命周期僅僅綁定在一起，并且如果數(shù)據(jù)發(fā)生變化的話，會立刻回調(diào)我們更新UI的代碼，就達到了我們的目的

以上就是Android開發(fā)Jetpack組件Room使用講解的詳細內(nèi)容，更多關(guān)于Android Jetpack組件Room的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: