Homepage

https://flywaydb.org/documentation/

Flyway 简介

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

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

Flyway 是如何工作的

Flyway 工作流程如下：

1. 项目启动，应用程序完成数据库连接池的建立后，Flyway 自动运行。
2. 初次使用时，Flyway 会创建一个 flyway_schema_history 表，用于记录 sql 执行记录。
3. Flyway 会扫描项目指定路径下(默认是 classpath:db/migration )的所有 sql 脚本，与 flyway_schema_history 表脚本记录进行比对。如果数据库记录执行过的脚本记录，与项目中的 sql 脚本不一致，Flyway 会报错并停止项目执行。
4. 如果校验通过，则根据表中的sql记录最大版本号，忽略所有版本号不大于该版本的脚本。再按照版本号从小到大，逐个执行其余脚本。

在 SpringBoot 项目使用 Flyway
以下演示如何在 SpringBoot 项目中使用 Flyway。

1. 初始化一个 SpringBoot 项目，引入 MySQL 数据库驱动依赖等，并且需要引入 Flyway 依赖：

<!--引入flyway-->
<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-core</artifactId>
    <version>6.1.0</version>
</dependency>

2. 添加 Flyway 配置：

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

3. 根据在配置文件的脚本存放路径的配置，在resource目录下建立文件夹db/migration
4. 添加需要运行的sql脚本。sql脚本的命名规范为：V+版本号(版本号的数字间以”.“或”_“分隔开)+双下划线(用来分隔版本号和描述)+文件描述+后缀名，例如：V0.7.5__init.sql。如图所示：
   image.png
5. 启动项目。启动成功后，在数据库中可以看到已按照定义好的脚本，完成数据库变更，并在flyway_schema_history表插入了sql执行记录：
   image.png