在JetPack系列当中，Room也是一个非常重要的组件。作为一个ORM库，其在原生的SQLite数据库上面进行了封装，以便更好的提供服务。
Room的重要组件
- @Entity：@Entity用来注解实体类，其代表的是一张数据库表，通常情况下@Entity注解中我们传入了一个参数 tableName用来指定表的名称,如果不传默认类名为表名。
(1）@PrimaryKey注解用来标注表的主键，并且使用autoGenerate = true 来指定了主键自增长。
(2）@ColumnInfo注解用来标注表对应的列的信息比如表名、默认值等等。
(3）@Ignore 注解顾名思义就是忽略这个字段，使用了这个注解的字段将不会在数据库中生成对应的列信息。也可以使用@Entity注解中的 ignoredColumns 参数来指定，效果是一样的。 - @Dao：@Dao用来注解一个接口或者抽象方法，该类的作用是提供访问数据库的方法。即通过
@Query、@Insert、@Delete、@Update来执行数据库的增删改查操作。 - @Database：@Database用来注解类，并且注解的类必须是继承自RoomDatabase的抽象类。该类主要作用是创建数据库和创建Daos（data access objects，数据访问对象）。
Room的使用
implementation "androidx.room:room-runtime:2.2.5"
kapt "androidx.room:room-compiler:2.2.5"
/**
* @author: zhoufan
* @date: 2021/9/2 10:54
*
* (1) @Entity注解中我们传入了一个参数 tableName用来指定表的名称,如果不传默认类名为表名
*（2）@PrimaryKey注解用来标注表的主键，并且使用autoGenerate = true 来指定了主键自增长
*（3）@ColumnInfo注解用来标注表对应的列的信息比如表名、默认值等等
*（4）@Ignore 注解顾名思义就是忽略这个字段，使用了这个注解的字段将不会在数据库中生成对应的列信息。也可以使用@Entity注解中的 ignoredColumns 参数来指定，效果是一样的
*/
@Entity(tableName = "users")
class User(
@PrimaryKey(autoGenerate = true) var userId: Long,
@ColumnInfo(name = "user_name") var userName: String,
@ColumnInfo(defaultValue = "china") var address: String
)
/**
* @author: zhoufan
* @date: 2021/9/2 11:00
*/
@Dao
interface UserDao {
@Query("select * from users where userId = :id")
fun getUserById(id: Long): User
@Query("select * from users")
fun getAllUsers(): List<User>
// 参数onConflict，表示的是当插入的数据已经存在时候的处理逻辑，有三种操作逻辑：REPLACE、ABORT和IGNORE。
// 如果不指定则默认为ABORT终止插入数据。这里我们将其指定为REPLACE替换原有数据。
@Insert(onConflict = OnConflictStrategy.REPLACE)
fun addUser(user: User)
@Delete
fun deleteUserByUser(user: User)
@Update
fun updateUserByUser(user: User)
// 上面说的 @Query 查询接受的参数是一个字符串，所以像删除或者更新我们也可以使用
// @Query 注解来使用SQL语句来直接执行。比如根据userid来查询某个用户或者根据userid更新某个用户的姓名：
@Query("delete from users where userId = :id ")
fun deleteUserById(id: Long)
@Query("update users set user_name = :updateName where userID = :id")
fun update(id: Long, updateName: String)
}
/**
* @author: zhoufan
* @date: 2021/9/2 11:07
* (1) 使用entities来映射相关的实体类
* (2) version来指明当前数据库的版本号
* (3) 使用了单例模式来返回Database，以防止新建过多的实例造成内存的浪费
*（4）Room.databaseBuilder(context,klass,name).build()来创建Database，
* 其中第一个参数为上下文，
* 第二个参数为当前Database的class字节码文件，
* 第三个参数为数据库名称
* 注意事项：默认情况下Database是不可以在主线程中进行调用的。
* 因为大部分情况，操作数据库都还算是比较耗时的动作。
* 如果需要在主线程调用则使用allowMainThreadQueries进行说明。
*/
@Database(entities = [User::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
abstract fun userDao(): UserDao
companion object {
private var instance: AppDatabase? = null
fun getInstance(context: Context): AppDatabase {
if (instance == null) {
instance = Room.databaseBuilder(
context.applicationContext,
AppDatabase::class.java,
"user.db"
).allowMainThreadQueries().build()
}
return instance as AppDatabase
}
}
}
class RoomActivity : AppCompatActivity() {
private var userDao: UserDao? = null
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_room)
userDao = AppDatabase.getInstance(this).userDao()
room_insert.setOnClickListener {
insertData()
}
room_query.setOnClickListener {
queryAllUsers()
}
}
// 插入数据
fun insertData() {
for (i in 0..10) {
val user = User(userId = i.toLong(), userName = "jack$i", address = "sh$i")
userDao?.addUser(user)
}
}
// 查询数据
fun queryAllUsers(){
userDao?.getAllUsers()?.forEach {
Log.e("room", "==query==${it.userId},${it.userName},${it.address}")
}
}
}
打印结果.png
Entity
Room会利用@Entity注解的类的所有字段来创建表的列，如果某些字段不希望存储的话，使用@Ignore注解该字段即可。
@Entity
class User {
@PrimaryKey
public int id;
public String firstName;
public String lastName;
@Ignore
Bitmap picture;
}
默认情况下，Room使用类名作为表名，使用字段名作为列名。我们可以通过@Entity的tableName属性定义自己的表名，通过@ColumnInfo的name属性定义自己的列名。
@Entity(tableName = "users")
class User {
@PrimaryKey
public int id;
@ColumnInfo(name = "first_name")
public String firstName;
@ColumnInfo(name = "last_name")
public String lastName;
@Ignore
Bitmap picture;
}
每一个实体至少定义一个字段作为主键。可以将@PrimaryKey的autoGenerate属性设置为true来设置自动id。如果实体有一个复合的主键，可以使用 @Entity的primaryKeys属性来指定主键。
@Entity(primaryKeys = {"firstName", "lastName"})
class User {
public String firstName;
public String lastName;
}
为数据库添加索引可以加快数据的查询。在Room中可以通过@Entity的indices属性添加索引。
@Entity(indices = {@Index("name")})
class User {
@PrimaryKey
public int id;
public String firstName;
public String address;
@ColumnInfo(name = "last_name")
public String lastName;
}
关系
SQLite是关系型数据库，你可以指定不同对象之间的关系，尽管大多数ORM库允许对象之间相互引用，但Room明确禁止这一点。但是尽管不能使用直接关系，Room仍然能为两个实体之间定义外键。
/**
* @author: zhoufan
* @date: 2021/9/6 10:36
*/
@Entity(foreignKeys = @ForeignKey(entity = User.class,
parentColumns = "user_name",
childColumns = "user_name"))
class Book {
@PrimaryKey
public int bookId;
public String title;
@ColumnInfo(name = "user_name")
public String userName;
}
在使用过程中，如果删除user，所有具有相同userId的book会被全部删除。
使用类型转换器
Room支持字符串和基本数据类型以及他们的包装类，但是如果不是基本数据类型，该如何存储呢？比如我们的User对象有个Date类型的字段birthday，我们该如何存储。Room提供了@TypeConverter可以将不可存储的类型转换为Room可以存储的类型。
public class Converters {
@TypeConverter
public static Date fromTimestamp(Long value) {
return value == null ? null : new Date(value);
}
@TypeConverter
public static Long dateToTimestamp(Date date) {
return date == null ? null : date.getTime();
}
}
上面的例子定义了两个方法，Room可以调用dateToTimestamp方法将Date转化为Long类型进行存储，也可以在查询的时候将获取的Long转换为Date对象。
为了让Room调用该转换器，使用@TypeConverters注解将转换器添加到AppDatabase上。
@Database(entities = [User::class], version = 1)
@TypeConverters(*[Converters::class])
abstract class AppDatabase : RoomDatabase() {
...
}
数据库升级
在app发布以后，我们可能会新增表或者修改原来表的结构，这就需要升级数据库。Room提供了 Migration 类用于迁移数据库，每一个 Migration 需要在构造函数里指定开始版本和结束版本。在运行时，Room会按照提供版本的顺序顺序执行每个Migration的migrate()方法，将数据库升级到最新的版本。
// 更新版本
fun updateDataBaseVersion(context: Context) {
instance =
Room.databaseBuilder(context.applicationContext, AppDatabase::class.java, "user.db")
.addMigrations(object : Migration(1, 2) {
override fun migrate(database: SupportSQLiteDatabase) {
// 执行要修改的数据库操作，比如在这里添加一个新的字段
}
}).allowMainThreadQueries().build()
}
关于Jetpack中Room数据库的操作到这里就结束了，其实无论是SQLite、GreenDao还是Room其实大同小异，多操作几遍就会了。
