关于GreenDao你应该知道的小技巧

最新推荐文章于 2021-05-28 07:02:16 发布

没有功夫的熊猫2

最新推荐文章于 2021-05-28 07:02:16 发布

阅读量907

点赞数

分类专栏：第三方框架文章标签：数据库 GreenDao

本文链接：https://blog.csdn.net/YLSHELLO/article/details/53591260

版权

第三方框架专栏收录该内容

3 篇文章 0 订阅

订阅专栏

【前言】

相信大家在开发中已经使用过GreenDao（What? 还没用过，造起来吧，Now!），
深深地被它的轻量、便捷、迅速、高效这些魅力所吸引了吧。哈哈，本篇博客，
不是要介绍它的使用方式，也不是它的实现原理。没错，就是开发中会遇到的，
关于数据库升级后，如何保证原有数据不丢失。

【背景描述】

假设APP第一个版本，只需要一张表Student，这张表只有两个属性（除了id），name和
age。由于项目需求，要在Student表中增加属性profession，这是就需要在第二个APP
版本中升级数据库版本号。接着项目又有新需求，需增加一张表Teacher，这张表的属性
有name和age（除了id），这时需要在第三个版本的APP中升级数据库版本。
在两次的数据库版本升级中，如果只是简单的drop掉历史table，重新创建表，是可以
做到表的同步更新。但是，历史版本中的数据将会丢失，会造成极差的用户体验。

【关于DaoMaster.DevOpenHelper】

GreenDao默认生成的DaoMaster，它有个静态内部类DevOpenHelper。它的作用是
管理数据库的创建和升级。其中升级的函数onUpgrade实现如下：


@Override
   public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
       Log.i("greenDAO", "Upgrading schema from version " + oldVersion + " to " + newVersion + " by dropping all tables");
       dropAllTables(db, true);
       onCreate(db);
   }

可以看出，升级数据库时，GreenDao会调用升级数据库，drop掉所有的历史tables，
然后再重新创建所有的tables，这样就导致了历史数据丢失。

【解决思路】

需要一个数据库升级管理类，如UpgradeManager，代码实现如下：


public class UpgradeManager {

    public static void onUpgrade(SQLiteDatabase db, int oldVersion) {
        switch (oldVersion) {
            case 1:
                /**
                 * Student 表增加字段 PROFESSION
                 */
                db.execSQL("alter table Student add column PROFESSION text");


                /**
                 * 数据库增加表 Teacher
                 */
            case 2:
                TeacherDao.createTable(db, false);


            default:
                break;
        }
    }
}

说明：第一次数据库版本的升级需求是，在Student表中增加字段PROFESSION，所以
利用SQL语句的alter来给表Student增加字段。第二次数据库版本的数据需求是，
新增表Teacher，可以用GreenDao封装好的代码来创建表（当然也可以自己写原
生的SQL语句生成）。如果用户用版本2
的APP覆盖安装到版本1的APP，会从case 1开始执行。如果用户是用版本3的APP
覆盖安装了版本2的APP，这时是从case 2开始执行。这样就实现了，既保留了历史
数据，又打到了数据库升级的目的。

注意：这里的case是没有break的。因为，如果加了break，假设用户下载版本3APP
覆盖安装了版本1APP，这时执行case 1，但是没有执行case 2，导致Teacher表
没被创建。还有一个关键点就是，case的顺序必须按照每次升级数据库的需求顺序
添加。比如，第一次的需求是增加Student表字段PROFESSION，第二次需求是新增
表Teacher。

【代码调用】

UpgradeManager的onUpgrade方法是在DevOpenHelper的onUpgrade里面调用的，如下：

 
@Override
   public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
       Log.i("greenDAO", "Upgrading schema from version " + oldVersion + " to " + newVersion + " by dropping all tables");
       //dropAllTables(db, true);
       //onCreate(db);
       UpgradeManager.onUpgrade(db, oldVersion);
   }

说明：注释掉自动生成的dropAllTables和onCreate，取而代之的实调用UpgradeManager.onUpgrade。
由于每次GreenDao编译自动生成DaoMaster时，都会重新生成onUpgrade，所以
每次数据库版本升级后，要记住执行以上变更的操作（想一劳永逸的话，可以下载
GreenDao的源码，修改dao-master.flt的生成规则即可）

【代码演示】

1、需求变更前

 
public class GeneratorClass {

