数据库Room之DAO(译)

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

使用DAOs操作数据

在Room中想要操作数据必须通过DAO。这些DAOs连接起了Room中的几个组件,因为每个DAO提供了访问数据的方法。

通过使用DAOs来操作数据而不是直接查询可以使得数据库架构更解耦,而且DAOs可以让你很容易mock数据来测试应用。

想要在你的应用中引入DAO类,添加Architecture Componenets 到应用的 build.gradle文件中。

每个DAO必须是一个抽象类或者接口。如果是个抽象类,它可以有一个以RoomDatabase最为参数的构造函数,并且只能有这么一个参数。Room会在编译阶段实现这个DAO。

因为操作数据有可能会中断UI操作,所以Room不支持在主线程中操作数据,除非你在构造时调用了allowMainThreadQueries() 。异步查询-返回LiveData或者Flowable是个比较好的方式,因为是他们是在子线程中进行异步查询。

超级简单的定义方法

DAO中定义了很多方便你操作数据的注解。下面就简单讲几个比较常用的。

Insert

当你用@Insert注解DAO的方法时,Room会自动实现一次性插入所有的数据到数据库中。
下面代码展示了几种使用:

@Dao
public interface MyDao {
    @Insert(onConflict = OnConflictStrategy.REPLACE)
    public void insertUsers(User... users);

    @Insert
    public void insertBothUsers(User user1, User user2);

    @Insert
    public void insertUsersAndFriends(User user, List<User> friends);
}

如果@Insert注解的方法只接收一个参数,它会返回一个long类型的数值,这个数值就是插入后的rowId。如果参数是数组或者列表,那么它会返回long[]或者List<Long>.
更多的细节请看@Insert文档� ,rowId文档

Update

Update方法会更新传进来的所有数据,它通过主键去匹配每个对象。
下面代码展示了如何定义方法:

@Dao
public interface MyDao {
    @Update
    public void updateUsers(User... users);
}

尽管一般情况下没有必要,但还是可以返回一个int数值,这个数值表明修改了多少条数据库中的数据。

Delete

Delete方法会从数据库中删除传进来的所有数据,这也是通过主键去匹配。
示例代码如下:

@Dao
public interface MyDao {
    @Delete
    public void deleteUsers(User... users);
}

尽管一般情况下没有必要,但还是可以返回一个int数值,这个数值表明修改了多少条数据库中的数据。

Query

@Query在DAO类中是最常被使用的。它允许你读取数据库。每个被@Query注解的方法都会在编译期做检查,所以如果查询有问题就会在编译期就报错而不是在运行时。

简单查询

@Dao
public interface MyDao {
    @Query("SELECT * FROM user")
    public User[] loadAllUsers();
}

这是一个非常简单的查询,它就是查询了所有用户。Room在编译器就知道了这是一个查询用户所有字段的操作。所以如果查询语句包含语法错误,或者用户表不存在,那么Room就会在编译期提示相关错误信息。

给查询传参

很多时候我们需要给查询方法传一些参数,以此来过滤一些数据,比如只显示年龄大于某个值的用户。为此可以在@Query注解中使用方法中的参数名,示例代码如下:

@Dao
public interface MyDao {
    @Query("SELECT * FROM user WHERE age > :minAge")
    public User[] loadAllUsersOlderThan(int minAge);
}

当这条查询语句在编译期间,Room会把注解中的 :minAge和方法参数minAge绑定起来。如果无法匹配上,那么就会在编译期报错。

你可以一次传几个参数,然后在查询语句中多次使用它们,示例代码如下:

@Dao
public interface MyDao {
    @Query("SELECT * FROM user WHERE age BETWEEN :minAge AND :maxAge")
    public User[] loadAllUsersBetweenAges(int minAge, int maxAge);

    @Query("SELECT * FROM user WHERE first_name LIKE :search "
           + "OR last_name LIKE :search")
    public List<User> findUserWithName(String search);
}

只返回子列

很多时候我们只需要表中的某几个列。例如,在UI中只需要显示用户的姓和名,其他字段都不需要显示出来。只获取我们需要的字段不仅节约了资源,而且使查询更快。
Room会将查询结果映射到类中相应的字段,所以你可以创建一个只有姓和名的类来获取数据:

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

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

