Android Jetpack之Room的学习

Android Jetpack之Room的学习

做一个简单的增删改查

简介：

Android采用SQLite作为数据库存储。但SQLite代码写起来繁琐且容易出错，所以为了帮助我们编写出更好的代码，Android官方推出了一个ORM框架，并将它加入了Jetpack当中，这就是本容要讲的Room。
Room 为 SQLite 提供一个抽象层，以便在充分利用 SQLite 的同时，可以流畅地进行数据库访问。

Room的组成

Room主要由Entity，Dao 和 Database这三部分组成，每个部分都有明确的职责。

• Entity 。 用于定义封装实际数据的实体类，每个实体类都会在数据库中有一张相对应的表，并且表中的列是根据实体类的字段自动生成的。
• Dao 。 Dao 是数据访问对象的意思，通常会在这里对数据库的各项操作进行封装，在实际编程的时候，逻辑层就不需要和底层数据库打交道了，直接和Dao层进行交互即可。
• Database 。 用于定义数据库中的关键信息，包括数据库的版本号，包含哪些实体类以及提供Dao层的访问实例。
  此图说明了Room的不同组件之间的关系。
  

添加依赖

要使用Room之前，需要在app/build。gradle文件中添加如下依赖：

dependencies {
	...
    implementation "androidx.room:room-runtime:$room_version"
    kapt "androidx.room:room-compiler:$room_version"
}

这里我将实现一个简单的增删改查来帮助我们学习Room

• 首先是实体类

import androidx.room.ColumnInfo;
import androidx.room.Entity;
import androidx.room.PrimaryKey;

@Entity(tableName = "employee_table")
public class Employee {

    @PrimaryKey(autoGenerate = true)

    @ColumnInfo(name = "id") 
    privare int id;
    @ColumnInfo(name="name") 
    private String name;
    @ColumnInfo(name="age") 
    private String age;
    @ColumnInfo(name="position")
    private String position;

	//Room默认使用这个构造方法操作数据
    public Employee(int jobNub, String name, String age, String position) {
        this.id = id;
        this.name = name;
        this.age = age;
        this.position = position;

    //Ignore注解字段让Room忽略此方法
    //Room只能识别一个构造器，如需定义多个构造器，可以使用Ignore注解让Room忽略这个构造器
    @Ignore
    public Employee(String name, String age) {
        this.name = name;
        this.position = position;
    }

    @Override
    public String toString() {
        return "Employees{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age='" + age + '\'' +
                ", position='" + position +'\'' +
                '}';
    }
}

这里补充以下Room框架的一些注解的说明

@Entity 声明所标记的类是一个数据表，@Entity 包括的参数有：tableName(表名），indices（表的索引），primaryKeys（主键），foreignKeys（外键），ignoredColumns（忽略实体中的属性，不作为数据表中的字段），inheritSuperIndices（是否集成父类的索引，默认 false)

@ColumnInfo 用来声明数据库中的字段名

@PrimaryKey 被修饰的属性作为数据表的主键，@PrimaryKey 包含一个参数：autoGenerate(是否允许自动创建，默认false)

@Embedded 用来修饰嵌套字段，被修饰的属性中的所有字段都会存在数据表中

@ColumnInfo.SQLiteTypeAffinity 可以在typeAffinity（）中使用的SQLite列类型常量，包括：UNDEFINED, TEXT, INTEGER, REAL, BLOB，其中 UNDEFINED 未定义类型关联，将根据类型解析；TEXT SQLite列类型为 String；INTEGER SQLite列类型为 Integer 或 Boolean; REAL SQLite列类型为 Float 或 Double；BLOB SQLite列类型为二进制类型

@Dao 将类标记为数据访问对象（Data Access Object）

@Database 将类标记为RoomDatabase

@Delete 将 DAO 中的方法标记为与删除相关的方法

@Embedded 可以用作实体或Pojo字段上的注释，以指示嵌套字段

@ForeignKey 在另一个实体上声明外键

@ForeignKey.Action 可以在onDelete（）和onUpdate（）中使用的值的常量定义。包括：NO_ACTION, RESTRICT, SET_NULL, SET_DEFAULT, CASCADE

@Ignore 忽略Room的处理逻辑中标记的元素

@Index 声明实体的索引

@Insert 将Dao注释类中的方法标记为插入方法

@OnConflictStrategy Dao方法处理冲突的策略集合，包括：REPLACE, ROLLBACK, ABORT,FAIL,IGNORE，其中ROLLBACK和FAIL已经被标记为@Deprecated，REPLACE用新的数据行替换旧的数据行；ABORT直接回滚冲突的事务；IGNORE保持现有数据行。

@PrimaryKey 将实体中的字段标记为主键

@Query 将Dao注释类中的方法标记为查询方法

@RawQuery 将Dao注释类中的方法标记为原始查询方法，可以将查询作为SupportSQLiteQuery传递

@Relation 一个方便的注释，可以在Pojo中用于自动获取关系实体。

@SkipQueryVerification 跳过带注释元素的数据库验证

@Transaction 将Dao类中的方法标记为事务方法

@TypeConverter 将方法标记为类型转换器

@TypeConverters 指定Room可以使用的其他类型转换器

@Update 将Dao注释类中的方法标记为更新方法

• 然后创建 Dao 来操作

@Dao
public interface EmployeeDao {

    //增
    @Insert
    public void insertEmployee(Employee... employee);
    
    //删
    @Delete
    public void deleteEmployee(Employee... employee);

    //修
    @Update
    public void updateEmployee(Employee... employee);

    //根据id条件查询唯一的一个数据
    @Query("SELECt * FROM employee_table WHERE id=:id")
    public Employee queryEmployeeById(int id);

    //根据age查询多个数据
    @Query("SELECt * FROM employee_table WHERE age=:age")
    public List<Employee> queryEmployeesByAge(String age);


    //查询所有数据
    @Query("SELECt * FROM emperor_table")
    public List<Employee> queryEmployees();
}

• 最后创建数据库

//注解Database
@Database(entities = {Employee.class}, version = 1)
public abstract class MyDatabase extends RoomDatabase {

    private static final String DATABASE_NAME = "employee_db";

    private static MyDatabase databaseInstance;

    //结合单例模式完成创建数据库实例
    public static synchronized MyDatabase getDatabaseInstance(Context context) {
        if (databaseInstance == null) {
            databaseInstance = Room.databaseBuilder(context.getApplicationContext(), MyDatabase.class, DATABASE_NAME).build();
        }
        return databaseInstance;
    }

	//将创建的Dao对象以抽象方法的形式返回
    public abstract EmperorDao getEmperorDao();
}

*版权所有
作者：刘毅