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

更多参数见 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的命名规则如下图:

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

• 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

• https://docs.spring.io/spring-boot/docs/2.1.1.RELEASE/reference/html/howto-database-initialization.html

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
715236278086)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！