Room是AAC推荐的基于SQLite的ORM数据库框架。通过注解的方式来进行数据库的配置,以及SQL的查询,并且在编译的过程中,会检查SQL以及数据库配置等的正确性,同时也支持外键、事务等。虽然没有ObjectBox,GreenDao等效率高,不过用起来也比较方便。
Room Database
ObjectBox是非SQLite的ORM数据库框架,它自定义了自己的数据库文件,它的文件只有官方提供的工具才能打开,并且对于外键、主键等支持也比较完备,并且效率比Room以及GreenDao等基于SQLite的框架高非常多,不过在真正的产品中使用的话,以后也就不能再升级框架了。
build.gradle
中添加如下配置dependencies {
def room_version = "1.1.1"
implementation "android.arch.persistence.room:runtime:$room_version"
annotationProcessor "android.arch.persistence.room:compiler:$room_version"
// optional - RxJava support for Room
implementation "android.arch.persistence.room:rxjava2:$room_version"
// optional - Guava support for Room, including Optional and ListenableFuture
implementation "android.arch.persistence.room:guava:$room_version"
// Test helpers
testImplementation "android.arch.persistence.room:testing:$room_version"
}
entities
定义在数据库中存储的实体结构version
定义数据库版本(数据库版本升级后续介绍)@Database(entities = { UserData.class }, version = 1)
public abstract class UserDatabase extends RoomDatabase {
public abstract UserDataDao userDataDao();
}
@Entity
定义。 public
或者提供setter
/getter
方法。PrimaryKey
,也可以通过一个integer
类型的Id定义@PrimaryKey(autoGenerate = true)
自动生成Idindices
设置索引,如果需要保证属性数据的唯一性,则可以通过设置unique=true
来保证Entity
中的foreignKeys
来与另外一张表进行关联,设置外键@Entity(tableName = "user_table",primaryKey = {"userName","userAge"},
indices = { @Index("userName"),
@Index(value = { "userName", "userAge" }, unique = true) })
public class UserData {
@PrimaryKey
private String userName;
@ColumnInfo(name = "user_age")
private String userAge;
@ColumnInfo
private String userBirth;
@Ignore
private Bitmap mImage;
...
}
Dao
用来定义执行SQL以及增删改查的操作:param
的方式在编译期间,生成对应的SQL语句,从而进行查询Cursor
,LiveData
List
对象,@Dao
public interface UserDataDao {
@Query("SELECT * FROM user_table")
List<UserData> queryAll();
@Query("SELECT * FROM user_table WHERE userAge = :age AND userName=:name")
UserData querySingle(int age, String name);
@Insert
void insertAll(List<UserData> userList);
@Insert
void insertSingle(UserData user);
@Update
void updateAll(List<UserData> user);
@Update
void updateSingle(UserData user);
@Delete
void deleteAll(List<UserData> user);
@Delete
void deleteSingle(UserData user);
}
Room
中的Builder获取数据库对象,并且获取DAO对象后,进行操作。name
为数据库名称UserDatabase db = Room.databaseBuilder(getApplicationContext(), UserDatabase.class, "user_db").build();
UserDataDao dao = db.userDataDao();
dao.queryAll();
Room提供了Migration类进行数据库的升级,分三步
public class UserData {
@PrimaryKey(autoGenerate = true)
private String userName;
@ColumnInfo
private int userAge;
@ColumnInfo
private String userBirth;
@Ignore
private Bitmap mImage;
...
}
@Database(entities = { UserData.class }, version = 2)
public abstract class UserDatabase extends RoomDatabase {
public abstract UserDataDao userDataDao();
}
Migration
进行数据库升级UserDatabase db = Room.databaseBuilder(getApplicationContext(), UserDatabase.class, "user_db")
.addMigrations(new Migration(1, 2) {
@Override
public void migrate(@NonNull SupportSQLiteDatabase database) {
// 数据库版本从1升级到2,UserData的userAge字段从String变成了int,则需要使用ALTER修改表结构
database.execSQL("ALTER TABLE user_table CHANGE userAge INTEGER;");
}
})
.addMigrations(new Migration(2, 3) {
@Override
public void migrate(@NonNull SupportSQLiteDatabase database) {
// 数据库版本从2升级到3
}
}).build();
在编译完成后,如果没有问题,则会在/app/build/generated/source/apt/debug/pkg/
下生成dao_IMPL
类,以及数据库相应的包名下生成database_IMPL
的类
以下为部分编译后文件截图。
UserDatabase_Impl
文件中可以看到表和索引都会在数据库创建的时候创建表。
UserDatabase_Impl
UserDataDao_Impl
文件中可以看到Update
操作是一个Transaction,而Query
操作则是通过Statement查询完之后遍历Cursor来完成的
image.png
Save data in a local database using Room Understand why Room doesn't allow object references