从零搭建开发脚手架 Spring Boot集成Flyway实现数据库版本管理

Flyway是一款数据库版本控制管理工具，支持数据库版本自动升级。

• 项目初始化的时候，往往都是要先手动执行数据库脚本。
• 在开发过程当中，数据结构或者数据有更新时，往往都要手动执行脚本同步开发环境、测试环境。

现在我们就可以使用flyway来帮我们自动的去完成这个工作。

Flyway集成和使用

添加依赖

 
  org.flywaydb  
  flyway-core 
 

 

由于是Spring Boot项目集成，版本直接使用默认的即可

配置文件

spring: 
  flyway: 
    #是否开启flyway，默认true 
    enabled: true 
    #当迁移时发现目标schema非空，而且没有元数据的表时，（即迭代中项目）是否自动执行基准迁移，默认false. 
    baseline-on-migrate: true 
    # 是否允许无序运行迁移, 默认false，建议开发环境开启，生成环境关闭 
    out-of-order: true 
    #设定SQL脚本的目录,可以配置多个，比如为classpath:db/migration,filesystem:/sql-migrations,默认classpath:db/migration 
    locations: 
      - classpath:db/migration 

更多参数见 https://flywaydb.org/documentation/configfiles

“这些参数配到springboot2 项目中, 需要加上 spring前缀

脚本

在resource目录下面建立db.migration目录，放置sql文件

sql脚本的格式：

• V/R+版本号+双下划线+描述+结束符：
  • 例如：V20190429.1530__t_user_update.sql (开发环境:建议日期+时分秒)
  • 例如：V1.1__init.sql(生产环境:建议把上面的脚步合并用版本号)

测试

默认情况下，Spring Boot在应用程序启动时自动运行Flyway数据库迁移。

结果如下：

注意：

Flyway社区版不支持MySQL5.7以下的版本了

https://flywaydb.org/documentation/database/mysql

原理

Flyway 需要在 DB 中先创建一个 metdata 表 (缺省表名为 flyway_schema_history), 在该表中保存着每次迁移的记录, 记录包含迁移脚本的版本号和 SQL 脚本的 checksum 值. 当一个新的 SQL 脚本被扫描到后, Flyway 解析该 SQL 脚本的版本号, 并和 metadata 表已执行的迁移对比, 如果该 SQL 脚本版本更新的话, 将在指定的 DB 上执行该 SQL 文件, 否则跳过该 SQL 文件.

两个 flyway 版本号的比较, 采用左对齐原则, 缺位用 0 代替. 举例如下:

• 1.2.9.4 比 1.2.9 版本高.
• 1.2.10 比 1.2.9.4 版本高.
• 1.2.10 和 1.2.010 版本号一样高, 每个版本号部分的前导 0 会被忽略.

Flyway SQL 文件可以分为两类:

• Versioned ：用于版本升级, 每个版本有唯一的版本号并只能 apply 一次
• Repeatable ：指可重复加载的 migration, 一旦 SQL 脚本的 checksum 有变动, flyway 就会重新应用该脚本. 它并不用于版本更新, 这类的 migration 总是在 versioned migration 执行之后才被执行

默认情况下, Migration SQL的命名规则如下图:

img

其中的文件名由以下部分组成，除了使用默认配置外，某些部分还可自定义规则.

• prefix: 可配置，前缀标识，默认值 V 表示 Versioned, R 表示 Repeatable
• version: 标识版本号, 由一个或多个数字构成, 数字之间的分隔符可用点.或下划线_
• separator: 可配置, 用于分隔版本标识与描述信息, 默认为两个下划线__
• description: 描述信息, 文字之间可以用下划线或空格分隔
• suffix: 可配置, 后续标识, 默认为.sql*

Flyway 的 metadata 表结果如下:

CREATE TABLE  flyway_schema_history 
    ( 
        installed_rank INT NOT NULL, 
        version VARCHAR(50), 
        description VARCHAR(200) NOT NULL, 
        type VARCHAR(20) NOT NULL, 
        script VARCHAR(1000) NOT NULL, 
        checksum INT, 
        installed_by VARCHAR(100) NOT NULL, 
        installed_on TIMESTAMP DEFAULT CURRENT_TIMESTAMP, 
        execution_time INT NOT NULL, 
        success TINYINT(1) NOT NULL, 
        PRIMARY KEY (installed_rank), 
        INDEX flyway_schema_history_s_idx (success) 
    ) 
    ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; 

高级

基于Java的迁移回调

Flyway使我们能够使用两种不同的方法(Java或SQL)创建回调。前者是最灵活的一种。它为我们提供了执行任意代码的自由。

核心代码如下：

import lombok.extern.slf4j.Slf4j; 
import org.flywaydb.core.api.callback.BaseCallback; 
import org.flywaydb.core.api.callback.Context; 
import org.flywaydb.core.api.callback.Event; 
import org.flywaydb.core.internal.jdbc.JdbcTemplate; 
import org.springframework.context.annotation.Configuration; 
 
import java.sql.SQLException; 
 
@Configuration 
@Slf4j 
public class ExampleFlywayCallback extends BaseCallback { 
    @Override 
    public void handle(Event event, Context context) { 
        switch (event) { 
            // 在每次成功迁移后触发。此事件将在与迁移相同的事务中触发 
            case AFTER_EACH_MIGRATE: 
                log.info("{},", event); 
                final JdbcTemplate jdbcTemplate = new JdbcTemplate( 
                        context.getConnection()); 
 
                // Create 10 random users 
                for (int i = 1; i <= 10; i++) { 
                    try { 
                        jdbcTemplate.execute(String.format("insert into test_user" 
                                + " (username, first_name, last_name) values" 
                                + " ('%d@reflectoring.io', 'Elvis_%d', 'Presley_%d')", i, i, i)); 
                    } catch (SQLException throwables) { 
                        throwables.printStackTrace(); 
                    } 
                } 
        } 
    } 
} 

我们可以在Java迁移回调中执行所需的任何逻辑，可以灵活地实现更多变态需求。

参考：

https://www.cnblogs.com/harrychinese/p/springboot_flyway.html

 

https://blog.csdn.net/qq_38455201/article/details/103493041