flyway的快速入门教程

一、简单介绍

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

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

flyway官方文档​编辑https://flywaydb.org/documentation/

---

二、为什么要使用flyway

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

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

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

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

---

三、flyway是如何工作的

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

---

四、如何使用flyway

1、先要初始化一个SpringBoot项目，引入依赖

    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <mysql.version>8.0.25</mysql.version>
        <mybatis-starter.version>2.2.1</mybatis-starter.version>
        <flyway.version>6.1.0</flyway.version>
    </properties>
 
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
            <version>${mysql.version}</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>${mybatis-starter.version}</version>
        </dependency>
        <dependency>
            <groupId>org.flywaydb</groupId>
            <artifactId>flyway-core</artifactId>
            <version>${flyway.version}</version>
        </dependency>
    </dependencies>

2、在application.yml中添加相关配置

spring:
  # 数据库连接配置
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/flyway-demo?characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
    username: root
    password: root
  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脚本，命名一定要规范，否则运行flyway会报错

命名规则主要有两种：

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

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

创建完成后，目录应如下所示：其中2.1.6、2.1.7和every的文件夹不会影响flyway对SQL的识别和运行，可以自行取名和分类。

5、启动项目， 通过flyway执行定义好的脚本

在控制台可以看到相关日志打印，并在数据库中查看到已经创建好的表和相关记录变更。

6、提示说明

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

　[ERROR] Migration checksum mismatch for migration version 2 

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

---

五、flyway知识补充

• flyway执行migrate必须在空白的数据库上进行，否则报错。
• 尽量不要修改已经执行过的SQL，即便是R开头的可反复执行的SQL，它们会不利于数据迁移。
• 当需要做数据迁移的时候，更换一个新的空白数据库，执行下migrate命令，所有的数据库更改都可以一步到位地迁移过去。

---

六、Flyway 8.2.1及以后版本不再支持MySQL

 参考：Flyway 8.2.1及以后版本不再支持MySQL

使用Flyway 8.5.13 连接本地的 MySQL 8.0 进行测试，发现抛出了异常 

…nested exception is org.flywaydb.core.api.FlywayException: Unsupported Database: MySQL 8.0

接着逐个版本往前追溯，在8.2.0版本找到了移除的日志信息

在8.2.1版本已经找不到mysql目录了

至此，已经可以确定 flyway-core 8.2.1及以后的版本确实是不再支持MySQL。

方案一（增加依赖库）

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

方案二（指定版本）

pom.xml文件中，指定Flyway版本为最后支持MySQL的 8.2.0 版本，如下图所示