android room详解

room是官方推出的数据库映射框架。在没有room之前，比较出名的就是greendao库。既然官方都出了，还是用官方的吧。
使用room或者然后第三方框架，最好使用android 4.2以及之后的版本。因为这些新版本支持Database Inspector功能。也就是直接查看数据库的功能，以前的版本只能导出查看非常的麻烦。

可以通过View->Tool Window->Database Inspector打开这个功能。
在一些新版本中，这个功能被移动到App Inspection里面。
同时需要SDK26及以上版本。

0.踩坑指南

写的时候遇到的问题非常的多，如果大家有问题可以参考下。
1.没有创建数据库
先说一个遇到的坑，代码什么都写好了，第一次运行的时候，数据库也成功创建了。但后面再运行的时候怎么也创建不了数据库，后面发现是因为我的new Thread类没有调用start方法，根本就没有执行代码，第一次成功是因为没有写new Thread在UI线程直接报错了。虽然报错，但数据库还是创建了，这个搞了很久，还是要小心仔细，特地记录一下。
2.Database Inspector一直显示closed.
这个需要设置断点，然后调试运行，Database Inspector就能正常显示了。
3.Current JDK version 1.8 has a bug that prevents Room from being incremental
还是第一次见这种提示，直接告诉你JDK有bug。解决办法就是把JDK换成AS内置的JDK。

1.创建数据库

下面通过一个官方例子来开始学习room的使用。
首先需要引入库：
前面两个是必要的，后面的可选，配合别的库使用，需要的时候添加上就可以。

    //room
    def room_version="2.4.2"
    implementation "androidx.room:room-runtime:$room_version"
    annotationProcessor "androidx.room:room-compiler:$room_version"
    //implementation "androidx.room:room-rxjava2:$room_version"
    //implementation "androidx.room:room-rxjava3:$room_version"
    //implementation "androidx.room:room-guava:$room_version"
    //testImplementation "androidx.room:room-testing:$room_version"
    //implementation "androidx.room:room-paging:2.5.0-alpha01"

第一步：创建映射实体类
创建实体类，这个实体类就是数据库映射的接受类，对应的是数据库的user表，可以将数据库的表结构映射成Java Bean。使用注解标记相应的功能，通过名字就可以非常清楚的知道。

• @Entity 表结构实体
• @PrimaryKey 主键
• @ColumnInfo 列/字段信息

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

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

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

}

第二步：创建Dao接口
创建我们的Dao接口，这种实现方式和Retrofit是非常相似的。其实最感觉的就是SQL语句。这里我们先只关系getAll这个方法就行，语句是最简单的"SELECT * FROM user"。
对应的注解也是非常容易理解,分别对应增删改查。

• @ Query 查询
• @ Delete 删除
• @ Update 修改
• @ Insert 插入

@Dao
public interface UserDao {
    @Query("SELECT * FROM user")
    List<User> getAll();

    @Query("SELECT * FROM user WHERE uid IN (:userIds)")
    List<User> loadAllByIds(int[] userIds);

    @Query("SELECT * FROM user WHERE first_name LIKE :first AND " +
           "last_name LIKE :last LIMIT 1")
    User findByName(String first, String last);

    @Insert
    void insertAll(User... users);

    @Delete
    void delete(User user);
}

第三步：创建数据库抽象接口
需要继承RoomDatabase，通过@Database指定需要创建的表。还可以指定版本。

@Database(entities = {User.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase {
    public abstract UserDao userDao();
}

我们发现这个我们自己定义的AppDatabase还是抽象类，因为她的实现需要移除在Activity或者Fragment里面实现。通过下面的代码创建真正的实现类。到这一步，数据库，表和UserDao都已经创建好了，通过AppDatabase的userDao方法，我们就可以获取到UserDao的实现。然后就可以直接调用对应的方法实现增删改查。

   //Activity中调用
    AppDatabase db = Room.databaseBuilder(getApplicationContext(),
                        AppDatabase.class, "app.db").build();

下面是完整的测试代码，我们需要创建一个新Thread并且启动她。我们插入两条数据到user表中。

 new Thread(new Runnable() {
            @Override
            public void run() {
                Log.d("MainActivity", "create database");
                AppDatabase db = Room.databaseBuilder(getApplicationContext(),
                        AppDatabase.class, "app.db").build();

                UserDao userDao = db.userDao();
                User user=new User(1,"Tom","Cat");
                User user2=new User(2,"xiao","ming");
                userDao.insertAll(user, user2);
                List<User> users = userDao.getAll();
                Log.d("MainActivity", "users:" + users);
            }
        }).start();

如果一切正常，那么将在Database Inspector里面看到下面的内容。

2.room的增删改查实现和细节

在数据库操作中其实最重要的是SQL语句，别的操作反而是次要的。

2.1 插入操作

有三种方式可以实现插入数据。

1. 使用@Insert注解声明的Dao接口方法。
   下面的代码分别可以插入一个和插入多条数据，只需要传入相应的User对象。这种方式是最常用的。

    @Insert()
    void insert(User user);

    @Insert
    void insertAll(User... users);

这种方式是典型的数据库映射，也是room的这种ORM的精髓。下面的代码只是用于测试，实际项目不可能写这种代码，下面代码的最大问题是重复执行会报主键冲突错误。真实应用主键是递增或者随机的，不存在这个问题。当然测试的话，我们需要实现deleteAll方法，先把表清空了再插入。

  UserDao userDao = db.userDao();
  User user=new User(1,"Tom","Cat");
  User user2=new User(2,"xiao","ming");
  userDao.insertAll(user, user2);

2.使用@Query执行 Insert SQL语句
这种方式基本不会使用，因为违背ORM的设计理论，可能插入语句比较复杂的时候，或者出现比较奇怪问题的时候可以考虑使用。作为一种辅助手段吧。

    @Query("insert into user values(1,'Tom','Cat') ")
    void initTestData();

3.直接在Database Inspector使用SQL语句
这种方式在测试的时候是非常方便的。可以考虑使用。缺点非常的明显，Database Inspector每次只能执行一条SQL语句，这非常的不合理。不能同时执行多条插入语句。不知道是没有这个功能，还是我使用不正确。感觉Database Inspector功能太简单，并不好用，用来看看数据库内容还是不错的，希望将来能有所改进吧。

2.2删除操作

和插入操作类似。可以删除一条数据或者根据条件删除多条数据。

   @Delete
    void delete(User user);

    @Query("DELETE from user where uid > 0")
    void deleteAll();

  UserDao userDao = db.userDao();
                userDao.deleteAll();

2.3查询操作

查询专门指SELECT语句，而不是@Query注解，这个注解可以做很多事情，前面我们看到，这个注解就是用来执行SQL语句的。

   @Query("SELECT * from user")
    void deleteAll();

2.4更新操作

可以通过room提供的@Update注解来实现，当然也可以通过@Query直接执行SQL语句。

@Update
void updata(User user);

@Query("update  user set  last_name='Dog' where first_name='Tom'")
void updataByQuery();

user.setLastName("Dog");
//userDao.updataByQuery();
userDao.updata(user);