干货分享---理清思路更快上手，Android架构组件Room功能详解

2401_84149675

于 2024-04-20 16:36:43 发布

阅读量388

点赞数 4

分类专栏：程序员文章标签： android 架构 oracle

本文链接：https://blog.csdn.net/2401_84149675/article/details/138003354

版权

程序员专栏收录该内容

132 篇文章 0 订阅

订阅专栏

本文详细介绍了如何在Android应用中使用Room框架，包括设计数据库ER图、添加Room依赖、创建实体、DAO、Repository以及数据库迁移等关键步骤。通过NBA球队和球员数据的案例，展示了如何实现实体关系映射和数据操作的全过程。

摘要由CSDN通过智能技术生成

2. 通过一个案例，介绍如何使用 Room

介绍 Room 先从一个真实的案例开始，我们从最开始的 ER 图的设计，到数据库的增删改查操作，到考虑数据库的迁移上线。

总结起来，这个使用 Room 框架的案例要经历以下几个过程：

1. 设计数据库的 ER 图(非必须)；
1. 添加对 Room 的依赖；
1. 创建数据库实体 Entity；
1. 创建数据库访问的 DAO；
1. 创建数据库 Database；
1. 封装数据库与业务逻辑交互的 Repository；
1. 创建数据库中使用到的类型转换器；
1. 考虑数据库迁移；
1. 数据库的测试。

接下来，我们将分别从这几个步骤，介绍 Room 的使用。

2.1 数据库 ER 图

我们要完成将 NBA 的球队和球员信息存储到数据库中，具体涉及到两张表，球队表（team）和球员表（player），为了能够筛选出各项数据指标靠前的球员，我们又创建了一张明星球员表（star），三张表的 ER 图如下：

[图片上传中...(image-456fd4-1594888740960-3)]

其中：

一个球队拥有多名球员；
一名球星属于某支球队，球星表中的球星可以来自多只不同的球队；
球星是从球员中选择出来的。

2.2 添加 Room 的依赖

明确了三张数据表之间的关系之后，我们开始引入 Room，添加依赖关系：

implementation “androidx.room:room-runtime: $roo tP ro j ec t . roo mV ers i o n " im pl e m e n t a t i o n " an d ro i d x . roo m : roo m - k t x :$ rootProject.roomVersion”
kapt “androidx.room:room-compiler:$rootProject.roomVersion”
复制代码

由于 Room框架中使用了注解处理器，因此需要使用 kapt 依赖，需要在 build.gradle 文件中引入 kapt 插件。

apply plugin: ‘kotlin-kapt’
复制代码

如果是 Java工程，需要使用 annotationProcessor 关键字。

这里我们使用官方最新的版本2.1.0。

roomVersion : ‘2.1.0’,
复制代码

2.3 创建实体

开始创建实体（数据表）这里以 Player 为例：

/**

球员表
*/
@Entity(tableName = “player”)
data class PlayerModel(
@ColumnInfo(name = “player_code”) var code: String,
@ColumnInfo(name = “player_country”) var country: String, //国家
@ColumnInfo(name = “player_country_en”) var countryEn: String,//国家英文名称
@ColumnInfo(name = “player_display_name”) var displayName: String,//球员名称
@ColumnInfo(name = “player_display_name_en”) var displayNameEn: String,//球员英文名称
@ColumnInfo(name = “player_dob”) var dob: Calendar = Calendar.getInstance(),//出生日期
…
@ColumnInfo(name = “player_team_name”) var teamName: String,//所属球队
@Embedded var statAverage: StatAverageModel,//平均数据
@Embedded var statTotal: StatTotalModel//总数据
) {
@PrimaryKey(autoGenerate = true)
@ColumnInfo(name = “id”)
var id: Long = 0
}
复制代码

这里用到了几个注解，说明一下：

关于@Embedded的进一步说明，我们的 Player实体中有两个被@Embedded修饰的属性，我们看其中的一个statTotal，它的类型是StatTotalModel，用来描述球员的数据。

/**

总数据
*/
data class StatTotalModel(
var assists: Int,//助攻
var blocks: Int,//盖帽
var defRebs: Int,//防守篮板
var fga: Int,
var fgm: Int,
var fgpct: Float,
var fouls: Int,//犯规
var fta: Int,
var ftm: Int,
var ftpct: Float,
var mins: Int,//上场时间
var offRebs: Int,//进攻篮板
var points: Int,//得分
var rebs: Int,//总篮板
var secs: Int,
var steals: Int,//抢断
var tpa: Int,
var tpm: Int,
var tppct: Float,
var turnovers: Int//失误
)
复制代码

