使用Flyway进行数据库版本控制

1.flyway介绍

Flyway 是一款开源的数据库版本管理工具。它可以很方便的在命令行中使用，或者在Java应用程序中引入，用于管理和自动化数据库结构的变更。它可以跟踪和管理数据库的版本控制，并在应用程序启动时自动执行升级或回滚操作。

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

使用Flyway，你可以将数据库的变更以可重复且可控的方式应用到不同环境中，如开发、测试和生产环境。它支持多种数据库系统，包括MySQL、Oracle、PostgreSQL、SQL Server等。

Flyway将数据库结构的变更定义为一系列迁移脚本，通常是SQL脚本文件。每个迁移脚本都有一个唯一的版本号，Flyway会按照版本号的顺序依次执行这些脚本，以达到数据库结构的变更和更新。当应用程序启动时，Flyway会自动检测并执行未应用的迁移脚本，将数据库升级到最新版本。如果需要回滚到之前的版本，Flyway也提供了回滚操作的支持。

flyway官方文档：

Flyway Documentation - Flyway - Product Documentation (red-gate.com)

2.为什么要使用flyway

在多人开发的项目中，我们都习惯了使用SVN或者Git来对代码做版本控制，主要的目的就是为了解决多人开发代码冲突和版本回退的问题。

其实，数据库的变更也需要版本控制，在日常开发中，我们经常会遇到下面的问题：

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

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

3.Spring Boot集成Flyway

3.1.引入依赖

在项目的pom.xml文件中，添加Flyway的Maven依赖，如果是springboot 2.xx，使用5.2.1或5.2.4：

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

3.2.相关配置

在Spring Boot项目的application.properties或者application.yml文件中进行Flyway的相关配置，例如

spring:
  datasource:
      type: com.alibaba.druid.pool.DruidDataSource
      druid:
        driver-class-name: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://127.0.0.1:3306/house?useUnicode=true&allowPublicKeyRetrieval=true&characterEncoding=utf8&autoReconnect=true&useSSL=false&serverTimezone=UTC&createDatabaseIfNotExist=true
        username: root
        password: 1234
        initialize: true
  flyway:
    enabled: true #开启flyway功能，默认为true
    table: flyway_schema_history # 用于存储迁移历史记录的表名，默认为flyway_schema_history
    baseline-on-migrate: true # 当迁移数据库存在但没有元数据的表时，自动执行基准迁移，新建flyway_schema_history表
    encoding: UTF-8 # 迁移脚本编码，默认为UTF-8
    clean-on-validation-error: true
    locations: classpath:db/migration # 数据库迁移脚本的位置，默认为classpath:db/migration
    sql-migration-prefix: V # SQL迁移脚本文件名前缀，默认为V
    sql-migration-suffixes: sql # SQL迁移脚本文件名后缀，默认为.sql
    validate-on-migrate: true # 是否在迁移时验证脚本，默认为true
    check-location: false # 检测迁移脚本的路径是否存在，默认为true，如不存在，则抛出异常，如果不想抛出异常可设为flase
    # clean-disabled: true # 用于控制是否禁用 Flyway 的 clean 操作。

3.3.创建脚本路径

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

3.4.添加脚本文件

sql脚本的命名一定要规范，否则运行flyway会报错

命名规则主要有两种：

• 仅需要被执行一次的SQL命名以大写的"V"开头，V+版本号(版本号的数字间以”.“或”_“分隔开)+双下划线(用来分隔版本号和描述)+文件描述+后缀名。例如： V2.1.5__create_user_ddl.sql

• 可重复运行的SQL，则以大写的“R”开头，后面再以两个下划线分割，其后跟文件名称，最后以.sql结尾。（不推荐使用）比如： R__truncate_user_dml.sql 。

其中，V开头的SQL执行优先级要比R开头的SQL优先级高。

3.5.启动项目

启动项目后flyway回自动执行数据库脚本文件，在控制台可以看到相关日志打印，并在数据库中查看到已经创建好的表和相关记录变更。

当我们把spring.flyway.baseline-on-migrate属性设为true的时候，第一次启动项目会为我们创建flyway_schema_history表，并执行相应的脚本

下面是表的字段说明

installed_rank：已安装的迁移脚本的排名（从 1 开始）。
version：迁移脚本的版本号。
description：迁移脚本的描述。
type：迁移脚本的类型（SQL、JAVA 等）。
script：迁移脚本的文件名。
checksum：迁移脚本的校验和。
installed_by：安装迁移脚本的用户。
installed_on：安装迁移脚本的时间戳。
execution_time：执行迁移脚本所需的时间（以毫秒为单位）。
success：表示迁移脚本是否成功安装。

3.6.提示信息

如果我们修改V2__add_user.sql中的内容，再次执行的话，就会报错，提示信息如下：

[ERROR] Migration checksum mismatch for migration version 2 

如果我们修改了R__add_unknown_user.sql，再次执行的话，该脚本就会再次得到执行，并且flyway的历史记录表中也会增加本次执行的记录。

4.flyway配置清单

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

5.Flyway 工作流程

1、检测数据库状态：Flyway会连接到配置的数据库，并检测当前数据库的状态，包括已应用的迁移脚本版本和未应用的迁移脚本。

2、执行迁移脚本：Flyway会将未应用的迁移脚本按照版本号的顺序逐一执行。它会查找项目中指定的迁移脚本目录（默认为db/migration），并依次运行其中的SQL脚本。

3、更新数据库状态：每当一个迁移脚本成功执行后，Flyway会将其记录为已应用的脚本，并将其版本号存储在数据库的元数据表（ flyway_schema_history）中，以便下次启动时进行跟踪和管理。

参考文章：

Flyway 官方文档

flyway的快速入门教程_flyway使用教程-CSDN博客

Spring Boot学习：Flyway详解_springboot flyway-CSDN博客