Room使用介绍

简介

在2017年Google IO大会上推出的官方数据框框架，其实际上就是对SQLite做了一层封装。基本原理是通过编译期注解，根据你配置的表名和表字段生成对应的代码，减少开发者的工作量。

使用

1、添加Room依赖

dependencies {
 api "android.arch.persistence.room:runtime:$1.1.1"
 annotationProcessor "android.arch.persistence.room:compiler:$1.1.1"
}

注意，如果你是将room封装在module里面，然后再将module引入到主工程的话，需要将 annotationProcessor "android.arch.persistence.room:compiler:$1.1.1" 这个也拷贝到主工程的build.gradle里面，要不然注解不能够正常生成，项目也运行不起来。

2、使用

在使用的过程中，我们需要一个Entity、一个Dao和一个DataBase。

1）、Entry类
使用@Entity注解，表名这个是其中一张表，另外，如果在属性的签名不加任何注解的话，这个属性就是一个字段名，当然，如果你不想直接使用属性名作为字段名的话，可以加上 @ColumnInfo(name = "message")进行自定义。如果这个实体类的某个字段不想存进数据库的话，可以加上@Ingore.是否是主键、外键等也有对应的注解。

@Entity(tableName = RoomConstant.FIRST_TABLE)
public class FirstTable {

    @PrimaryKey(autoGenerate = true)
    private int id;

    @ColumnInfo(name = "message")
    private String message;

    public String getInfo() {
        return info;
    }

    public void setInfo(String info) {
        this.info = info;
    }

    @ColumnInfo(name = "info")
    private String info;

    public void setMessage(String message){
        this.message = message;
    }

    public int getId() {
        return id;
    }

    public String getMessage() {
        return message;
    }

    public void setId(int id) {
        this.id = id;
    }
}

2）、Dao 类
这个类的作用是配置对应的数据库操作方法，比如查询、更新、删除等，注意，类名前面需要@Dao注解。如果是全部查询、删除等操作，可以直接传入对应的entry类，如果是根据某个字段去查询，需要自己写对应的sql语句。

@Dao
public interface BaseDao<T> {

    @Insert
    void insertItem(T item);//插入单条数据

    @Insert
    void insertItems(List<T> items);//插入list数据

    @Delete
    void deleteItem(T item);//删除item

    @Update
    void updateItem(T item);//更新item
}

@Dao
public interface FistTableDao extends BaseDao<FirstTable>{

    //如果是查询

    @Query("SELECT * FROM first_table")
    List<FirstTable> getAll();

    @Query("SELECT * FROM first_table WHERE id IN (:ids)")
    List<FirstTable> loadAllByIds(int[] ids);

    @Query("SELECT * FROM first_table WHERE :message LIKE :message")
    FirstTable findByMessage(String message);
}

3）、DataBase类
使用@DataBase注解。里面需要配置你要操作的entry类，可以配置一个或者多个，version表名这个是哪个版本，如果升级需要修改的就是这里。升级的策略有两种，一种是完全不要旧版本的数据，增加fallbackToDestructiveMigration即可，如果有自定义的升级策略....后面再讲。allowMainThreadQueries表明是否可以在主线程进行操作，一般不建议增加这个配置。配置abstract FistTableDao userDao(); 就可以获取到进行数据库操作的实例。

@Database(entities = {FirstTable.class, SecondTable.class, ThirdTable.class}, version = RoomConstant.VERSION, exportSchema = false)
public abstract class MyRoomDataBase extends RoomDatabase {

    private static MyRoomDataBase mInstance;

    public static MyRoomDataBase getInstance(Context context) {
        if (mInstance == null) {
            synchronized (MyRoomDataBase.class) {
                if (mInstance == null) {
                    mInstance = Room.databaseBuilder(context, MyRoomDataBase.class, DB_NAME)
                            .fallbackToDestructiveMigration() //直接删除旧版数据
                            .allowMainThreadQueries()   //可以在主线程操作
                            .build();
                }
            }
        }
        return mInstance;
    }

    public static void onDestroy() {
        mInstance = null;
    }

    public abstract FistTableDao userDao();

    public abstract SecondTableDao secondTableDao();

    public abstract ThirdTableDao thirdTableDao();
}

3、设置 Schema 的位置

存储展示数据库的结构信息，如果不设置的话，需要再database类上配置exportSchema = false，要不然编译的时候会出现警告。

defaultConfig {
        minSdkVersion 19
        targetSdkVersion 26

        javaCompileOptions {
            annotationProcessorOptions {
                arguments =["room.schemaLocation":"$projectDir/schemas".toString()]
            }
        }
}

4、查询

经过上面的配置之后，就可以获取到对应的Dao实例进行操作，

MyRoomDataBase myRoomDataBase = MyRoomDataBase.getInstance(baseContext);

    private static void operateFristTable(MyRoomDataBase myRoomDataBase) {
        FistTableDao fistTableDao = myRoomDataBase.userDao();
        FirstTable firstTable = new FirstTable();
        firstTable.setMessage("firstTableMessage1");
        firstTable.setInfo("第一个表");
        fistTableDao.insertItem(firstTable);

//        firstTable.delete(firstTable);

        FirstTable item  = fistTableDao.findByMessage("firstTableMessage1");
        if (item != null) {
            Log.d(TAG, item.getInfo());
        }

        List<FirstTable> firstTableList = fistTableDao.loadAllByIds(new int[]{0,1,2});

        if (firstTableList != null) {
            Log.d(TAG, "<-firstTableSize->" + firstTableList.size());
        }
    }

5、升级

如果需要进行数据库的升级，需要再构造database 实例的时候，调用addMigrations进行配置

Room.databaseBuilder(getApplicationContext(),  MyRoomDataBase.class,  DB_NAME).  (MIGRATION_1_2, MIGRATION_2_3).build();

static final Migration MIGRATION_1_2 = new Migration(1, 2) {
    @Override
    public void migrate(SupportSQLiteDatabase database) {
        database.execSQL("CREATE TABLE `second_table` (`id` INTEGER, "
                + "`name` TEXT, PRIMARY KEY(`id`))");
    }
};

static final Migration MIGRATION_2_3 = new Migration(2, 3) {
    @Override
    public void migrate(SupportSQLiteDatabase database) {
        database.execSQL("alert table first_table "
                + "add column age integer");
    }
};