springboot整合flyway在启动时执行SQL脚本

最近在看公司项目的时候发现使用到了了flyway，于是花时间学习了一下，发此文章总结一下。

第一步：pom.xml中添加依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.9</version>
        <relativePath/>
    </parent>

    <groupId>cn.edu.sgu.www</groupId>
    <artifactId>mhxysy</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <properties>
        <java.version>1.8</java.version>
        <flyway.version>8.0.5</flyway.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--flyway-->
        <dependency>
            <groupId>org.flywaydb</groupId>
            <artifactId>flyway-core</artifactId>
            <version>${flyway.version}</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>

            <!--flyway插件-->
            <plugin>
                <groupId>org.flywaydb</groupId>
                <artifactId>flyway-maven-plugin</artifactId>
                <version>5.2.4</version>
                <configuration>
                    <url>jdbc:mysql://localhost:3306/mhxysy?characterEncoding=utf-8&amp;useSSL=false&amp;serverTimezone=Asia/Shanghai</url>
                    <user>root</user>
                    <password>root</password>
                    <driver>com.mysql.jdbc.Driver</driver>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

添加flyway插件之后可以方便的运行sql脚本，如下图，点击migrate会执行一次脚本

第二步：application.yml中添加配置，前提是已经配置数据源

spring:
  flyway:
    # 是否启用flyway
    enabled: true
    encoding: UTF-8
    validate-on-migrate: true
    baseline-on-migrate: true
    # sql脚本文件名称的分隔符
    sql-migration-separator: __
    # 执行的脚本位置
    locations: classpath:db/migration

第三步，在resources目录下新建db目录，并在db目录下新建migration目录

 第三步：把项目的数据库最新数据导出，放在db/migration目录下，并命名为V版本号__数据库名.sql（如V20221111__mhxysy.sql）

第四步：启动项目

如果看到打印了以上日志，说明脚本执行成功了

注意：只有在第一次启动时会执行脚本，之后相同的脚本不会再次执行，可以通过flyway的插件主动执行一次SQL脚本；也可以通过删除数据库中的flyway_schema_history表或者表中的相应脚本执行成功的记录让项目下次启动时会再次执行一次脚本。