数据库Room之Entity(译)

原文链接:https://developer.android.com/training/data-storage/room/defining-data?hl=zh-cn

使用Entity定义数据

Room时需要定义一堆Entity。每个Entity都会在数据库中对应一张表。

想要在你的应用中使用Room,添加Architecture Componenets 到应用的 build.gradle文件中

默认情况下,Room会为Entity中的每个属性在表中创建一个对应的列。如果有属性是不希望被持久化的,那么可以使用@Ignore注解该属性。你还得记住,每个Entity必须在Database的注解中被声明才能被正确的使用。
下面代码展示了如何定义一个Entity:

@Entity
public class User {
    @PrimaryKey
    public int id;

    public String firstName;
    public String lastName;

    @Ignore
    Bitmap picture;
}

为了持久化Entity中的属性,Room必须能获取到属性。你可以定义属性为public,或者提供Getter和Setter方法。如果你使用Getter和Setter,请记住这是基于JavaBeans机制的。

主键

每个Entity至少设置一个属性为主键。即使Entity中只有一个属性,你还是需要使用@PrimaryKey来注解这个属性。同时,如果你希望由Room定义自增长ID,你可以设置@PrimaryKey的autoGenerate。如果Entity的主键是有几个属性组成的,你可以在@Entity注解中设置primaryKeys,代码如下所示:

@Entity(primaryKeys = {"firstName", "lastName"})
public class User {
    public String firstName;
    public String lastName;

    @Ignore
    Bitmap picture;
}

Room默认使用类名来定义表名。但如果你希望自定义表名,那可以设置@Entity的tableName值,代码如下所示:

@Entity(tableName = "users")
public class User {
    ...
}

表名在SQLite中是大小写不敏感的。

和tableName一样,Room使用属性名来定义表的列名。如果你希望自定义,可以添加@Columninfo注解到属性上,代码如下所示:

@Entity(tableName = "users")
public class User {
    @PrimaryKey
    public int id;

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

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

    @Ignore
    Bitmap picture;
}

索引和唯一性

根据如何操作数据,你可能希望对某些属性添加索引来加快查询。为此,在@Entity注解中添加indices属性,列出你希望加索引的属性或者组合索引。示例代码如下:

@Entity(indices = {@Index("name"),
        @Index(value = {"last_name", "address"})})
public class User {
    @PrimaryKey
    public int id;

    public String firstName;
    public String address;

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

    @Ignore
    Bitmap picture;
}

有时候,某个属性或者某组属性需要是唯一的。你可以通过设置@Index的unique值为true来强制执行这种唯一性。下面的示例代码就不允许表中有两条firstName和lastName值都一样的数据存在:

@Entity(indices = {@Index(value = {"first_name", "last_name"},
        unique = true)})
public class User {
    @PrimaryKey
    public int id;

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

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

    @Ignore
    Bitmap picture;
}

建立对象之间的关系

因为SQLite是个关系型数据库,所以你可以指定对象之间的关系。尽管很多对象映射的库都允许实体对象之间互相引用,但是Room偏偏不允许这样。要想知道这背后的原因,可以看理解为什么Room不允许对象引用 .

尽管不能直接建立关系,Room任然允许你定义外键。

例如,假设有另外一个Entity叫Book,你可以使用注解@ForeignKey来与User建立关系。示例代码如下:

@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;
}

外键是非常强大的,因为它允许你定义如果相关对象更新后做什么操作。例如,你可以通过在注解@ForeignKey中设置onDelete=CASCADE来告诉SQLite,如果某个用户被删除了,那就删除所有和这个用户相关的书。

SQLite在处理@Insert(onConflict = REPLACE)时其实是分成了移除和替换两步操作,而不是仅仅更新一步操作。替换这个操作会影响到你外键约束。详细说明请看SQLite文档 中的ON_CONFLICT条款。

对象组合

尽管对象总是有很多属性,但有时候你想让你的Entity或者POJO在数据库的结构下变得更紧密。这个时候你可以使用注解@Embedded来表示表中的某些字段被抽离到另外一个对象了。这个时候你可以使用这些被抽离的对象来查询这些字段。

例如,User类中可以有一个Address类,Address类包含了street,city,state和postcode这些属性。这样我们就可以把User类用几个属性组合了,示例代码如下:

public class Address {
    public String street;
    public String state;
    public String city;

    @ColumnInfo(name = "post_code")
    public int postCode;
}

@Entity
public class User {
    @PrimaryKey
    public int id;

    public String firstName;

    @Embedded
    public Address address;
}

这样User就包含了如下属性:id,firstName,street,state,city和post_code.

被嵌入的属性中同样可以有嵌套属性。

如果一个Entity中的有几个同类型的嵌套对象,那你可以通过设置prefix来使每个列都不一样。Room会给每个列的前面添加上prefix值。

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

推荐阅读更多精彩内容