Flyway简介

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

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

Flyway支持的数据库很多，从官网摘抄如下：

Supported databases are Oracle, SQL Server (including Amazon RDS and Azure SQL Database), Azure Synapse (Formerly Data Warehouse), DB2, MySQL (including Amazon RDS, Azure Database & Google Cloud SQL), Aurora MySQL, MariaDB, Percona XtraDB Cluster, TestContainers, PostgreSQL (including Amazon RDS, Azure Database, Google Cloud SQL & Heroku), Aurora PostgreSQL, Redshift, CockroachDB, SAP HANA, Sybase ASE, Informix, H2, HSQLDB, Derby, Snowflake, SQLite and Firebird.

更多的特性，可直接在官网上查询，这里不再一一罗列。

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，代码保存我的Github仓库。

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

  1. <!--引入flyway-->
  2. <dependency>
  3.     <groupId>org.flywaydb</groupId>
  4.     <artifactId>flyway-core</artifactId>
  5.     <version>6.1.0</version>
  6. </dependency>

2、添加Flyway配置：

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

3、根据在配置文件的脚本存放路径的配置，在resource目录下建立文件夹db/migration。

4、添加需要运行的sql脚本。sql脚本的命名规范为：V+版本号(版本号的数字间以”.“或”_“分隔开)+双下划线(用来分隔版本号和描述)+文件描述+后缀名，例如：V20201100__create_user.sql。如图所示：

Flyway使用入门 - 图1

5、启动项目。启动成功后，在数据库中可以看到已按照定义好的脚本，完成数据库变更，并在flyway_schema_history表插入了sql执行记录：

Flyway使用入门 - 图2
创建成功的表

Flyway使用入门 - 图3
sql执行记录