Spring Boot 集成 Flyway，数据库也能做版本控制，太牛逼了！

布满荆棘的人生 2022-10-11 00:53 248阅读 0赞

## 一、Flyway 是什么？ ##

![20210629145600539.png][]

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

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

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

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

官网：[https://flywaydb.org/][https_flywaydb.org]

**支持的数据库：**

![20210629145600754.png][]

**支持的运行方式：**

![2021062914560125.png][]

**支持的 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 也是[约定大于配置的思想][Link 1]，以上 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 脚本内容就不贴上来了，完整的示例代码已提交 Github：

> [https://github.com/javastacks/spring-boot-best-practice][https_github.com_javastacks_spring-boot-best-practice]

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

##### 1）首次启动 #####

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

![20210629145601245.png][]

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

![20210629145601475.png][]

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

![20210629145601748.png][]

##### 2）不修改再次启动 #####

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

![20210629145601927.png][]

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

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

##### 3）修改再次启动 #####

我们再新增两个 SQL 脚本：

*  V1.0.3\_\_alter\_javastack.sql
 *  V1.0.4\_\_update\_javastack.sql

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

我们再次启动下：

![20210629145602105.png][]

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

查看数据库：

![20210629145602324.png][]

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

#### 2、创建重复迁移脚本 ####

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

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

> R\_\_ .sql

**R（Repeated），即：可重复的。**

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

*  R\_\_update\_javastack.sql

##### 1）首次启动 #####

我们再次启动下：

![20210629145602491.png][]

![20210629145602754.png][]

![20210629145603206.png][]

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

##### 2）不修改再次启动 #####

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

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

![20210629145603427.png][]

显示没有迁移的必要！！

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

##### 3）修改再次启动 #####

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

![20210629145603703.png][]

![20210629145604130.png][]

![20210629145604462.png][]

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

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

![20210629145604679.png][]

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

## 四、迁移流程 ##

**OK，我们来梳理下迁移流程：**

1）Flyway 会扫描配置的脚本目录下的脚本文件；

2）如果历史记录表不存在，则新建历史记录表；

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

4）如果是可重复执行脚本（R），检查脚本是否有变动，有变动的可重复脚本才会被执行迁移；

**Flyway Migrate 迁移流程图：**

![来源官网][20210629145604833.png]

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

## 五、总结 ##

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

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

本文只是抛砖引玉，只介绍了 Flyway 中的 Migrate（迁移）环节，也是 Flyway 最主要的环节，另外还有其他 6 个环节，后续栈长在时间再进行分享，请陆续关注公众号Java技术栈，公众号第一时间推送。

本文完整示例代码已上传 Github：

> [https://github.com/javastacks/spring-boot-best-practice][https_github.com_javastacks_spring-boot-best-practice]

更多细节可以参考官方文档：

> [https://flywaydb.org/documentation/][https_flywaydb.org_documentation]

最后，你们有使用 Flyway 或者相关工具吗？欢迎分享使用经验～

觉得我的文章对你用收获的话，动动小手，给个在看、转发，原创不易，栈长需要你的鼓励。

> 版权申明：本文系公众号 "Java技术栈" 原创，原创实属不易，转载、引用本文内容请注明出处，禁止抄袭、洗稿，请自重，尊重大家的劳动成果和知识产权，抄袭必究。

**近期热文推荐：**

1.[1,000+ 道 Java面试题及答案整理(2021最新版)][1_000_ _ Java_2021]

2.[终于靠开源项目弄到 IntelliJ IDEA 激活码了，真香！][IntelliJ IDEA]

3.[阿里 Mock 工具正式开源，干掉市面上所有 Mock 工具！][Mock _ Mock]

4.[Spring Cloud 2020.0.0 正式发布，全新颠覆性版本！][Spring Cloud 2020.0.0]

5.[《Java开发手册（嵩山版）》最新发布，速速下载！][Java]

觉得不错，别忘了随手点赞+转发哦！

[20210629145600539.png]: /images/20221005/4f74863dda9a4d9cb96bd5f7e6a712fe.png
[https_flywaydb.org]: https://flywaydb.org/
[20210629145600754.png]: /images/20221005/8895ae9be6fb44089152c3ed7eff869a.png
[2021062914560125.png]: /images/20221005/8e7de838e5644cdabffd99f18f21b9ec.png
[JDK 1.8]: https://mp.weixin.qq.com/s/hrLdpMFIpz9jyD0ji9kMCQ
[Spring Boot 2.5.0]: https://mp.weixin.qq.com/s/IATuerQKVZe7n-zOypIk0Q
[MySQL 8.0]: https://mp.weixin.qq.com/s/_0-GjGANsAySwaFOgQLFdg
[IntelliJ IDEA 2021.1]: https://mp.weixin.qq.com/s/eM3suN3BvBkRHZQYWfmaCA
[Link 1]: https://mp.weixin.qq.com/s/bwEUjGpanaepY7YqB0eFFQ
[https_github.com_javastacks_spring-boot-best-practice]: https://github.com/javastacks/spring-boot-best-practice
[20210629145601245.png]: /images/20221005/8276f0d1cf0f458b9edc2773e85aa326.png
[20210629145601475.png]: /images/20221005/9b661dc6c26440fb989d5e4de1044727.png
[20210629145601748.png]: /images/20221005/cc2bcaef184d44cda379c4657d743926.png
[20210629145601927.png]: /images/20221005/6a2a19ca025c4de1a7967e0998d05d5d.png
[20210629145602105.png]: /images/20221005/629c1c88e14b4a7480e9b2f54a89f0f9.png
[20210629145602324.png]: /images/20221005/d3201c954fa046f0add12dfc1619ab8d.png
[20210629145602491.png]: /images/20221005/f711f6f3ff064e548dab4d4e0029ca77.png
[20210629145602754.png]: /images/20221005/d932c0a1cd35448380266af1b865089a.png
[20210629145603206.png]: /images/20221005/01bc5befe9cf46dd94a13261e8fe1ae3.png
[20210629145603427.png]: /images/20221005/0b73cfdefb7a477898adfc8e4df41efb.png
[20210629145603703.png]: /images/20221005/5b6c3998c6de4380bd3a3b3c74a3891d.png
[20210629145604130.png]: /images/20221005/76e4a16d684e434abeba949554d6284a.png
[20210629145604462.png]: /images/20221005/5a8c348ae0544815b91bcc962998e64b.png
[20210629145604679.png]: /images/20221005/f52e1d8d382e4a5983d00d6a155a375a.png
[20210629145604833.png]: /images/20221005/5e15a32aff1e4a30a891c370d122e35a.png
[https_flywaydb.org_documentation]: https://flywaydb.org/documentation/
[1_000_ _ Java_2021]: https://www.javastack.cn/mst/
[IntelliJ IDEA]: http://www.javastack.cn/article/2020/intellij-idea-by-open-source-project/
[Mock _ Mock]: http://www.javastack.cn/article/2021/alibaba-testable-mock-released/
[Spring Cloud 2020.0.0]: http://www.javastack.cn/article/2020/spring-cloud-2020.0.0-released/
[Java]: http://www.javastack.cn/article/2020/alibaba-release-java-develop-rules-songshan/