有关DBFlow的Migration的几个细节

个人原创,转载请注明出处://www.greatytc.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在这点上就做的很好,虽然性能上略差一些)。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,634评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,951评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,427评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,770评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,835评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,799评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,768评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,544评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,979评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,271评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,427评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,121评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,756评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,375评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,579评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,410评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,315评论 2 352

推荐阅读更多精彩内容