Flyway介绍和使用

article/2025/11/10 9:05:33

一使用背景

在我们日常产品发布的过程中，代码的版本控制可以使用git、svn工具实现。对于数据库每当发布时会出现手动执行sql脚本进行升级数据库，中间经常出现一些漏写、错写情况，对数据库的版本与代码的版本不匹配，导致上线后出现数据库不同步的问题。flyway就是对数据库版本进行控制的工具，可以对不同环境的sql进行迁移操作。

二简单介绍

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

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

三工作原理

当 Flyway 连接数据库中的 schema 后，会先检查是否已存在 flyway_schema_history 表，如果没有则创建。该表用于跟踪数据库的状态，如数据迁移的版本，迁移成功状态等信息。

当 flyway_schema_history 存在后，Flyway 会扫描文件系统或应用中的 classpath 目录的数据迁移文件，然后根据它们的版本号进行按序迁移。

flyway_schema_history 表记录的内容如下：

由于 flyway_schema_history 表中记录了迁移的版本号，如果文件的版本号小于或等于标记为当前版本的版本号，则忽略它们不执行。

四配置流程

1 引入依赖

  <dependency><groupId>org.flywaydb</groupId><artifactId>flyway-core</artifactId><version>6.1.0</version></dependency>
复制代码

2 application.yml中添加相关配置

spring:# 数据库连接配置datasource:driver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://localhost:3306/flyway-demo?characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghaiusername: rootpassword: rootflyway:# 是否启用flywayenabled: true# 编码格式，默认UTF-8encoding: UTF-8# 迁移sql脚本文件存放路径，默认db/migrationlocations: classpath:db/migration# 迁移sql脚本文件名称的前缀，默认Vsql-migration-prefix: V# 迁移sql脚本文件名称的分隔符，默认2个下划线__sql-migration-separator: __# 迁移sql脚本文件名称的后缀sql-migration-suffixes: .sql# 迁移时是否进行校验，默认truevalidate-on-migrate: true# 当迁移发现数据库非空且存在没有元数据的表时，自动执行基准迁移，新建schema_version表baseline-on-migrate: true
复制代码

3 创建脚本存放文件夹

根据上面配置文件中的脚本存放路径，我们需要在resource目录下建立文件夹 db/migration

4 添加sql脚本

命名规则主要有两种：仅需要被执行一次的SQL命名以大写的"V"开头，V+版本号(版本号的数字间以”.“或”_“分隔开)+双下划线(用来分隔版本号和描述)+文件描述+后缀名。例如：  V20201100__create_user.sql、V2.1.5__create_user_ddl.sql、V4.1_2__add_user_dml.sql  。
可重复运行的SQL，则以大写的“R”开头，后面再以两个下划线分割，其后跟文件名称，最后以.sql结尾。（不推荐使用）比如： R__truncate_user_dml.sql 。其中，V开头的SQL执行优先级要比R开头的SQL优先级高。
复制代码

五插件配置

1 配置插件

在上面的配置中，以上步骤中，每次想要migration都需要运行整个springboot项目，并且只能执行migrate一种命令，其实flyway还是有很多其它命令的。maven插件给了我们不需要启动项目就能执行flyway各种命令的机会。

在pom.xml中引入flyway的插件，同时配置好对应的数据库连接。

<build><plugins><plugin><groupId>org.flywaydb</groupId><artifactId>flyway-maven-plugin</artifactId><version>5.2.4</version><configuration><url>jdbc:mysql://localhost:3306/flyway-demo?characterEncoding=utf-8&amp;useSSL=false&amp;serverTimezone=Asia/Shanghai</url><user>root</user><password>root</password><driver>com.mysql.cj.jdbc.Driver</driver></configuration></plugin></plugins>
</build>
复制代码

2 命令说明