Room数据库的介绍和使用 - alonealice

介绍

Room数据库是Google提供的一个ORM库，提供了SQLite的抽象层，以便在充分利用SQLite的同时允许流畅的数据库访问。

其主要有三个组件：

@Database：@Database用来注解类，并且注解的类必须是继承自RoomDatabase的抽象类。该类主要作用是创建数据库和创建Daos（data access objects，数据访问对象）。

@Entity：@Entity用来注解实体类，@Database通过entities属性引用被@Entity注解的类，并利用该类的所有字段作为表的列名来创建表。

@Dao：@Dao用来注解一个接口或者抽象方法，该类的作用是提供访问数据库的方法。在使用@Database注解的类中必须定一个不带参数的方法，这个方法返回使用@Dao注解的类。

使用

添加依赖

allprojects {
    repositories {
        jcenter()
        maven { url 'https://maven.google.com' }
    }
}

1 2	compile "android.arch.persistence.room:runtime:1.1.1" annotationProcessor "android.arch.persistence.room:compiler:1.1.1"

为了方便调试，我们添加Android-Debug-Database的依赖。

1	debugCompile 'com.amitshekhar.android:debug-db:1.0.1'

Entity

Room会利用@Entity注解的类的所有字段来创建表的列，其中如果某些字段不希望存储的话，使用@Ignore注解该字段。一般情况下，Room使用类名作为表名，使用字段名作为列名，同时可以通过@Entity的tableName属性定义自己的表名，通过@ColumnInfo的name属性定义自己的列名。

@Entity(tableName = "name")
public class NameEntity {

    @PrimaryKey
    public int id;

    @ColumnInfo(name = "first")
    public String firstName;

    @ColumnInfo(name = "last")
    public String lastName;

    @Ignore
    public Bitmap person;

}

主键

每一个实体至少定义一个字段作为主键。可以将@PrimaryKey的autoGenerate属性设置为true来设置自动id。如果实体有一个复合的主键，可以使用 @Entity的primaryKeys属性来指定主键。

1	@Entity(tableName = "name", primaryKeys = {"id","first"})

索引和唯一性

在Room中可以通过@Entity的indices属性添加索引。

1 2	@Entity(indices = {@Index("name"), @Index(value = {"first", "last"})})

同时也可以通过将@Index的unique属性设置为true，来确保某个字段或者多个字段形成的组唯一。

1 2	@Entity(indices = {@Index(value = {"first", "last"}, unique = true)})

外键

Room可以定义两个实体之间的外键，来建立两个实体的联系。

@Entity(foreignKeys = @ForeignKey(entity = NameEntity.class,parentColumns = "nameId", childColumns = "id",onDelete = CASCADE))
public class UserEntity {
    public int id;
    
    public int nameId;
}

当引用的实体发生改变时，通过外键可以指定如何处理。例如，如果@ForeignKey的onDelete属性值为CASCADE，如果删除name，所有具有相同nameId的user会被全部删除。

嵌套对象

Room提供了一个注解@Embedded，允许在一个实体中嵌入另外一个实体，创建的表使用的是当前实体和嵌入实体的所有字段。

@Entity(foreignKeys = @ForeignKey(entity = NameEntity.class,parentColumns = "nameId", childColumns = "id"))
public class UserEntity {
    public int id;

    public int nameId;

    @Embedded
    public Book book;
}

public class Book {
    String bookName;
}

当一个类中嵌套多个类，并且这些类具有相同的字段，则需要调用@Embedded的属性prefix 添加一个前缀，生成的列名为前缀+列名

1 2	@Embedded(prefix = "first") public Book book;

那么创建的将会是firstBookName。

数据访问对象DAO

Dao类是Room最重要的组件，该类主要提供操作数据库的方法。使用时会新建一个Dao接口类，并添加@Dao注解。

insert

@Dao
public interface NameDao {

