Room

三个部分:Entitiy,Dao,Database,

Entity

SQLite表的映射类,每个Entity至少有一个主键(定义主键有两种方式);至少有一个无参构造方法或参数基于类型和名称匹配属性的构造方法。构造参数不必接受所有属性作为参数,如果一个属性没有在构造参数被赋值,它应该被public修饰或有一个被public修饰的setter方法。如果有匹配的构造参数,Room将总是使用它,如果你不想使用它,使用@Ignore标记。如果不想持久化某些属性,也可以使用@Ignore标记这些属性。

@Entity

用于标记要被持久化的类。
tableName:该类在SQLite中对应的表名,默认为类名。
indices:表中索引的集合(不懂什么作用)。
inheritSuperIndices:默认false,当设置为true时,该类继承树上所有父类的属性也会被保存到这个实体中,即使父类的该值设置为false。当从父类继承一个index后会根据@Index对其重命名,因为SQLite不允许在多个表中使用相同index名。
primaryKeys:声明任意数量主键,默认为空。
ForeignKey:声明外键约束。

@Index

用于给Entity声明一个索引。添加索引通常会使选择操作更快,但会使其他操作变慢,例如插入或更新。
有两种设置Index,用于@ColumnInfo中或@Entity中。
通过@Embedded嵌入到其它实体中的Index,需要重新声明。
默认情况下,父类的Index也不会被继承,需要重新声明,或将子类的inheritSuperIndices设置为true

@ForeignKey

是什么?什么作用?

Dao

数据库访问对象(Data Access Object),定义与数据库交互的查询方法。在Room中,有Query,Delete,Insert三种操作。

@Dao

用于标记dao接口,包含了一系列对数据库对操作。

@Query

用于标记dao中用于查询操作的方法。引用java方法参数的方式是冒号加上参数名:

@Query("SELECT * FROM comments WHERE productId = :productId")
LiveData<List<CommentEntity>> loadComments(int productId);

也可以引用数组,方法如下:

@Query("SELECT * FROM user WHERE uid IN(:userIds)")
public abstract List  findByIds(int[] userIds);

该注解支持三种操作:SELECT, UPDATE 和 DELETE。
对于SELECT操作,方法的返回值可以为单独的Java对象,也可以是数组,集合,Cursor和LiveData。如果使用RxJava2,可以返回Flowable<T>或Publisher<T>。
UPDATE和DELETE操作可以返回void或int。int值为该操作影响到的行数。

@Delete

参数必须是被@Entity标记的类或它的集合:

@Dao
public interface MyDao {
   @Delete
   public void deleteUsers(User... users);
   @Delete
   public void deleteAll(User user1, User user2);
   @Delete
   public void deleteWithFriends(User user, List<User> friends);
}
@Insert

参数必须是被@Entity标记的类或它的集合。

Database

数据库的抽象层,持有了众多Dao的引用。

@Database

标记一个被abstract修饰并继承RoomDatabase的类为Database。
entities:传入所有Entity的class对象;
version:数据库版本号。
exportSchema:设置是否导出数据库schema,默认为true,需要在build.gradle中设置:

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

通过Room.databaseBuilderRoom.inMemoryDatabaseBuilder获得该类的实现类:

AppDatabase db = Room.databaseBuilder(context.getApplicationContext(), AppDatabase.class, AppDatabase.DATABASE_NAME).build();

用法:

db.beginTransaction();
try {
    db.productDao().insertAll(products);
    db.commentDao().insertAll(comments);
    db.setTransactionSuccessful();
} finally {
    db.endTransaction();
}

类型转换

下面的方法将Date对象转换为Long型的时间戳:

public class DateConverter {
    @TypeConverter
    public static Date toDate(Long timestamp) {...}
    ...
}

使用@TypeConverters注解在Database类上声明:

@Database(...)
@TypeConverters(DateConverter.class)
public abstract class AppDatabase extends RoomDatabase {...}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,117评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,328评论 1 293
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,839评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,007评论 0 206
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,384评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,629评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,880评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,593评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,313评论 1 243
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,575评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,066评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,392评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,052评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,082评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,844评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,662评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,575评论 2 270

推荐阅读更多精彩内容