Flyway入门

一、简介

1.1 Flyway是什么

Flyway是一款数据库迁移（migration）工具。简单点说，就是它可以很方便的在命令行中使用，或者在Java应用程序中引入，用于管理我们的数据库版本。

1.2 工作流程

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

二、SpringBoot集成Flyway

1、创建一个SpringBoot项目，并且引入mysql和flyway等依赖

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

<!-- https://mvnrepository.com/artifact/org.flywaydb/flyway-core -->
<dependency>
  <groupId>org.flywaydb</groupId>
  <artifactId>flyway-core</artifactId>
  <version>8.0.2</version>
</dependency>

<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>8.0.21</version>
</dependency>

2、添加Flyway配置（application.yml）；

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/XXX?useSSL=false&serverTimezone=UTC
    username: xxx
    password: xxx
  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、根据自己的配置文件中 flyway 脚本存放路径的配置，在resource目录下建立文件夹db/migration，也可以自己定义路径地址；

4、在配置好的路径下添加sql脚本，脚本命名规范：V[版本号]+ __（双下划线）+[文件描述].sql，如图所示：

5、启动项目。在数据库中可以看到已按照定义好的脚本，完成数据库变更，并在flyway_schema_history表插入了sql执行记录：

三、总结

以上我们就可以简单的使用SpringBoot集成Flyway，但是也是有缺陷的，例如：我们要预埋初始化数据是用flyway来实现的化会比较麻烦，会有大量的sql脚本去做数据插入操作。

当然我们还可以优化启动方案。比如说我们可以使用探针的方式指定启动那个程序内容，这样就可以实现创建表和预埋数据的功能，此方法在后期博客中会讲解。