SpringBoot后端开发常用工具详细介绍——flyway数据库版本控制工具

什么是flyway

简介

为什么要使用flyway

我们在开发时往往会有这样一种情况：

进行软件开发时，在开发环境修改数据库，完成功能开发。当我们要部署到生产环境上时，需要将生产环境上的数据库手动修改为和开发环境相同的结构。但是这样的过程是由开发人员手动修改。这样就会产生：忘记修改、修改结构与开发环境不一致等问题。

那么为了解决这样的问题，我们引入了flyway这样的数据库版本控制工具。

其作用与git类似，git是针对整个项目文件进行版本控制， 而flyway是对数据库进行版本控制。

流程介绍

1）Flyway在第一次执行时，会创建一个默认名为flyway_schema_history的历史记录表。这张表会用来跟踪或记录数据库的状态
2）每次项目启动时都会自动扫描脚本目录 classpath:db/migration下的脚本文件，通过查询flyway_schema_history来判断是否为新增文件，从而判断是否进行迁移
3）如果历史记录表不存在，则新建历史记录表；
4）如果是一次性执行脚本（V），按版本号从小到大执行迁移脚本，与当前历史表中的版本号做对比，大于当前版本号的脚本才会被执行迁移；
5）如果是可重复执行脚本（R），检查脚本是否有变动，有变动的可重复脚本才会被执行迁移，R的命名不带版本号

flyway_schema_history结构如下：

整合springboot

添加pom文件

<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-mysql</artifactId>
    <version>10.19.0</version>
</dependency>

配置flyway

  flyway:
	# 是否启用
    enabled: true
    # 编码格式
    encoding: UTF-8
    # 迁移sql脚本文件存放路径，映射到resource/db/migration
    locations: classpath:db/migration
    # 迁移sql脚本文件名称的前缀，默认V
    sql-migration-prefix: V
    # 迁移sql脚本文件名称的分隔符，默认2个下划线__
    sql-migration-separator: __
    # 迁移sql脚本文件名称的后缀，默认sql
    sql-migration-suffixes: .sql
    # 迁移时是否进行校验，默认true
    validate-on-migrate: true
    # 当迁移发现数据库非空且存在没有元数据的表时，自动执行基准迁移，新建schema_version表
    baseline-on-migrate: true

向resource/db/migration添加sql文件

命名规则按照配置文件中设定的

例如V1.0.0__init_database.sql，注意第一个V1.0.0后面的下划线为两个下划线

注意事项

注意以下事项，否则均会出现报错：

1. 已经执行过的迁移文件(V)不能修改。

2. 版本号不能相同

3. 删除已经执行过的迁移

1. 迁移报错

删除flyway_schema_history中的脚本执行记录，否则就会报错

2. 迁移顺序

以V为前缀的单次迁移文件先进行执行，接着执行以R为前缀的迁移文件

在这个过程中均按照版本号大小从小往大执行

任意版本出现错误，之后的文件均不执行

参考

Flyway详解（使用说明及避坑指南、一文搞懂flyway）-CSDN博客

数据库版本管理框架-Flyway（从入门到精通）_wx665832b7aafe8的技术博客_51CTO博客