Android Room框架學習筆記

一、使用

1、build.gradle引入

compile "android.arch.persistence.room:runtime:1.0.0"
annotationProcessor 'android.arch.persistence.room:compiler:1.0.0'

如果少了第二行引入，會報錯：

Caused by: java.lang.RuntimeException: cannot find implementation for com.hy.room.HyDatabase. HyDatabase_Impl does not exist

2、新建一個實體類

@Entity(indices = {@Index(value = "firstName", unique = true)})
public class User {

    @PrimaryKey(autoGenerate = true)
    public int id;

    public String firstName;
    public String lastName;
    public int age;

    @Ignore
    private Bitmap bitmap;

    @Embedded
    public Address address;
} 

3、建立Dao類介面

@Dao
public interface UserDao {

    @Insert
    public long[] insertUsers(User... users);

    @Insert
    public void insertUserList(List<User> users);

    @Update
    public void updateUsers(User... users);

    @Delete
    public void deleteUsers(User... users);

    @Query("select * from User")
    public List<User> searchAllUsers();

    @Query("select * from User where :age > 18")
    public List<User> searchUsersByAge(int age);

    @Query("select firstName,age from user")
    public List<SimpleUser> searchAllSimpleUsers();

    @Query("select * from User where firstName like :name limit 1")
    public User searchUserByName(String name);
}

4、建立繼承RoomDatabase的資料庫管理虛類

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

5、初始化資料庫

    HyDatabase database = Room.databaseBuilder(this, HyDatabase.class, "room.db").build();

6、操作舉例（與RxJava配合使用）

    Observable.create(new ObservableOnSubscribe<String>() {
            @Override
            public void subscribe(ObservableEmitter<String> e) throws Exception {
                List<User> users = database.userDao().searchAllUsers();
                e.onNext(new Gson().toJson(users));
            }
        }).subscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(new Consumer<String>() {
                    @Override
                    public void accept(String s) throws Exception {
                        textView.setText(s);
                    }
                });

子線程中查詢出所有的用戶（主線程操作資料庫會報錯），用Gson轉換成json格式的字元串，主線程中再顯示出來。

二、資料庫升級

1、新建要增加實體類。

2、在database中entities註解加入新增的實體類，同時版本號加一。

3、初始化資料庫的地方增加addMigrations()方法，實現Migration類，例如：

    HyDatabase database = Room.databaseBuilder(this, HyDatabase.class, "room.db")
                .addMigrations(migration)
                .build();

和

    private Migration migration = new Migration(1,2) {
        @Override
        public void migrate(@NonNull SupportSQLiteDatabase database) {
            database.execSQL("CREATE TABLE `Book` (`id` INTEGER, "
                    + "`name` TEXT, `owner` INTEGER, PRIMARY KEY(`id`))");
        }
    }; 

表示從版本1升級到版本2，手動增加新增的表的sql。

三、總結

優點：

1、從上面例子可以看出，操作很簡單，不需要像以前一樣，從SqlLite查詢出數據，再一個個屬性裝配到實體類中。

2、增刪改查操作十分簡便，只需要一個註解就搞定。

缺點：

1、不能用Android Debug Database線上查看資料庫？

2、不能配置模糊查詢條件？

3、資料庫升級無法自動且未提供友好API，同樣需要手寫SQL語句，同時必須保證手寫的SQL語句與創建的實體類中的註解完全一致，不然會報錯，例如：

java.lang.IllegalStateException: Migration didn't properly handle Book(com.hy.room.Book).
Expected:TableInfo{name='Book', columns={name=Column{name='name', type='TEXT', notNull=false, primaryKeyPosition=0}, owner=Column{name='owner',     type='INTEGER', notNull=true, primaryKeyPosition=0}, id=Column{name='id', type='INTEGER', notNull=true, primaryKeyPosition=1}}, foreignKeys=[], indices=[]}
Found:
TableInfo{name='Book', columns={name=Column{name='name', type='TEXT', notNull=false, primaryKeyPosition=0}, owner=Column{name='owner', type='INTEGER', notNull=false, primaryKeyPosition=0}, id=Column{name='id', type='INTEGER', notNull=false, primaryKeyPosition=1}}, foreignKeys=[], indices=[]}

四、神坑

1、報錯

java.lang.RuntimeException: cannot find implementation for com.hiten.base.db.DbHoc. DbHoc_Impl does not exist 
at android.arch.persistence.room.Room.getGeneratedImplementation(Room.java:92) 
at android.arch.persistence.room.RoomDatabase$Builder.build(RoomDatabase.java:454) 
at com.hiten.base.manager.ManagerDb.init(ManagerDb.java:21) 
at com.hiten.base.ApplicationHoc.onCreate(ApplicationHoc.java:52)   

log說找不到_impl實現類，看來是編譯的問題。查看配置和代碼，發現都沒有問題，經過幾個小時的嘗試，終於發現還是配置的問題，問題出在這行：

    annotationProcessor "android.arch.persistence.room:compiler:1.0.0"     

我們所有的第三方引入都在third這個module裡面，然後在其他module寫業務代碼，上面那行代碼只配置在thrid上面，導致執行的module沒有運行編譯room的代碼，所以自然沒有生成實現類。在使用room的module也要加上上面那行代碼。

參考：

官方文檔（需FQ）

谷歌官方Android應用架構庫——Room 持久化庫