一、Flyway 是什么?

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot

我们都知道,Git/ SVN 是代码界的版本控制工具,那么,Flyway 就是一款数据库界的版本控制工具,它可以记录数据库的变化记录。

可能很多公司都是通过人工去维护、同步数据库脚本,但经常会遇到疏忽而遗漏的情况,举个简单的例子:

我们在开发环境对某个表新增了一个字段,而提交测试时却忘了提交该 SQL 脚本,导致出现 bug 而测试中断,从而影响开发、测试的工作效率。

有了 Flyway,我们可以按版本约定,统一管理所有的 SQL 脚本变更,在所有环境自动同步数据库,而无需人为手工控制,再也不用担心因数据库不同步而导致的各种环境问题。

支持的数据库:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_02

支持的运行方式:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_03

支持的 7 个命令:

  • Migrate(迁移)
  • Clean(清理所有配置的对象)
  • Info(显示迁移状态和细节)
  • Validate(验证迁移规则)
  • Undo(撤消最近的迁移)
  • Baseline(建立基线)
  • Repair(修复迁移历史表)

二、Spring Boot 集成 Flyway

Flyway 有社区开源免费版本和商业版本,本文以开源社区免费版,以及 Java API 的运行方式为示例进行演示下 Flyway Migrate 功能。

1、引入依赖

Flyway 几乎是零依赖,最低的要求是:

  • JDK 1.7+

  • Jdbc Driver

Spring Boot 基础教程就不介绍了,栈长之前写过很多,不会的关注公众号:Java技术栈,在后台回复:boot,历史 Spring Boot 实战教程我都整理好了。

本文演示环境:

  • JDK 1.8
  • Spring Boot 2.5.0
  • MySQL 8.0
  • IntelliJ IDEA 2021.1

这里仅展示 Spring Boot 之外的核心依赖:

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jdbc</artifactId>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.21</version>
    </dependency>
    <dependency>
        <groupId>org.flywaydb</groupId>
        <artifactId>flyway-core</artifactId>
        <version>7.10.0</version>
    </dependency>
</dependencies>

2、添加配置

Spring Boot 默认提供了对 Flyway 的自动配置:

org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration

所以,Spring Boot 项目,我们仅仅只要提供对应的配置参数即可:

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/flyway
    username: flyway
    password: 12345678
  flyway:
    locations:
      - classpath:flyway
    table: t_flyway_history

版本注意:

Spring Boot 2.5 及以上版本,如果使用了 spring.flyway.url 进行定义,同时需要加上 username/ password 进行认证。

如果是第一次使用 Flyway,需要在 resources 目录下创建配置文件中指定的 Flyway 迁移目录:resources/flyway。

Flyway 也是约定大于配置的思想,以上 Flyway 的相关配置都可以不用写,可以说是零配置,它们都有默认值:

  • spring.flyway.locations: classpath:db/migration,用于扫描的迁移脚本目录
  • spring.flyway.table: flyway_schema_history,用于记录所有的版本变化记录

更多 Flyway 的参数配置可以参考这个类:

org.springframework.boot.autoconfigure.flyway.FlywayProperties

另外,最好是创建一套 Flyway 专门的数据库表和用户,和业务表、用户分开,权利最小化。

三、迁移实战

1、创建迁移脚本

然后在该目录下创建迁移脚本,迁移脚本文件命名规则是:

V__.sql

注意:版本号后面是两个下划线。

如栈长我第一次创建三个迁移脚本:

  • V1.0.0__create_javastack.sql
  • V1.0.1__insert_javastack.sql
  • V1.0.2__update_javastack.sql

首先创建一个表,然后插入几条记录,再更新记录,具体的 SQL 脚本内容就不贴上来了,

OK,Spring Boot 集成 Flyway 及相关的脚本都弄完了,可以说是不能再简单了,我们启动系统验证下脚本有没有执行。

1)首次启动

从启动日志可以看出,已经迁移了 3 个脚本,并且将当前版本更新到了 v1.0.2:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_04

查看数据库,Flyway 历史表和业务表也都已经创建:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_05

可以看出历史表记录了 3 个脚本的迁移详细记录,业务表的数据也已经插入并得到更新:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_06

2)不修改再次启动

在不修改任何代码的情况下再次启动:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_07

成功验证了 3 个迁移脚本,打印了当前的版本号,但并没有进行迁移,为什么?

因为这三个脚本都执行过迁移了,主要是版本号都小于等于当前版本号:1.0.2,所以不会进行迁移。

3)修改再次启动

我们再新增两个 SQL 脚本:

  • V1.0.3__alter_javastack.sql
  • V1.0.4__update_javastack.sql

首先新增两个字段:note 和 time,然后再进行对应的数据更新。

我们再次启动下:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_08

成功迁移,当前版本来到了 v1.0.4。

查看数据库:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_09

note 和 time 字段已经创建,并得到更新。

2、创建重复迁移脚本

从上面的例子我们知道,只要目录下的 SQL 脚本版本号大于当前版本号才会执行迁移,并且脚本都是一次性执行迁移的,如何做到可重复迁移呢?

Flyway 支持可重复迁移脚本,可重复迁移脚本文件命名规则是:

R__.sql

R(Repeated),即:可重复的。

这里我创建一个更新 note 和 time 字段的迁移脚本:

  • R__update_javastack.sql
1)首次启动

我们再次启动下:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_10

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_11

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_12

从以上截图可以看到,重复迁移脚本也已经成功执行了。

2)不修改再次启动

如何确定能否重复执行迁移呢?

我们不修改任何代码再次启动下:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_13

显示没有迁移的必要!!

那是因为我们没有对重复迁移脚本做任何的修改,所以系统不会迁移!

3)修改再次启动

我们再次改下脚本,把 note 后面加一个 ok,再次启动下:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_14

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_15

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_16

脚本经过修改后再次迁移成功了,说明可重复迁移脚本也需要经过改动才能再次进行迁移,Flyway 会进行脚本对比。

最后贴一下迁移脚本目录:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_17

这里我放到一个目录进行演示,实际开发中可以放到多个目录中区分维护。

四、迁移流程

OK,我们来梳理下迁移流程:

1)Flyway 会扫描配置的脚本目录下的脚本文件;

2)如果历史记录表不存在,则新建历史记录表;

3)如果是一次性执行脚本(V),按版本号从小到大执行迁移脚本,与当前历史表中的版本号做对比,大于当前版本号的脚本才会被执行迁移;

4)如果是可重复执行脚本(R),检查脚本是否有变动,有变动的可重复脚本才会被执行迁移;

Flyway Migrate 迁移流程图:

Spring Boot 集成 Flyway,数据库也能做版本控制,太牛逼了!_Spring Boot_18

另外,我们也可以手动删除迁移历史表中的迁移记录,这样也可以达到让一次性脚本再次执行的目的,但不建议在生产环境上进行使用。

五、总结

使用 Flyway 可以很方便的处理数据库表结果、数据的版本迁移,使用简单、自动化,大大提高生产力,再也不需要手工在控制台进行,那样更容易出错或者遗漏,毕竟人都是会经常犯错的。

本文使用的是 Java API 的方式,在项目启动时进行迁移,另外还有其他 3 种方式,文前有介绍,大家根据实际需要进行应用。