網站首頁 編程語言 正文
簡介
Room 是 Google 官方推出的數據庫 ORM 框架。ORM 是指?Object Relational Mapping,即對象關系映射,也就是將關系型數據庫映射為面向對象的語言。使用 ORM 框架,我們就可以用面向對象的思想操作關系型數據庫,不再需要編寫 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 創建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: 用來設置數據庫中表名字。如果不設置這個值的話,默認是類的名字
- indices: 用來設置索引,索引用于提高數據庫表的數據訪問速度的,有單列索引和組合索引
- inheritSuperIndices: 父類的索引是否會自動被當前類繼承
- primaryKeys: 用來設置主鍵,如果這個主鍵的值可以唯一確定這個對象,就可以只設置一個主鍵。如果一個字段值不能夠唯一確定對象,就需要復合主鍵,這里primaryKeys可以設置數組;另外每一個Entity都需要設置一個主鍵,如果父類和子類都設置了主鍵,則子類的主鍵會覆蓋父類的主鍵
- foreignKeys: 用來設置外鍵,也就是FOREIGN KEY約束。因為Sqlite數據庫屬于關系型數據庫,所以表于表之間會有關系存在,那么這個屬性值就用來聯系兩個表單之間的關系;如上CommentEntity中設置了外鍵為AppEntity中的packageName
- ignoredColumns: 被忽略的字段
類中還使用了ColumnInfo注解; 其中的屬性值name用來標記的是表中一個字段在數據庫中的存儲的字段值,如果不設置的話默認為聲明的字段的值
另外還有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等可觀察的數據,操作起來是非常方便的
當我們同步代碼之后會在generated中生成一個xxx_Impl.java對象,里面將我們聲明的接口方法都做了實現,不需要我們自己處理了
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,以及是否導出Schema等屬性值
這個類是要繼承RoomDatabase的,一般將這個類使用單例的形式提供使用; 并且采用建造者模式創建對象,我們可以將數據的獲取放在某一個地方,這里是放在了數據庫的onCreate方法中,這里采用的是WorkManager的方式,如下所示
5 獲取數據
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的使用不是這一節的重點,它的使用比較簡單,但是源碼分析卻是比較復雜的;后面會單獨的進行講解
6 最終使用
viewModel.apps.observe(viewLifecycleOwner, Observer {
if (it.isNullOrEmpty()) {
binding.loading = true
} else {
binding.loading = false
adapter.setList(it)
}
binding.executePendingBindings()
})
調用了上述的代碼就將我們的數據和生命周期僅僅綁定在一起,并且如果數據發生變化的話,會立刻回調我們更新UI的代碼,就達到了我們的目的
原文鏈接:https://blog.csdn.net/m0_70748845/article/details/126158364
相關推薦
- 2022-11-19 springboot整合使用云服務器上的Redis方法_Redis
- 2022-10-10 scrapy框架ItemPipeline的使用_python
- 2023-01-23 使用Docker部署Dashdot服務器儀表盤的步驟_docker
- 2022-04-25 C#使用NPOI讀取excel轉為DataSet_C#教程
- 2022-03-16 .Net?6中WebApplicationBuilder介紹和用法_自學過程
- 2022-06-22 關于Metalama使用Fabric操作項目或命名空間的問題_實用技巧
- 2022-03-22 C++對象與繼承使用中一些問題介紹_C 語言
- 2022-02-01 通過url路徑下載服務器文件
- 最近更新
-
- window11 系統安裝 yarn
- 超詳細win安裝深度學習環境2025年最新版(
- Linux 中運行的top命令 怎么退出?
- MySQL 中decimal 的用法? 存儲小
- get 、set 、toString 方法的使
- @Resource和 @Autowired注解
- Java基礎操作-- 運算符,流程控制 Flo
- 1. Int 和Integer 的區別,Jav
- spring @retryable不生效的一種
- Spring Security之認證信息的處理
- Spring Security之認證過濾器
- Spring Security概述快速入門
- Spring Security之配置體系
- 【SpringBoot】SpringCache
- Spring Security之基于方法配置權
- redisson分布式鎖中waittime的設
- maven:解決release錯誤:Artif
- restTemplate使用總結
- Spring Security之安全異常處理
- MybatisPlus優雅實現加密?
- Spring ioc容器與Bean的生命周期。
- 【探索SpringCloud】服務發現-Nac
- Spring Security之基于HttpR
- Redis 底層數據結構-簡單動態字符串(SD
- arthas操作spring被代理目標對象命令
- Spring中的單例模式應用詳解
- 聊聊消息隊列,發送消息的4種方式
- bootspring第三方資源配置管理
- GIT同步修改后的遠程分支