通常情况下将这些数据存储在数据库中有两种方式：

新建一张StatTotalModel表，用 Player 表的 id 作为外键，与 Player表进行一一关联；
将StatTotalModel实体中的字段存储在 Player 表中，这种方式减少了数据表的创建，也减少了联合查询的复杂程度。

如果直接将这些字段打散在 Player 表中，显得不够面向对象，这时就可以使用@Embedded注解，即显得面向对象，又不用再创建数据表，非常的优雅。

除了上面说的注解，Room 框架还包括以下的注解：

2.4 创建 Dao

我们开始创建数据访问对象层 Dao，在这里我们需要定义一些对数据库增删改查的方法。

具体来说，就是创建一个使用@Dao 注释的接口。并在其上声明使用该数据库所需的所有函数，并编写相应的 SQL 查询语句，Room 将为你实现这些函数，并在单次事务中运行它们，Room 支持的查询语句包括：插入、更新、删除和查询。查询语句会在编译时被校验，这意味着，如果你编写了一个无效的应用，你会立刻发现错误。

来看 Player 的 Dao：

@Dao
interface PlayerDao {
@Insert(onConflict = OnConflictStrategy.REPLACE)
fun insertPlayer(player: PlayerModel)

@Delete
fun deletePlayers(players: List)

@Update
fun updatePlayers(players: List)

@Query(“SELECT * FROM player WHERE id=:id”)
fun findPlayerById(id: Long): PlayerModel?
……
}
复制代码

对数据表的增删改查方法对应的注解分别是@Insert、@Delete、@Update和 @Query，其中:

@Insert、@Update 可设置参数onConflict，处理数据冲突时采取的策略，可以设置包括：REPLACE, ROLLBACK, ABORT,FAIL,IGNORE五种策略，其中ROLLBACK和FAIL已经被标记为@Deprecated，这里只介绍三种策略，REPLACE用新的数据行替换旧的数据行；ABORT直接回滚冲突的事务；IGNORE保持现有数据行。
@Query 中声明我们要查询的 SQL 语句，使用@Query不仅成完成查，还能进行增删改的操作。

这些查询都是同步的，也就是说，这些查询将在你触发查询的同一个线程上运行。如果这是主线程，你的应用将崩溃，并显示 IllegalStateException，因此，请使用在 Android 中推荐的线程处理方法，并确保其远离主线程。

当使用 LiveData 或 RxJava 时，Room 也支持异步查询，更重要的是，返回 LiveData 或 Flowable 的查询是可观测的查询。也就是说，每当表格中的数据被更新时，就会收到通知。

@Query(“SELECT * FROM player WHERE id=:id”)
fun findPlayerByIdLD(id: Long): LiveData

@Query(“SELECT * FROM player WHERE player_team_name=:teamName”)
fun findPlayersByTeamLD(teamName: String): LiveData<List>
复制代码

2.5 创建数据库

将实体和 DAO整合在一起的类是 RoomDatabase，先创建一个扩展 RoomDatabase 的抽象类，对它进行注释，声明实体和相应的 DAO。

数据库的创建是一件非常消耗资源的工作，所以我们将数据库设计为单例，避免创建多个数据库对象。另外对数据库的操作都不能放在 UI 线程中完成，否则会出现异常：

Cannot access database on the main thread since it may potentially lock the UI for a long period of time.
复制代码

给出我们设计的数据库：

@Database(entities = [PlayerModel::class, TeamModel::class], version = 1, exportSchema = false)
@TypeConverters(Converters::class)
abstract class NBADatabase : RoomDatabase() {

abstract fun playerDao(): PlayerDao
abstract fun teamDao(): TeamDao

companion object {
@Volatile
private var INSTANCE: NBADatabase? = null

fun getInstance(context: Context): NBADatabase {
return INSTANCE ?: synchronized(this) {
Room.databaseBuilder(
context.applicationContext,
NBADatabase::class.java,
“nba_db”
).addCallback(object : RoomDatabase.Callback() {
override fun onCreate(db: SupportSQLiteDatabase) {
super.onCreate(db)
}

override fun onOpen(db: SupportSQLiteDatabase) {
super.onOpen(db)
}
}).build().also {
INSTANCE = it
}
}
}
}
}
复制代码

在创建数据库时需要完成以下几件工作：

