有关DBFlow的Migration的几个细节

个人原创，转载请注明出处：https://www.jianshu.com/p/ff4fbbda2cd6

概述

DBFlow作为一款结合了简易性与高效率的开源数据库框架，深受不少android开发者的喜爱。我之前的一个app也采用了这款框架。最近app更新，需要升级数据库。在不需要改变表的结构的情况下，DBFlow的升级操作十分简单，只需要改一下版本号就行了。可不巧我这次的更新偏偏有涉及到对表的结构的修改，这样一来就要用到DBFlow的Migration功能，查阅了一下官方文档，发现有除了对数据本身的操作外，支持的修改数据库结构操作很有限（只支持对table的重命名和新增column），一些细节也讲的不是很清楚，以下都是我个人的几个实测（踩坑）。

Migration的触发时机与执行顺序

DBFlow支持同时定义多个Migration，所有的Migration的触发时机都是在第一次对数据库进行操作时触发的（而不是Application或是MainActivity创建时）。至于多个Migration的执行顺序，先上代码：

@Database(version = 4)
public class AppDatabase {

    @Migration(version = 2, database = AppDatabase.class, priority = 0)
    public static class Migration1 extends BaseMigration {

        @Override
        public void migrate(DatabaseWrapper database) {
          // run some code here
          SQLite.update(Employee.class)
            .set(Employee_Table.status.eq("Invalid"))
            .where(Employee_Table.job.eq("Laid Off"))
            .execute(database); // required inside a migration to pass the wrapper
        }
    }
    @Migration(version = 4, database = AppDatabase.class, priority = 0)
    public static class Migration2 extends BaseMigration {

        @Override
        public void migrate(DatabaseWrapper database) {
          // run some code here
          ...
        }
    }
}

1. 数据库的版本会由低到高逐步升级，即假设之前的数据库版本为1，要升级的版本为4，那么该段代码会先执行Migration1将版本升级到2，再执行Migration2将版本升级到4。
2. 只有@Migration里version高于原数据库版本的Migration会执行，即如果之前的版本为3，那么该段代码只会执行Migration2。
3. 在version相同时，由priority决定执行顺序，priority高的先执行，如果version和priority都相同，则顺序不确定（尽量避免），取决于哪个class先被找到。
4. Migration只对已有的旧版本数据库有效，新创建的数据库不会执行任何version > 0的Migration。

version = 0的Migration

DBFlow专门设计了version=0的Migration，用于数据库的初始化。如果定义了这种Migration，则每次数据库创建时都会自动调用该Migration，并且之后版本号为最新，不会在调用其他version的Migration。例如以下代码：

@Database(version = 3)
public class AppDatabase {

    @Migration(version = 0, database = AppDatabase.class)
    public static class Migration0 extends BaseMigration {

        @Override
        public void migrate(DatabaseWrapper database) {
          // run some code here
          SQLite.update(Employee.class)
            .set(Employee_Table.status.eq("Invalid"))
            .where(Employee_Table.job.eq("Laid Off"))
            .execute(database); // required inside a migration to pass the wrapper
        }
    }
    @Migration(version = 3, database = AppDatabase.class)
    public static class Migration1 extends BaseMigration {

        @Override
        public void migrate(DatabaseWrapper database) {
          // run some code here
          ...
        }
    }
}

如果是第一次创建数据库，那么只会执行Migration0，反之如果之前有旧版数据库（version一般大于0），那么只会执行Migration1。

Migration里的Transaction

利用DBFlow的Transaction来进行数据库的批量操作非常简单，尤其是速度最快的FastStoreModelTransaction，非常适合用来进行数据库创建和升级时的初始化录入数据。如

FastStoreModelTransaction transaction = FastStoreModelTransaction
                    .saveBuilder(FlowManager.getModelAdapter(Knife.class))
                    .addAll(allKnives).build();
FlowManager.getDatabase(AppDatabase.class).executeTransaction(transaction);

不过，如果用version = 0的Migration来初始化就不能这么写，会报错，属于循环调用数据库。正确的写法是：

@Database(version = 3)
public class AppDatabase {

    @Migration(version = 0, database = AppDatabase.class)
    public static class Migration0 extends BaseMigration {

        @Override
        public void migrate(DatabaseWrapper database) {
            FastStoreModelTransaction transaction = FastStoreModelTransaction
                    .insertBuilder(FlowManager.getModelAdapter(Knife.class))
                    .addAll(allKnives).build();
            transaction.execute(database);
        }
    }
}

对数据库的其他结构性操作

这就需要SQL的知识了，基本都是通过database.execSQL(SQLExpression)来进行。比如删除column，需要用execSQL先创建一张临时表存原数据，然后删除原表，再新建一张与原表名称相同的不包含要删的column的新表，最后再将临时表的数据录入新表中。很麻烦是吧？这也是DBFlow目前为止不是很人性化的一点问题（相比之下Litepal在这点上就做的很好，虽然性能上略差一些）。