Spring Boot 如何集成Flyway并初始化执行 SQL 脚本？你必须要会！

👨‍🎓作者：bug菌 ✏️博客：CSDN、掘金、infoQ、51CTO等 🎉简介：CSDN|阿里云|华为云|51CTO等社区博客专家，历届博客之星Top30，掘金年度人气作者Top40，51CTO年度博主Top12，掘金 | InfoQ | 51CTO等社区优质创作者，全网粉丝合计15w+ ；硬核微信公众号「猿圈奇妙屋」，欢迎你的加入！免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料 ... ✍️温馨提醒：本文字数：1999字, 阅读完需：约 5 分钟

🏆本文收录于《Spring Boot从入门到精通》，专门攻坚指数提升。

本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容，🚀均为全网独家首发，打造精品专栏，专栏持续更新中…欢迎大家订阅持续学习。

环境说明：Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE

 1. 前言

       在我们的认知中，我们会使用 SVN 或 Git 进行代码的版本管理。但是，我们是否好奇过，数据库也是需要进行版本管理的呢？

        在每次发版的时候，我们可能都会对数据库的表结构进行新增和变更，又或者需要插入一些初始化的数据。而我们的环境不仅仅只有一套，一般来说项目会有 dev、test、pred、prod四套环境，会对应 dev、test、prod 三个数据库。pred 环境，一般连接 prod 数据库，做准生产的验收。

        那么，就意味着我们需要对 dev、test、prodD 数据库都做一遍初始化操作。“人，是系统最大的 BUG”。很多时候，我们并不能保证像机器一样，每次都操作都正确，这就导致在不同的环境下，因为数据的每个版本的初始化，带来额外的验收成本。

        甚至说，因为我们常常是手动操作 dev 数据库，没有整理一个完整清单，保证我们在 test、prod 数据库中执行相同的操作。

        基于以上种种，如果我们能像管理代码版本一样，来管理我们的数据库版本，是不是这些问题可以得到很好的解决？答案是，绝大多数是的。

目前，技术社区已经提供了很多解决方案。比如：

• Flyway
• Liquibase
• dbdeploy
• SQL Source Control
• dbv
• MyBatis Migrations

        在 Spring Boot 项目中，提供了对 Flyway 和 Liquibase 的内置支持，所以在有数据库版本的需求时，肯定是推荐它两。

        本文，我会对 Flyway 进行深入入门学习。这样，我们在学习它的同时，可以有比较直观的使用感受，方便后续我们对它们进行选型。

        那么，具体如何集成Flyway 呢？这将又会是干货满满的一期，全程无尿点不废话只抓重点教，具有非常好的学习效果，拿好小板凳准备就坐！希望学习的过程中大家认真听好好学，学习的途中有任何不清楚或疑问的地方皆可评论区留言或私信，bug菌将第一时间给予解惑，那么废话不多说，直接开整！Fighting！！ 

2. 环境说明

本地的开发环境：

• 开发工具：IDEA 2021.3
• JDK版本： JDK 1.8
• Spring Boot版本：2.3.1 RELEASE
• Maven版本：3.8.2

3. Flyway

3.1 概念

        Flyway 是一款开源的数据库版本管理工具。它可以很方便的在命令行中使用，或者在Java应用程序中引入，用于管理我们的数据库版本。

　　在项目或产品中，很难一开始就把业务理清楚，把数据库表设计好，因此数据表也会在迭代周期不断迭代。在Java应用程序中使用Flyway，能快速有效地用于迭代数据库表结构，并保证部署到测试环境或生产环境时，数据表都是保持一致的。

具体介绍请看Flyway官方文档

3.2 依赖包

        如果你是使用的maven构建工具，那你直接将如下依赖添加到你项目的pom.xml中即可

<!-- 使用 Flyway -->
<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-core</artifactId>
</dependency>

3.3 使用flyway好处

        在多人开发的项目中，我们都习惯了使用SVN或者Git来对代码进行版本控制，主要的目的就是为了解决多人开发代码冲突和版本回退的问题。其实，数据库的变更也需要做版本控制，在日常开发中，我们经常会遇到下面的问题，比如：

1. 自己写的SQL忘了在所有环境中执行初始化；别人写的SQL我们不能确定是否都在所有环境执行过了。
2. 有人修改了已经执行过的SQL，期望再次执行。
3. 需要新增环境做数据迁移。
4. 每次发版需要手动控制先发DB版本，再发布应用版本。
5. 其它场景。

        有了flyway，这些问题都能得到很好的解决。