设计成单例模式，避免创建多个数据库对象消耗资源；
创建的数据库类需要继承 RoomDatabase，数据库类声明为抽象类；
需要提供方法来获取数据访问对象层(Dao)对象，方法声明为抽象方法；
数据库类需要使用@Database注解，@Database包括几个参数：entities（数据库包含的数据表，@entities注解修饰的实体），default（数据库包含的视图），version（数据库的版本号），exportSchema（可以理解为开关，如果开关为 true，Room 框架会通过注解处理器将一些数据库相关的schema输出到指定的目录中，默认 true）

2.6 封装 Repository

先给出封装的与 Player 相关的 Repository：

class PlayerRepository(private val playerDao: PlayerDao) {

@WorkerThread
suspend fun insert(players: List) {
playerDao.insertPlayers(players)
}

fun findAllPlayers():List{
return playerDao.findAllPlayers()
}
}
复制代码

这里只定义了两个方法，insert()用来插入数据，findAllPlayers()查询所有的 Player，可以根据业务逻辑的需要，在Repository中添加方法。

最后调用PlayerRepository中的方法，完成将 NBA 球队和球员信息存储到数据库中。

[图片上传中...(image-e423a2-1594888740959-2)]

2.7 类型转换器@TypeConverter

在我们的球员实体PlayerModel中，球员的出生日期 dob类型是 Calendar 类型，但是 SQLite 只支持 5 中类型，分别是NULL、INTEGER、REAL、TEXT和BLOB，这时可以用到@TypeConverters注解。

class Converters {
@TypeConverter
fun calendarToDatestamp(calendar: Calendar): Long = calendar.timeInMillis

@TypeConverter
fun datestampToCalendar(value: Long): Calendar =
Calendar.getInstance().apply { timeInMillis = value }
}
复制代码

在数据库中添加该注解

@TypeConverters(Converters::class)
复制代码

2.8 数据库迁移 Migration

如果要进行数据库迁移操作，需要在 Database 类中执行以下操作：

首先更新你的数据库版本。

@Database(entities = {User.class}, version = 2)
abstract class MyDatabase extends RoomDatabase {
public abstract UserDao getUserDao();
}
复制代码

其次，实现一个 Migration 类，定义如何处理从旧版本到新版本的迁移：

static final Migration MIGRATION_1_2 = new Migration(1, 2)
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则近万的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：Android）

最后

希望本文对你有所启发，有任何面试上的建议也欢迎留言分享给大家。

好了，今天的分享就到这里，如果你对在面试中遇到的问题，或者刚毕业及工作几年迷茫不知道该如何准备面试并突破现状提升自己，对于自己的未来还不够了解不知道给如何规划，来看看同行们都是如何突破现状，怎么学习的，来吸收他们的面试以及工作经验完善自己的之后的面试计划及职业规划。

好了~如果你看到了这里，觉得文章写得不错就给个赞呗？如果你觉得那里值得改进的，请给我留言。一定会认真查询，修正不足。谢谢。

为什么某些人会一直比你优秀，是因为他本身就很优秀还一直在持续努力变得更优秀，而你是不是还在满足于现状内心在窃喜！希望读到这的您能点个小赞和关注下我，以后还会更新技术干货，谢谢您的支持！

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！

[外链图片转存中…(img-rWAbAtdi-1713602176776)]

好了~如果你看到了这里，觉得文章写得不错就给个赞呗？如果你觉得那里值得改进的，请给我留言。一定会认真查询，修正不足。谢谢。

[外链图片转存中…(img-7SQK4pN6-1713602176777)]

为什么某些人会一直比你优秀，是因为他本身就很优秀还一直在持续努力变得更优秀，而你是不是还在满足于现状内心在窃喜！希望读到这的您能点个小赞和关注下我，以后还会更新技术干货，谢谢您的支持！

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！

2401_84149675

关注

4
点赞
踩
8

收藏

觉得还不错? 一键收藏
0
评论
干货分享---理清思路更快上手，Android架构组件Room功能详解

介绍 Room 先从一个真实的案例开始，我们从最开始的 ER 图的设计，到数据库的增删改查操作，到考虑数据库的迁移上线。设计数据库的 ER 图(非必须)；添加对 Room 的依赖；创建数据库实体 Entity；创建数据库访问的 DAO；创建数据库 Database；封装数据库与业务逻辑交互的 Repository；创建数据库中使用到的类型转换器；考虑数据库迁移；数据库的测试。接下来，我们将分别从这几个步骤，介绍 Room 的使用。
复制链接

扫一扫