这样你就能在查询方法中使用这个POJO了:

@Dao
public interface MyDao {
    @Query("SELECT first_name, last_name FROM user")
    public List<NameTuple> loadFullName();
}

Room知道查询语句会返回first_name和last_nam,而且会自动映射到NameTuple中对应的属性。如果查询语句返回太多字段了或者或者某个列在NameTuple类中不存在,Room会有警告提示。

这些POJO内可以使用Embedded注解。

传集合参数

有时候我们需要传一些参数,而这些参数的数量在只能在运行才能确定。例如,你希望能查询一些区域里的用户。当我们传集合作为参数时,Room能正确的在运行时展开这些数据。

@Dao
public interface MyDao {
    @Query("SELECT first_name, last_name FROM user WHERE region IN (:regions)")
    public List<NameTuple> loadUsersFromRegions(List<String> regions);
}

可观察的查询

通常我们在查询数据时,希望数据发生变化时界面能自动更新。为达到这个目标,可以用LiveData包装返回结果。当数据库数据发生变化时,Room会有相应的代码来更新LiveData。

@Dao
public interface MyDao {
    @Query("SELECT first_name, last_name FROM user WHERE region IN (:regions)")
    public LiveData<List<User>> loadUsersFromRegionsSync(List<String> regions);
}

在1.0版本中,Room根据观察查询相关的行的情况来决定是否需要更新LiveData数据。

结合RxJava

Room也能够返回RxJava2中Publisher和Flowable对象。要使用该功能需要在build.gradle中添加依赖android.arch.persistence.room:rxjava2。这样你就能像下面代码一样返回RxJava2中的类型。

@Dao
public interface MyDao {
    @Query("SELECT * from user where id = :id LIMIT 1")
    public Flowable<User> loadUserById(int id);
}

更多细节,详见文章Room和RxJava

直接通过游标访问

如果你的应用需要直接使用游标,可以直接返回Cursor,代码如下所示:

@Dao
public interface MyDao {
    @Query("SELECT * FROM user WHERE age > :minAge LIMIT 5")
    public Cursor loadRawUsersOlderThan(int minAge);
}

非常不建议使用Cursor,因为它不能保证行是否存在。只有在你原先代码就需要Cursor而且很难重构才不得不使用这种方式。

多表查询

有些查询需要通过多张表才能得到想要的数据。Room允许你写任何查询语句,所以也就支持多表查询了。而且,如果返回结果是可观察类型例如Flowable或者LiveData,Room会观察所有相关数据。
下面代码展示了如何连表查询:

@Dao
public interface MyDao {
    @Query("SELECT * FROM book "
           + "INNER JOIN loan ON loan.book_id = book.id "
           + "INNER JOIN user ON user.id = loan.user_id "
           + "WHERE user.name LIKE :userName")
   public List<Book> findBooksBorrowedByNameSync(String userName);
}

这种查询也可以返回POJO。例如,你写一个查询用户和他们的宠物名的:

@Dao
public interface MyDao {
   @Query("SELECT user.name AS userName, pet.name AS petName "
          + "FROM user, pet "
          + "WHERE user.id = pet.user_id")
   public LiveData<List<UserPet>> loadUserAndPetNames();


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

推荐阅读更多精彩内容

  • 爱情或许本就是荷尔蒙分泌催生的虚幻映像,婚后生活才是爱情真实的写照,婚姻是爱情的巨轮,她有很多很多零部件,不会轻易...
    54f70f613c7c阅读 158评论 0 3
  • 碎花裙离地 我醉眼迷离 你说先生买朵玫瑰让她带进梦里 今夜正值七夕 灯红酒绿 身处异地,我一人孤身在这里 今日我刚...
    针灸龙哥阅读 382评论 12 5
  • 由于本人不在家没带笔记本,所以就用手机编程的!它的网站是大大提供的!先给大家看看最终结果 由于是手机操作的,所以大...
    看着我成长阅读 238评论 1 1
  • 1995年5月8日,邓丽君因支气管哮喘发作于泰国清迈逝世;同年香港十大中文金曲颁奖礼追认授予邓丽君“金针奖”;19...
    快乐医世阅读 234评论 0 0