Jetpack组件之 Room操作数据库
看了google出品的jetpack库,感觉还是很不错的,这里开始我们的Jetpack学习之旅
本文所有源码收录在 --> https://github.com/ddssingsong/AnyTool
简介
官方:
Room持久性库在sqlite上提供了一个抽象层,以便在充分利用sqlite的强大功能的同时,更可靠地访问数据库。
该库帮助您在运行应用程序的设备上创建应用程序数据的缓存。这个缓存是应用程序的唯一真实来源,允许用户查看应用程序中关键信息的一致副本,而不管用户是否有互联网连接。
本质:
其实就是一个ORM库,里面用了大量注解,然后还可以配合jetpack其他组件一起使用。
主要类
- @Database:@Database用来注解类,并且注解的类必须是继承自RoomDatabase的抽象类。该类主要作用是创建数据库和创建Daos(data access objects,数据访问对象)。
- @Entity:@Entity用来注解实体类,@Database通过entities属性引用被@Entity注解的类,并利用该类的所有字段作为表的列名来创建表。
- @Dao:@Dao用来注解一个接口或者抽象方法,该类的作用是提供访问数据库的方法。在使用@Database注解的类中必须定一个不带参数的方法,这个方法返回使用@Dao注解的类
依赖
implementation 'android.arch.persistence.room:runtime:1.1.1'
annotationProcessor 'android.arch.persistence.room:compiler:1.1.1'
// test
androidTestImplementation "android.arch.persistence.room:testing:1.1.1"
定义实体类
使用@Entity注解实体类,这里定义两个类UserInfo和MessageBean
- @PrimaryKey :至少定义一个字段作为主键
- 如果自增长ID 使用设置@PrimaryKey的 autoGenerate 属性
- 使用组合主键 使用@Entity 的@primaryKeys属性
- Room 默认使用字段名成作为列名,要修改使用 @ColumnInfo(name = “***”)
- 使用 @Entity 的indices 属性,来添加索引
- 外键约束@ForeignKey
UserInfo
// @Entity(primaryKeys = {"userId", "userName"}) // 组合主键
// @Entity(indices = {@Index(name = "userName", value = {"name"}), @Index(name = "email", value = {"email"})}) // 创建索引
@Entity(tableName = "user_info")
public class UserInfo {
@PrimaryKey
@ColumnInfo(name = "userId")
private long userId;
@ColumnInfo(name = "userName")
private String userName;
@ColumnInfo(name = "nickName")
private String nickName;
@ColumnInfo(name = "avatar")
private String avatar;
@ColumnInfo(name = "email")
private String email;
}
MessageBean
// 外键的写法
//@Entity(foreignKeys = {
// @ForeignKey(entity = UserInfo.class, parentColumns = {"userId"}, childColumns = // {"userId"}),
// @ForeignKey(entity = UserInfo.class, parentColumns = {"userId"}, childColumns = // {"fromId"})})
@Entity(tableName = "message")
public class MessageBean {
@ColumnInfo(name = "msgId")
private long msgId;
@ColumnInfo(name = "userId")
private long userId;
@ColumnInfo(name = "fromId")
private long fromId;
@ColumnInfo(name = "content")
private String content;
@ColumnInfo(name = "mediaFilePath")
private String mediaFilePath;
@ColumnInfo(name = "updateTime")
private long updateTime;
@ColumnInfo(name = "msgType")
private int msgType;
访问数据
定义Dao核心数据,主要用于数据库的增删改查
@Dao
public interface UserDao {
@Query("Select * from user_info")
List<UserInfo> getAll();
@Insert
void insert(UserInfo users);
@Delete
void delete(UserInfo users);
@Update
void update(UserInfo users);
}
创建数据库
@Database注解主要使用在数据持有者类上,这里注解类需要满足一些条件
- 必须继承RoomDatabase
- 至少包含一个带@Dao注释的类的抽象方法
- entities 参数中包含数据库关联的实体列表
- 初始化实例耗费时间比较长,需要用单例来初始化一个实例
@Database(entities = {UserInfo.class, MessageBean.class}, version = 1)
public abstract class AppDataBase extends RoomDatabase {
// 用户信息操作类
public abstract UserDao getUserDao();
// 消息列表操作类
public abstract MessageDao getMessageDao();
}
使用单例向外提供方法
private static final String DB_NAME = "room_db";
// 静态内部类
private static class Holder {
private volatile static AppDataBase appDataBase = null;
static AppDataBase getInstance(Context context) {
if (appDataBase == null) {
synchronized (AppDataBase.class) {
if (appDataBase == null) {
appDataBase = buildDatabase(context);
}
}
}
return appDataBase;
}
private static AppDataBase buildDatabase(Context context) {
return Room.databaseBuilder(context, AppDataBase.class, DB_NAME)
.addCallback(new RoomDatabase.Callback() {
@Override
public void onCreate(@NonNull SupportSQLiteDatabase db) {
super.onCreate(db);
// 第一次创建数据库会回调此方法,可以做初始化数据之类的操作
Log.e(DB_NAME, "room_db 数据库第一次创建成功!");
}
@Override
public void onOpen(@NonNull SupportSQLiteDatabase db) {
super.onOpen(db);
Log.e(DB_NAME, "room_db 数据库 onOpen!");
}
})
.build();
}
}
// 向外提供方法
public static AppDataBase getAppDataBase(Context context) {
return Holder.getInstance(context);
}
插入数据
UserInfo userInfo = new UserInfo();
userInfo.setUserId(new Random().nextInt(10000));
userInfo.setUserName("大大帅");
userInfo.setNickName("屠~~");
userInfo.setAvatar("jpeg");
userInfo.setEmail("android_shuai@163.com");
AppDataBase.getAppDataBase(RoomActivity.this).getUserDao().insert(userInfo);
删除数据
UserInfo userInfo = new UserInfo();
userInfo.setUserId(4934); // 主键
AppDataBase.getAppDataBase(RoomActivity.this).getUserDao().delete(userInfo);
更新数据
UserInfo userInfo = AppDataBase.getAppDataBase(RoomActivity.this).getUserDao().getUser();
userInfo.setUserName("小小帥");
AppDataBase.getAppDataBase(RoomActivity.this).getUserDao().update(userInfo);
未完待续…
Tips
本文所有代码收录在:https://github.com/ddssingsong/AnyTool