4. 集成Flyway

        接下来，我就带着大家实战如何集成Flyway，具有很好的教学意义，同学们认真听好好学。

4.1 引入依赖包

首先需要在 pom.xml 文件中添加相应的依赖，示例代码如下：

<!-- 使用 Flyway -->
<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-core</artifactId>
</dependency>

4.2 配置sql脚本

        然后在 application.yaml 或 application.properties 文件中配置数据库信息，并指定 SQL 脚本的位置，示例代码如下：

spring:
  flyway:
    enabled: true # 开启 Flyway 功能
    cleanDisabled: true # 禁用 Flyway 所有的 drop 相关的逻辑，避免出现跑路的情况。
    locations: # 迁移脚本目录
      classpath: db/migration # 配置 SQL-based 的 SQL 脚本在该目录下
    check-location: false # 是否校验迁移脚本目录下。如果配置为 true ，代表需要校验。此时，如果目录下没有迁移脚本，会抛出 IllegalStateException 异常
    url: jdbc:mysql://localhost:3306/springboot_db?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8 # 数据库地址
    user: root # 数据库账号
    password: 123456 # 数据库密码

注意： spring.flyway 配置项，设置 Flyway 的属性，而后可以被 FlywayAutoConfiguration 自动化配置。 每个配置项的作用，自己看下注释。 重点看下 locations 配置项，该配置设置了 SQL 迁移脚本所在目录。

4.3 定义SQL脚本

        在 resources/db/migration 目录下，创建 V1.0__INIT_DB.sql  SQL迁移脚本。具体项目位置截图如下演示：

 sql脚本代码如下：

