Flyway 搭建

一、总体搭建介绍

1.1、Flyway简介

Flyway 是一款开源的数据库版本管理工具。它可以很方便的在命令行中使用，或者在Java应用程序中引入，用于管理我们的数据库版本。项目启动时，Flyway会自动运行，如果数据库中没有版本表，flyway会自动创建一个版本表，用于记录sql执行记录。flyway会根据配置的sql文件路径扫描路径下(默认是 classpath:db/migration )的所有sql脚本，与版本表脚本记录进行比对，执行新增加脚本。

官网地址：https://flywaydb.org/documentation/

1.2、选型原因

在实际的项目开发实施过程中，很少能一次性把所有表结构好，或多或少的都会有调整。使用Flyway，能很方便的管理迭代的数据库结构以及初始化数据，并且部署到每个环境都是一致的。

在实际项目中个人已知问题：
问题1、开发过程中会有数据库结构的新增、调整或者数据的初始化操作，总是忘记在各个环境执行。
问题2、每次发版，都需要先停服务，再执行sql文件，然后才能启动服务。
问题3、团队中其他开发人员如果使用到本地库，则每次都需要看看是否有最新的sql，然后手动执行。

Flayway就是为了解决上述问题，提高开发效率。

二、搭建步骤

2.1、application.yml配置

事前准备：数据库配置已经，且项目可正确启动。

# Spring配置
spring:
  flyway:
    # flyway 自动配置开启
    enabled: true
    # 版本控制表
    table: sys_schema_history
    # 禁止清理数据库表
    clean-disabled: true
    # 如果数据库不是空表，需要设置为true，否则启动报错
    baseline-on-migrate: true
    # 是否检验
    validate-on-migrate: false
    # sql脚本目录 -- 如果是默认目录（resources/db/migration），不需要指定
#    locations:
#      - classpath:db/migration

全部配置清单

//对执行迁移时基准版本的描述.
baseline-description
//当迁移时发现目标schema非空，而且带有没有元数据的表时，是否自动执行基准迁移，默认false.
baseline-on-migrate
//开始执行基准迁移时对现有的schema的版本打标签，默认值为1.
baseline-version
//检查迁移脚本的位置是否存在，默认false.
check-location
//当发现校验错误时是否自动调用clean，默认false.
clean-on-validation-error
//是否开启flywary，默认true.
enabled
//设置迁移时的编码，默认UTF-8.
encoding
//当读取元数据表时是否忽略错误的迁移，默认false.
ignore-failed-future-migration
//当初始化好连接时要执行的SQL.
init-sqls
//迁移脚本的位置，默认db/migration.
locations
//是否允许无序的迁移，默认false.
out-of-order
//目标数据库的密码.
password
//设置每个placeholder的前缀，默认${.
placeholder-prefix
//是否要被替换，默认true.
placeholder-replacementplaceholders
//设置每个placeholder的后缀，默认}.
placeholder-suffix
//设置placeholder的value
placeholders.[placeholder name]
//设定需要flywary迁移的schema，大小写敏感，默认为连接默认的schema.
schemas
//迁移文件的前缀，默认为V.
sql-migration-prefix
//迁移脚本的文件名分隔符，默认__
sql-migration-separator
//迁移脚本的后缀，默认为.sql
sql-migration-suffix
//使用的元数据表名，默认为schema_version
tableflyway
//迁移时使用的目标版本，默认为latest version
target
//迁移时使用的JDBC URL，如果没有指定的话，将使用配置的主数据源
url
//迁移数据库的用户名
user
//迁移时是否校验，默认为true
validate-on-migrate

2.2、pom.xml

pom.xml文件中增加如下配置

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

2.3、sql文件

2.3.1、sql文件命名规则

以大写的"V"开头，V+版本号(版本号的数字间以”.“或”_“分隔开)+双下划线(用来分隔版本号和描述)+文件描述+后缀名。
例如： V20220723__alter_table.sql、V1.0.1__create_table.sql、V4.1_2__add_table.sql 。

注意：版本号不能重复；版本号不能重复；版本号不能重复；

2.3.2、sql文件位置

默认位置：resources/db/migration 下，如果不是默认位置，需要在application.yml中指定自定义位置。
特别提示：创建文件夹时，必须一层一层创建，不可db.migration，正确图示如下

三、过程中可能会遇到的问题解决办法

3.1、@PostConstruct

如果项目中用到了@PostConstruct，则需要替换为@DependsOn(“flywayInitializer”)。
原因：@PostConstruct会先于flyway执行，如果数据库表结构还未初始化，启动会报错。

3.2、spring.flyway.locations[0].classpath

出现如下错误信息

Binding to target [Bindable@9ead57 type = java.util.List<java.lang.String>, value = 'provided', annotations = array<Annotation>[[empty]]] failed:

    Property: spring.flyway.locations[0].classpath
    Value: db/migration
    Origin: class path resource [application.yml] - 97:20
    Reason: The elements [spring.flyway.locations[0].classpath] were left unbound.

出现问题原因：classpath的冒号后面不要带空格。

    # sql脚本目录 -- 如果是默认目录（resources/db/migration），不需要指定
    locations:
      - classpath:db/migration

3.3、Flyway8.2.0之后不支持mysql问题

如果想使用8.2.0以后的版本，需要在pom.xml中引入依赖

<dependency>
	<groupId>org.flywaydb</groupId>
	<artifactId>flyway-mysql</artifactId>
</dependency>