    @Insert(onConflict = OnConflictStrategy.REPLACE)
    void insertName(NameEntity nameEntity);

    @Insert
    void insertName(NameEntity nameEntity1,NameEntity nameEntity2);

    @Insert
    void insertName(List<NameEntity> list);
}

onConflict用来指定当发生冲突是的策略，主要的策略有：REPLACE（替换），ROLLBACK（回滚），ABORT（崩溃），FAIL（失败），IGNORE（忽略）。

返回值即可以是void，也可以是long和long[]等，用来返回插入的rowId。

update

使用@Update注解方法，可以使用参数实体的值更新主键值和参数实体的主键相同的行。

1 2	@Update void updateName(NameEntity entity);

delete

使用@Delete注解方法，可以删除主键值和参数实体的主键相同的行。

1 2	@Delete void delete(NameEntity entity);

Query

@Query主要是用来查询数据库，它的值为SQL语句，可以被SQLite执行。同时@Query支持查询语句，删除语句和更新语句，不支持插入语句。

1 2	@Query("select * from name") List<NameEntity>getNames();

在查询时添加参数：

1 2	@Query("select * from name where first= :firstName") NameEntity getName(String firstName);

添加参数合集

1 2	@Query("select * from name where first in (:firstNames)") NameEntity getName(String firstNames);

直接返回Cursor

1 2	@Query("select * from name where first = :firstNames") Cursor getName(String firstNames);

数据类型转换

Room支持字符串和基本数据类型以及他们的包装类，但是如果不是基本数据类型，该如何存储呢？比如我们的User对象有个Date类型的字段birthday，我们该如何存储。Room提供了@TypeConverter可以将不可存储的类型转换为Room可以存储的类型。

public class Converters {
    @TypeConverter
    public static Date fromTimestamp(Long value) {
        return value == null ? null : new Date(value);
    }

    @TypeConverter
    public static Long dateToTimestamp(Date date) {
        return date == null ? null : date.getTime();
    }
}

@Database(entities = {NameEntity.class,Book.class}, version = 1)
@TypeConverters({Converters.class})
public abstract class AppDatabase {
   public abstract NameDao nameDao();
}

RxJava

Room也可以返回RxJava2的Publisher和Flowable对象。要使用这个功能需要在gradle中添加android.arch.persistence.room:rxjava2.

1 2	@Query("select * from name where first = :firstNames") Flowable<NameEntity> getName(String firstNames);

创建使用数据库

创建数据库时开销较大，建议使用单例

private static volatile AppDatabase INSTANCE;

public static AppDatabase getInstance(Context context){
    if (INSTANCE == null) {
        synchronized (AppDatabase.class) {
            if (INSTANCE == null) {
                INSTANCE = Room.databaseBuilder(context.getApplicationContext(),
                        AppDatabase.class, "data.db")
                        .build();
            }
        }
    }
    return INSTANCE;
}

NameEntity entity = new NameEntity();
entity.firstName="a";
entity.lastName="b";
AppDatabase.getInstance(this).nameDao().insertName(entity);

数据库升级

Room提供了 Migration 类用于迁移数据库，每一个 Migration 需要在构造函数里指定开始版本和结束版本。在运行时，Room会按照提供版本的顺序顺序执行每个Migration的migrate()方法，将数据库升级到最新的版本。

Room.databaseBuilder(context.getApplicationContext(), AppDatabase.class, "data.db")
        .addMigrations(MIGRATION_1_2, MIGRATION_2_3).build();

//version 从1-2
static final Migration MIGRATION_1_2 = new Migration(1, 2) {
    @Override
    public void migrate(SupportSQLiteDatabase database) {
      //升级数据库的sql
        database.execSQL("....");
    }
};

//version 从2-3
static final Migration MIGRATION_2_3 = new Migration(2, 3) {
    @Override
    public void migrate(SupportSQLiteDatabase database) {
        //升级数据库的sql
        database.execSQL("...");
    }

介绍

使用