spring集成flyway

最近给公司项目集成flyway，由于我们项目移动端使用的是spring框架，网上看了很多博客，感觉这方面的东西还是很少的，毕竟现在是springboot的天下，大多数都是springboot集成flyway。但是还是有不少公司遗留有spring框架的项目。这里就自己肝一篇，希望能帮到更多想把flyway添加到spring项目中的人。

由于使用的是spring框架。因此我们选择低版本的flyway。

flyway各个版本请到这里去找：https://mvnrepository.com/artifact/org.flywaydb/flyway-core
我们的maven使用的是阿里云的仓库，阿里云仓库中没有低版本的依赖，我们我们需要下载jar包。这里下载的是3.0版本的jar包。

下载的包需要拷贝到项目webapp/WEB-INF/lib中(web项目都会有WEB-INF这个文件夹，只需要找到你项目中web文件夹就行，web文件夹，就是文件夹上有个蓝点的，具体看下图的webapp文件夹)

 

新建资源目录resources
在其下面建立db/migration（sql文件默认读取此路径下的文件夹中的.sql文件）

在pom.xml中添加，如果不添加，resources中的文件就无法打包到war包中。

    <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*</include>
                </includes>
    </resource>

添加flyway配置类，更多配置请看源代码

package com.dt.flyway;


import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.flywaydb.core.Flyway;
import org.flywaydb.core.api.FlywayException;
import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import javax.sql.DataSource;


/**
 * @Description: flyway配置类
 * @author: 
 * @Date: 2021/7/12 15:57
 * @Copyright: Xi'an Dian Tong Software Co., Ltd. All Rights Reserved.
 * @Version 1.0
 */
public class DatabaseFlywayMigration {
    protected final static Logger log = LogManager.getLogger("DatabaseFlywayMigration");

    public void migrate() throws NamingException {
        log.info("DatabaseFlywayMigration-->migrate:flyway开始执行，准备获取数据源");
        Context context = new InitialContext();
        //获取tomcat中的数据源
        DataSource dataSource = (DataSource) context.lookup("java:comp/env/jdbc/wxi");
        log.info("DatabaseFlywayMigration-->migrate:获取数据源成功，准备执行flyway配置");
        Flyway flyway = new Flyway();
        // 设置sql脚本文件的编码
        flyway.setEncoding("UTF-8");
        flyway.setOutOfOrder(true);
        flyway.setDataSource(dataSource);
        // 设置接受flyway进行版本管理的多个数据库
        //flyway.setSchemas("flywaydemo");
        // 设置存放flyway metadata数据的表名
         flyway.setTable("flyway_schema_history");
        // 设置执行migrate操作之前的validation行为
        //flyway.setValidationMode(ValidationMode.ALL);
        // 设置当validation失败时的系统行为
        //flyway.setValidationErrorMode(ValidationErrorMode.FAIL);

        // 设置当validation失败时的系统行为
        try {
            flyway.setInitOnMigrate(true);
            log.info("DatabaseFlywayMigration-->migrate:配置成功,即将执行sql语句");
            flyway.migrate();
            log.info("DatabaseFlywayMigration-->migrate:sql语句执行成功,flyway---END");
        } catch (FlywayException e) {
            log.error("DatabaseFlywayMigration-->migrate:执行sql语句失败,请查看日志排查错误");
            flyway.repair();
            e.printStackTrace();
        }
    }
}

在spring的xml中注入flyway配置类的bean(每个spring项目都会带有一个xml文件，用来注册bean，复制的时候注意项目中DatabaseFlywayMigration所在的路径)

 <!-- flayway -->
<bean id="flywayMigration1" class="com.dt.flyway.DatabaseFlywayMigration" lazy-init="false" init-method="migrate"> </bean>

到这里，移动端整合flyway就完成了。
以后这些sql语句，只需要放到resources/db/migration文件夹下面即可(但是这些sql命名都是不符合flyway的，需要进行名称的修改)

命名规则:
此处的SQL语句命名需要遵从一定的规范，否则运行的时候flyway会报错。命名规则主要有两种：

    仅需要被执行一次的SQL命名以大写的”V”开头，后面跟上”0~9”数字的组合,数字之间可以用“.”或者下划线”“分割开，然后再以两个下划线 _ 分割，其后跟文件名称，最后以.sql结尾。比如，V20210707__create_user.sql、V20210707__add_user.sql。
    可重复运行的SQL，则以大写的“R”开头，后面再以两个下划线分割，其后跟文件名称，最后以.sql结尾。。比如，R__truncate_user_dml.sql。

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

V:固定大写

20210707.01：20210707是日期，后面用.01代表序号

因为flyway的执行是有个顺序的，比如你执行了V2021__create_user，有执行V2020_update_user。就会报错，原因就是2020<2021。所以我们要保证序号是依次增大。

Flyway 是如何比较两个 SQL 文件的先后顺序呢？它采用 采用左对齐原则, 缺位用 0 代替 。举几个例子：

    1.0.1.1 比 1.0.1 版本高。
    1.0.10 比 1.0.9.4 版本高。
    1.0.10 和 1.0.010 版本号一样高, 每个版本号部分的前导 0 会被忽略。

    __:这个是两个 _
    例如：
    V2.0.9__upgrade.sql
    V2.0.11__upgrade.sql
    V2.0.13__upgrade.sql
    V2.0.14__upgrade.sql