DROP TABLE IF EXISTS `cat`;
CREATE TABLE `cat`  (
                         `id` bigint(20) NOT NULL AUTO_INCREMENT,
                         `color` varchar(64) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
                         `name` varchar(64) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
                         `age` int(11) NULL DEFAULT NULL,
                         PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 3 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;

INSERT INTO `cat` VALUES (4, 'red', '波斯猫', 30);
INSERT INTO `cat` VALUES (5, 'blue', '蓝猫', 50);
INSERT INTO `cat` VALUES (6, 'green', '蓝白', 80);

4.4 sql 脚本命名规范

        对于 V1.0__INIT_DB.sql 的命名上。Flyway 是有明确规定的，约定如下：

Prefix 前缀： V 为版本迁移，U 为回滚迁移，R 为可重复迁移。

在我们的示例中，我们使用 V 前缀，表示版本迁移。绝大多数情况下，我们只会使用 V 前缀。

Version 版本号： 每一个迁移脚本，都需要一个对应一个唯一的版本号。而脚本的执行顺序，按照版本号的顺序。一般情况下，我们使用数字自增即可。

在我们的示例中，我们使用 1.0 。

Separator 分隔符： 两个 _ ，即 __ 。可配置，不过一般不配置。

Description 描述： 描述脚本的用途。

在我们的示例中，我们使用 INIT_DB 。

Suffix 后缀： .sql 。可配置，不过一般不配置。

标准命令举例：V1.0__INIT_DB.sql、V3.0__INIT_DB.sql.等

4.5 启动项目测试

        基本配置已具备，接下来就是验证成功的关键了，我们重启项目查验FlyWay是否生效。

启动项目，执行日志如下所示：

        如果看到打印了以上日志，说明脚本执行成功了。查验下数据库也可以看到数据有被成功插入。

        从启动日志中可以看出，Flyway 监测到需要运行版本脚本来初始化数据库，因此执行了V2.0__INIT_DB.sql 脚本，从而创建了 cat 表，另外还自动创建了  flyway_schema_history 表，用于记录所有版本演化和状态，其表结构如下(以 MySQL 为例)：

        查询 flyway_schema_history 表，发现增加了一条版本号为 2.0 的，使用 V1.0__INIT_DB.sql 迁移脚本的记录。

        再次重启项目，可以看到，提示打印：Schema springboot_db is up to date. No migration necessary.意味着springboot_db是最新的，无需版本迁移。

        接下来，我们在 V1.0__INIT_DB.sql 迁移脚本中添加一条 INSERT 操作：INSERT INTO cat VALUES (7, 'pink', '粉色猫', 90);，再次启动项目，控制台会报如下错误：

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'flywayInitializer' defined in class path resource [org/springframework/boot/autoconfigure/flyway/FlywayAutoConfiguration$FlywayConfiguration.class]: Invocation of init method failed; nested exception is org.flywaydb.core.api.FlywayException: Validate failed: 
Migration checksum mismatch for migration version 2.0
-> Applied to database : -719082334
-> Resolved locally    : 1598008518

完整报错截图如下： 

        这个错误的原因就是 Flyway 会给脚本计算一个 checksum 保存在数据库中，用于在之后运行过程中对比 sql 文件是否有变化，如果发生了变化，则会报错，也就防止了误修改脚本导致发生问题。

        注意： 只有在第一次启动时会执行脚本，之后相同的脚本不会再次执行，可以通过flyway的插件主动执行一次SQL脚本；也可以通过删除数据库中的flyway_schema_history表或者表中的相应脚本执行成功的记录让项目下次启动时会再次执行一次脚本。

4.6 演示修改脚本执行 

        接下来，我们来演示一下:删除掉V2.0__INIT_DB执行成功的记录，然后在迁移脚本中再添加一条 INSERT 操作，我们重启项目查验下结果：

结果如下：很明显脚本执行成功了。

对应flyway_schema_history表中也记录生成了一条记录。

4.7 总结

• Flyway 可以有效改善数据库版本管理方式，并且是一款 Java 开源的数据库迁移管理工具，具有轻便小巧的特点，可以无门槛快速集成到项目中。
• 对于我们的Flyway要根据我们的实际情况进行我们的库表删除,不要忙目删除我们的flyway_schema_history表。

        总之，Flyway 是一款 Java 开源的数据库迁移管理工具，轻便小巧，想了解更多的可以去官网查看文档学习，这里就不一一赘述啦。

... ...

    ok，以上就是我这期的全部内容啦，如果还想学习更多，你可以看看如下的往期热文推荐哦，每天积累一个奇淫小知识，日积月累下去，你一定能成为令人敬仰的大佬。

「赠人玫瑰，手留余香」，咱们下期拜拜~~

5. 热文推荐💭

    为了便于同学快速定位文章学习，熬夜几天终于整理出了【基础篇】及【进阶篇】专栏的文章及有效地址，同学们敬请吩咐bug菌吧。

    目前基础篇已完结75篇+，进阶篇已完结45篇+，两专栏都在持续更新中；生命不息，更新不止，加油卷起来吧，同学们。部分文章总结如下：

5.1 Spring Boot【基础篇】

导读：SpringBoot 学习指南(附思维导图)

Spring Boot入门(01)：Spring Boot的奋斗成长史

Spring Boot入门(02)：快速开发环境搭建和项目启动

Spring Boot入门(03)： yaml、properties配置文件介绍及使用

Spring Boot入门(04)：多环境切换，实例演示

Spring Boot入门(05)：starter基础入门

Spring Boot入门(06)：Spring Boot常用注解大全

Spring Boot入门(07)：整合 MySQL 和 Druid数据源(两万字教学)

Spring Boot入门(08)：整合Mybatis访问MySQL实现增删改查

Spring Boot入门(09)：使用MyBatis的XML配置方式访问MySQL实现增删改查

Spring Boot入门(10)： mybatis之xml映射文件＞、＜=等特殊符号写法

Spring Boot入门(11)：Spring Boot 整合 JPA

Spring Boot入门(12)：整合Mybatis-Plus mybatis-plus实现接口增删改查

Spring Boot入门(13)： Mybatis-Plus之条件构造器使用手册

Spring Boot入门(14)： mybatis-plus之如何自定义sql

Spring Boot入门(15)：Spring Boot 整合 MyBatis-Plus AutoGenerator 自动生成项目骨架代码

Spring Boot入门(16)：Spring Boot整合Swagger-UI实现在线API文档

Spring Boot入门(17)：Spring Boot整合Knife4j，美化强化丑陋的Swagger

Spring Boot入门(18)：Spring Boot静态资源映射

Spring Boot入门(19)：Spring Boot 整合 Thymeleaf 模板引擎，开发Web页面

Spring Boot入门(20)：实现多数据源配置，开箱即用

Spring Boot入门(21)：整合Log4j2以及配置详解

Spring Boot入门(22)：整合LogBack 实现日志文件本地保存

Spring Boot入门(23)：Spring Boot基于AOP拦截日志

Spring Boot入门(24)：Spring Boot事务

Spring Boot入门(25)：过滤器、拦截器、监听器对比及使用场景

Spring Boot入门(26)：实现邮件发送简单邮件、附件邮件、嵌入资源(图片)邮件、模板邮件等

Spring Boot入门(27)：war包部

Spring Boot入门(28)：jar包部署

Spring Boot入门(29)：如何实现热部署

Spring Boot入门(30)：Windows安装Redis客户端？你玩过么

5.2 Spring Boot【进阶篇】

Spring Boot进阶(01)：Spring Boot 集成 Redis，实现缓存自由

Spring Boot进阶(02)：使用Validation进行参数校验

Spring Boot进阶(03)：如何使用MyBatis-Plus实现字段的自动填充

Spring Boot进阶(04)：如何使用MyBatis-Plus快速实现自定义sql分页

Spring Boot进阶(05)：Spring Boot 整合RabbitMq，实现消息队列服务

Spring Boot进阶(06)：Windows10系统搭建 RabbitMq Server 服务端

Spring Boot进阶(07)：集成EasyPoi，实现Excel/Word的导入导出

Spring Boot进阶(08)：集成EasyPoi，实现Excel/Word携带图片导出

Spring Boot进阶(09)：集成EasyPoi，实现Excel文件多sheet导入导出

Spring Boot进阶(10)：集成EasyPoi，实现Excel模板导出成PDF文件

Spring Boot进阶(11)：Spring Boot 如何实现纯文本转成.csv格式文件？

Spring Boot进阶(12)：Spring Boot 如何获取Excel sheet页的数量？

Spring Boot进阶(13)：Spring Boot 如何获取@ApiModelProperty(value = “序列号“, name = “uuid“)中的value值name值？

Spring Boot进阶(14)：Spring Boot 如何手动连接库并获取指定表结构？一文教会你

Spring Boot进阶(15)：根据数据库连接信息指定分页查询表结构信息

Spring Boot进阶(16)：Spring Boot 如何通过Redis实现手机号验证码功能？

Spring Boot进阶(17)：Spring Boot如何在swagger2中配置header请求头等参数信息

Spring Boot进阶(18)：SpringBoot如何使用@Scheduled创建定时任务？

Spring Boot进阶(19)：Spring Boot 整合ElasticSearch

Spring Boot进阶(20)：配置Jetty容器

Spring Boot进阶(21)：配置Undertow容器

Spring Boot进阶(22)：Tomcat与Undertow容器性能对比分析

Spring Boot进阶(23)：实现文件上传

Spring Boot进阶(24)：如何快速实现多文件上传？

Spring Boot进阶(25)：文件上传的单元测试怎么写?

Spring Boot进阶(26)：Mybatis 中 resultType、resultMap详解及实战教学

Spring Boot进阶(27)：Spring Boot 整合 kafka(环境搭建+演示)

Spring Boot进阶(28)：Jar包Linux后台启动部署及滚动日志查看，日志输出至实体文件保存

Spring Boot进阶(29)：如何正确使用@PathVariable，@RequestParam、@RequestBody等注解？不会我教你，结合Postman演示

Spring Boot进阶(30)：@RestController和@Controller 注解使用区别，实战演示

...

       若想学习更多，可以参考这篇专栏总结《2023最新首发，全网最全 Spring Boot 学习宝典(附思维导图)》，本专栏致力打造最硬核 Spring Boot 进阶系列学习内容，🚀均为全网独家首发，打造精品专栏，专栏持续更新中。欢迎大家订阅持续学习。

       在入门及进阶之途，我必助你一臂之力，系统性学习，从入门到精通，带你不走弯路，直奔终点；投资自己，永远性价比最高，都这么说了，你还不赶紧来学？？

本文涉及所有源代码，均已上传至github开源，供同学们一对一参考，github.com/luoyong0603… ，同时，原创开源不易，欢迎给个star🌟，想体验下被加Star的感jio，非常感谢 ❗

6. 文末💭

       我是bug菌，CSDN | 阿里云 | 华为云 | 51CTO 等社区博客专家，历届博客之星Top30，掘金年度人气作者Top40，51CTO年度博主Top12，掘金 | InfoQ | 51CTO等社区优质创作者，全网粉丝合计15w+ ；硬核微信公众号「猿圈奇妙屋」，欢迎你的加入！免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料。