【SpringBoot】弄懂flyway前的最后几步

对于数据库迁移工具,网上开源的不少,我选择大家较为常用的flyway。它可以帮助我们在各个环境中同步数据库表结构,尤其在协同开发的过程中flyway更像git一样,对成员的数据库修改进行版本管理和执行。
对于flyway的介绍和基础使用已经有不少的教程,本文不做赘述,这里想为读者理清楚初学者容易犯迷糊的几个概念:

  • 已有项目如何引入flyway
  • flyway的checksum是在做什么
  • flyway是否可以从数据库的创建开始迁移

已有项目如何引入flyway

对于一个新起的项目,引入flyway可参考网上80%的新手教程。然而对于一个已有项目,这里所说的已有项目,指的是数据库中已经存在了table和数据,这时候我们希望把这些create、alter……操作管理起来,从而引入flyway。

与新生项目一样,在pom.xml中添加flyway的依赖,这里有个小坑,我最开始引入的是最新版本6.7.0,但是当我启动项目时,会报错FlywayCallback not present,查看源码可以发现的确缺少FlywayCallback类,我没有太纠结这个问题,直接换成5.2.4,成功!
FlywayCallback not present.png

POM.xml如下所示:
        <dependency>
            <groupId>org.flywaydb</groupId>
            <artifactId>flyway-core</artifactId>
            <version>5.2.4</version>
        </dependency>

这个依赖是为了保证我们Springboot项目可以在启动后自动进行数据库迁移等操作,但为了使用方便,我们也可以引入maven操作,通过maven-cli手动进行迁移,以方便我们开发和调试,操作方式为:在POM.xml中加入一个flyway plugin,这里的dbuser、dbpwd一系列参数可在<properties></properties>中提前定义作为变量传入:

            <plugin>
                <groupId>org.flywaydb</groupId>
                <artifactId>flyway-maven-plugin</artifactId>
                <version>5.2.4</version>
                <configuration>
                    <user>${dbuser}</user>
                    <password>${dbpwd}</password>
                    <driver>com.mysql.cj.jdbc.Driver</driver>
                    <url>jdbc:mysql://${dbhost}:${dbport}/${dbname}?characterEncoding=utf8</url>
                    <table>flyway_schema_history</table>
                </configuration>
            </plugin>

接下来我们激活flyway,仅需要配置项进行配置即可:

#application.properties
spring.flyway.clean-disabled=true
spring.flyway.enabled=true
spring.flyway.encoding=UTF-8
spring.flyway.locations=classpath:db/migration
spring.flyway.table=flyway_schema_history
spring.flyway.baseline-on-migrate=true
spring.flyway.baseline-version=20190923105701

spring.flyway.clean-disabled=true:首先需要强调一点,在生产环境上必须关闭flyway:clean指令,因为一旦误操作,所有数据将会被清空;
spring.flyway.enable=true:打开flyway,使得每次程序启动的时候都会尝试去迁移数据。这当然是好的,可以避免因为数据库变动导致项目运行失败;
spring.flyway.locations=classpath:db/migration:我们需要将指定项目中需要迁移的sql文件在哪个位置,在springboot项目中classpath指的是resource文件夹;
spring.flyway.table=flyway_schema_history:当flyway第一次运行时,会在我们对应的数据库中新建一个记录脚本运行情况的table,如果不设置,默认就是flyway_schema_history,当然也可以定义其他名字;
spring.flyway.baseline-on-migrate=true:对于已经存在的项目,数据库中存在数据,这个时候我们需要通过设置baseline告诉flyway,这个baseline及之前的sql脚本都不要执行了(否则会报重复的错误);
spring.flyway.baseline-version=20190923105701:配合上一条配置,告诉系统具体baseline版本号,包括这条版本号在内的之前所有sql脚本,都不会在迁移时执行。

flyway的checksum是在做什么

我们先认识一下flyway_schema_history:


flyway_schema_history

官网已经说的很清楚,flyway获取flyway_schema_history中最新成功记录的版本号(基准version),与项目中db/migration文件夹中的文件version进行比对,当version大于基准version则执行。既然通过版本号就可以完成迁移前判断,那还需要checksum做什么呢?
其实我们在使用flyway的时候,需要养成这样一个习惯,一旦执行过的sql脚本就不要去修改,如果需要对已有数据表进行增删改的操作,应该新建一个脚本执行。但是对于修改已经执行过的sql脚本,flyway也有预防,那就是checksum。每个sql脚本在执行前会将基本信息写入flyway_schema_history中,flyway会把每个脚本作为输入,通过某算法(不清楚)输出一个整数,这个数就是checksum,flyway在工作之前,会先基于baseline逐个脚本比对其数据库中的checksum值,如果计算结果不同,则会报mismatch的错误。我们做这样一个实验就很清晰:

create table school_date_configuration
(
    id          integer  not null auto_increment unique,
    date        DATE not null,  //去掉not null
    weekday     integer,
    school_id   integer,
    create_time DATETIME not null default current_timestamp,
    update_time DATETIME          default current_timestamp on update current_timestamp
);

这个sql脚本已经通过flyway执行,且记录在flyway_schema_history中:


修改前

当我们去掉date 字段的not null之后再次运行flyway,会出现mismatch报错:


修改后
可以想见,flyway在比对版本号之前,会先逐一比对checksum,以保证之前执行过的文件没有被修改过。
这个问题也容易解决,在命令行运行:
mvn flyway:repair

flyway会单独执行修改过的脚本,让它在数据库中生效。

flyway是否可以从数据库的创建开始迁移

就目前我的了解来看,flyway是在已有数据库的基础上,对指定数据库进行数据迁移,大家注意到,flyway的配置中需要指定数据库的相关信息(在springboot集成时,它不需要配置,是因为springboot本身会与数据库进行配置,从而将配置告诉flyway)。所以如果希望自动创建数据库,一个方式是通过java进行创建,另一种是通过容器部署项目,在容器启动之处就通过命令行脚本初始化数据库。

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

推荐阅读更多精彩内容