安卓Room框架初使用
Room框架介绍
Room在·SQLite上提供了抽象层,以便于更加流畅的访问数据库,对数据库进行操作。主要由Database,Entity,Dao这三部分组成:
Database(数据库)
包含数据库持有者,并作为应用已保留的持久关系型数据的底层连接的主要接入点。简单来说,就是通过这个类构造的对象,调用抽象方法构造的Dao对象去对数据库中的表进行增删改查。需注意以下写法:
- 1 Database类要用@Database标注,并且通过entities指定与之相关联的表的一个类。
- 2 它是一个抽象类,里面有一个反回Dao对象的一个抽象方法。
- 3 对数据库的升级可以在这里面定义。
示例代码:
@Database(entities = {
User.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase {
public abstract UserDao userDao();
}
Entity:表示数据库中的表。
示例代码:
@Entity(tableName = "users")
public class User {
@PrimaryKey
public int uid;
@ColumnInfo(name = "first_name")
public String firstName;
@ColumnInfo(name = "last_name")
public String lastName;
}
- 1 用@Entity表示这是一个用于与数据库中的表对应的一个类。里面需定义字段名。如果想改变列名, @ColumnInfo(name = " ")来定义。这里面可以定义setter和getter方法,方便去操作这张表。可以(tableName = “users”)来标识表的名字。
- 2 必须有主键标识的一个字段,哪怕只有一个字段。
表的复杂写法:
-1 默认情况下,Entity类里面的字段都会生成相应的类,如果不想产生相应的类,需用@Ignore标注,
代码如下:
@Entity
public class User {
@PrimaryKey
public int id;
@Ignore
Bitmap picture;
}
- 2 如果表的结构是复合组件,须使用 @Entity(primaryKeys = {“主键1”, “主键2”})。
- 3 外键的写法:
@Entity(foreignKeys = @ForeignKey(entity = User.class,
parentColumns = "id",
childColumns = "user_id"))
public class Book {
@PrimaryKey public int bookId;
public String title;
@ColumnInfo(name = "user_id") public int userId;
}
其中entity = User.class表示要引用的外键的类, parentColumns = "id"表示外键在要引用的类里面的列名, childColumns = "user_id"表示在这个表中对应的列名。
DAO:包含用于访问数据库的方法。
示例代码:
@Dao
public interface UserDao {
@Query("SELECT * FROM user")
List<User> getAll();
@Query("SELECT * FROM user WHERE uid IN (:userIds)")
List<User> loadAllByIds(int[] userIds);
@Query("SELECT * FROM user WHERE first_name LIKE :first AND " +
"last_name LIKE :last LIMIT 1")
User findByName(String first, String last);
@Insert
void insertAll(User... users);
@Delete
void delete(User user);
}
需注意以下:
- 1用@Query定义sql语言,紧接着下面写java方法代码,如果sql语言里要引用方法里面的形参,需用:加形参。
- 2 有些方法是已经定义好的,不需要写sql代码,例如Delete,Update等。
- 3 需注意反回类型。例如getALL的返回类型要用List<>接收。
具体使用(附Demo)
添加依赖
需在app目录下的build.gradle的dependencies中添加如下代码:
def room_version = "2.2.3"
implementation "androidx.room:room-runtime:$room_version"
annotationProcessor "androidx.room:room-compiler:$room_version" // For Kotlin use kapt instead of annotationProcessor
// optional - Kotlin Extensions and Coroutines support for Room
implementation "androidx.room:room-ktx:$room_version"
// optional - RxJava support for Room
implementation "androidx.room:room-rxjava2:$room_version"
// optional - Guava support for Room, including Optional and ListenableFuture
implementation "androidx.room:room-guava:$room_version"
// Test helpers
testImplementation "androidx.room:room-testing:$room_version"
这样做完常会出现一个Kotlin的jar包不能够安装的问题,会导致build时会超时,完成不了,导致Room不能够使用,解决办法:在于app同级的build.gradle中的allprojects里的repositories里如下写法:
allprojects {
repositories {
maven{
url "https://kotlin.bintray.com/kotlinx/"}
google()
jcenter()
}
}
数据库的建立
采用单例模式反回数据库对象。相关代码:
@Database(entities = {
User.class},version = 1)
public abstract class AppDatabase extends RoomDatabase {
private static final String DB_NAME ="uers.db";