    public static void main(String[] args) {
        try {

            /**
             * 参数： 版本号 ：包名
             */
            Schema schema = new Schema(1, "com.jay.greendao");

            // 对应student表
            Entity student = schema.addEntity("Student");
            student.addIdProperty();
            student.addStringProperty("name").notNull();
            student.addIntProperty("age");

            /**
             * 代码生成路径，需自行设置
             */
            new DaoGenerator().generateAll(schema, "D:\\sources\\GreenDaoDemo\\app\\src\\main\\java-gen");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

注意：此时数据库的版本号为1.

然后，添加一条Student数据到表中：

 
private void insertStudent() {
       StudentDao studentDao = daoSession.getStudentDao();
       Student student = new Student();
       student.setName("jay");
       student.setAge(33);
       studentDao.insert(student);
   }

查看表Studen:

2、需求1 —— Student表新增字段PROFESSION

 
public class GeneratorClass {

    public static void main(String[] args) {
        try {

            /**
             * 参数： 版本号 ：包名
             */
            Schema schema = new Schema(2, "com.jay.greendao");
            // 对应student表
            Entity student = schema.addEntity("Student");
            student.addIdProperty();
            student.addStringProperty("name").notNull();
            student.addIntProperty("age");
            // 需求一
            student.addStringProperty("profession");
            /**
             * 代码生成路径，需自行设置
             */
            new DaoGenerator().generateAll(schema, "D:\\sources\\GreenDaoDemo\\app\\src\\main\\java-gen");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

说明：此时数据库版本号变更为2，新增了student.addStringProperty(“profession”)。

关键点来了，修改自动生成的DaoMaster.DevOpenHelper的onUpgrade，如下：

 
public static class DevOpenHelper extends OpenHelper {
    public DevOpenHelper(Context context, String name, CursorFactory factory) {
        super(context, name, factory);
    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
        Log.i("greenDAO", "Upgrading schema from version " + oldVersion + " to " + newVersion + " by dropping all tables");
//            dropAllTables(db, true);
//            onCreate(db);
        UpgradeManager.onUpgrade(db, oldVersion);
    }
}

UpgradeManager的代码如下：

 
public class UpgradeManager {

    public static void onUpgrade(SQLiteDatabase db, int oldVersion) {
        switch (oldVersion) {
            case 1:
                /**
                 * Student 表增加字段 PROFESSION
                 */
                db.execSQL("alter table Student add column PROFESSION text");
            default:
                break;
        }
    }
}

说明：此时编译生成版本2的APP，正确的情况是保留了历史数据，并且新增了PROFESSION字段：

3、需求2 —— 新增表Teacher

 
public class GeneratorClass {

    public static void main(String[] args) {
        try {

            /**
             * 参数： 版本号 ：包名
             */
            Schema schema = new Schema(3, "com.jay.greendao");
            // 对应student表
            Entity student = schema.addEntity("Student");
            student.addIdProperty();
            student.addStringProperty("name").notNull();
            student.addIntProperty("age");
            // 需求一
            student.addStringProperty("profession");

            // 需求二，新增表Teacher
            Entity teacher = schema.addEntity("Teacher");
            teacher.addIdProperty();
            teacher.addStringProperty("name").notNull();
            teacher.addIntProperty("age");
            /**
             * 代码生成路径，需自行设置
             */
            new DaoGenerator().generateAll(schema, "D:\\sources\\GreenDaoDemo\\app\\src\\main\\java-gen");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

说明：此时数据库版本号为3，新增了表Teacher。

* 别忘了修改自动生成的DaoMaster，修改跟上面的一样。 *
然后插入一条数据到Teacher表，如下：


private void insertTeacher() {
      TeacherDao teacherDao = daoSession.getTeacherDao();
      Teacher teacher = new Teacher();
      teacher.setName("Jom");
      teacher.setAge(22);
      teacherDao.insert(teacher);
  }

UpgradeManager的修改如下：


public class UpgradeManager {

    public static void onUpgrade(SQLiteDatabase db, int oldVersion) {
        switch (oldVersion) {
            case 1:
                /**
                 * Student 表增加字段 PROFESSION
                 */
                db.execSQL("alter table Student add column PROFESSION text");

                /**
                 * 数据库增加表 Teacher
                 */
            case 2:
                TeacherDao.createTable(db, false);

            default:
                break;
        }
    }
}

这时，应该保留了历史数据的同时，又新了表Teacher，

【总结】

以上的实现，可以很好的解决数据丢失问题。欢迎大家留言，相互交流学习。有关GreenDao的更多
高级用法，建议访问GreenDao官网。

没有功夫的熊猫2

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
关于GreenDao你应该知道的小技巧

【前言】相信大家在开发中已经使用过GreenDao（What? 还没用过，造起来吧，Now!），深深地被它的轻量、便捷、迅速、高效这些魅力所吸引了吧。哈哈，本篇博客，不是要介绍它的使用方式，也不是它的实现原理。没错，就是开发中会遇到的，关于数据库升级后，如何保证原有数据不丢失。【背景描述】假设APP第一个版本，只需要一张表Student，这张表只有两个属性（除了id），name和 ag
复制链接

扫一扫