美文网首页Android开发
Android---Google Room数据库

Android---Google Room数据库

作者: HPD_黄霹雳 | 来源:发表于2018-04-09 10:26 被阅读0次

    对官方文档的翻译
    https://blog.csdn.net/hubinqiang/article/details/73012353
    相关博客
    https://www.imooc.com/article/22000?block_id=tuijian_wz
    https://www.jianshu.com/p/c0c91f4226a6
    http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2017/0728/8278.html
    http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2017/0726/8249.html
    http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2017/0726/8268.html

    之前一直使用的GreenDao,现在新项目想尝试下room,而且还可以跟rxjava结合。这里只是记录大概用法。

    加入依赖

    implementation "android.arch.persistence.room:runtime:1.0.0"
        implementation 'io.reactivex.rxjava2:rxjava:2.1.3'
        implementation 'io.reactivex.rxjava2:rxandroid:2.0.1'
        annotationProcessor "android.arch.persistence.room:compiler:1.0.0"
        implementation "android.arch.persistence.room:rxjava2:1.0.0"
    

    配置APP中的build.gradle,这样子会有schemas文件夹。里面定义的是每个版本数据库的结构

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

    定义实体类,这个getter,setter一定要有。

    @Entity
    public class User {
        @PrimaryKey(autoGenerate = true)
        private int uid;
    
        private String name;
    
        @ColumnInfo(name = "last_age")
        private int age;
    
        public int getUid() {
            return uid;
        }
    
        public void setUid(int uid) {
            this.uid = uid;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public int getAge() {
            return age;
        }
    
        public void setAge(int age) {
            this.age = age;
        }
    }
    

    定义Dao接口,用于具体的操作

    @Dao
    public interface UserDao {
    
        @Query("select * from user")
        Single<List<User>> getAll();
    
        @Insert
        void insert(User... users);
    }
    
    

    定义数据库

    @Database(entities = {User.class}, version = 6)
    public abstract class AppDatabase extends RoomDatabase {
    
        private static final String TAG = "AppDatabase";
    
        private static AppDatabase INSTANCE;
    
        private static final Object sLock = new Object();
    
        private static final String DB_NAME = "app_catch_v";
    
        private static final int DB_VERSION = 1;
    
        private static String DB_FILE_NAME = DB_NAME + DB_VERSION + ".db";
    
        public static AppDatabase getInstance(Context context) {
    
            synchronized (sLock) {
                if (INSTANCE == null) {
                    INSTANCE = Room.databaseBuilder(context.getApplicationContext(),
                            AppDatabase.class, DB_FILE_NAME)
                            .addMigrations(MIGRATION_1_2, MIGRATION_2_3, MIGRATION_4_5, MIGRATION_5_6)
                            .fallbackToDestructiveMigration()//如果更新版本,没有加入迁移,则会删除所有数据
                            .build();
                }
                return INSTANCE;
            }
        }
    
        static final Migration MIGRATION_1_2 = new Migration(1, 2) {
            @Override
            public void migrate(SupportSQLiteDatabase database) {
                Log.i(TAG, "migrate: MIGRATION_1_2");
            }
        };
    
        static final Migration MIGRATION_2_3 = new Migration(2, 3) {
            @Override
            public void migrate(SupportSQLiteDatabase database) {
                Log.i(TAG, "migrate: MIGRATION_2_3");
            }
        };
    
        static final Migration MIGRATION_3_4 = new Migration(3, 4) {
            @Override
            public void migrate(SupportSQLiteDatabase database) {
                Log.i(TAG, "migrate: MIGRATION_3_4");
            }
        };
    
        static final Migration MIGRATION_4_5 = new Migration(4, 5) {
            @Override
            public void migrate(SupportSQLiteDatabase database) {
                Log.i(TAG, "migrate: MIGRATION_4_5");
            }
        };
    
        static final Migration MIGRATION_5_6 = new Migration(5, 6) {
            @Override
            public void migrate(SupportSQLiteDatabase database) {
                Log.i(TAG, "migrate: MIGRATION_5_6");
            }
        };
    
        /**
         * 关闭链接
         */
        public void close() {
            try {
                if (INSTANCE != null) {
                    INSTANCE.close();
                }
            } catch (Exception e) {
    
            }
        }
    
    
        public abstract UserDao userDao();
    }
    

    使用,数据库操必须在子线程中。不然会报错

        AppDatabase db = AppDatabase.getInstance(getApplicationContext());
                    db.userDao().getAll()
                            .subscribeOn(Schedulers.newThread())
                            .observeOn(AndroidSchedulers.mainThread())
                            .subscribe(new Consumer<List<User>>() {
                                @Override
                                public void accept(List<User> users) throws Exception {
                                    Log.i(TAG, "accept: " + users.size());
                                }
                            });
    

    注意点:

    1. 数据库操作必须在子线程中
    2. 记得关闭数据库
    3. Dao中的返回的rxjava被订阅者,可有三种形式。#####

    当数据库中没有user,查询没有返回行时,Flowable不会发射,也不会触发onNext, 或者 onError。
    当数据库中有一个user时,Flowable会触发onNext。
    每当user更新之后,Flowable将自动发射,这样你就可以根据最新的数据来更新UI。

    @Query("select * from user")
    Single<List<User>> getAll();
    

    当数据库中没有user,查询没有返回行时,Single触发onError(EmptyResultSetException.class)。
    当数据库中有一个user时, Single触发onSuccess。
    如果在Single.onComplete调用之后user被更新,什么也不会发生。

    @Query("select * from user")
     Flowable<List<User>> getAll();
    

    当数据库中没有user,查询没有返回行时,Maybe调用complete。
    当数据库中有一个user时,Maybe将触发onSuccess并调用complete。
    如果在Maybe的complete调用之后user被更新,什么也不会发生。

    @Query("select * from user")
     Maybe<List<User>> getAll();
    
    
    4 最好用List<User>的形式来接受数据
    5 数据无就插入,有就更新,insert 加入OnConflictStrategy.REPLACE
    @Insert(onConflict = OnConflictStrategy.REPLACE)
      void insert(CityEntity.ContentsBean... citys);
    

    迁移问题

    如果数据库需要版本更新时,需要写迁移。

    需要用到,因为测试发现如果没有这句,版本更新后,如加了版本号。没有迁移,数据库操作没反应。加入后。如果更新版本,没有加入迁移,则会删除所有数据。

    fallbackToDestructiveMigration()//如果更新版本,没有加入迁移,则会删除所有数据
    

    场景测试
    注意MIGRATION_3_4没有

    .addMigrations(MIGRATION_1_2, MIGRATION_2_3, MIGRATION_4_5, MIGRATION_5_6)
    

    如果用户当前数据库版本是1,更新了一个3版本的数据库,
    用执行:MIGRATION_1_2,MIGRATION_2_3

    如果用户当前数据库版本是1,更新了一个4版本的数据库,
    没执行任何迁移。会销毁重建数据库

    如果用户当前数据库版本是1,更新了一个6版本的数据库,
    没执行任何迁移。会销毁重建数据库

    所以遇到没有更新版本对应的迁移时,不执行任何迁移。

    相关文章

      网友评论

        本文标题:Android---Google Room数据库

        本文链接:https://www.haomeiwen.com/subject/espbhftx.html