flyway基本使用

一.flyway简介

      Flyway 是一款开源的数据库版本管理工。在Java应用程序中引入，用于管理我们的数据库版本。

　　在项目或产品中，很难一开始就把业务理清楚，把数据库表设计好，因此数据表也会在迭代周期不断迭代。在Java应用程序中使用Flyway，能快速有效地用于迭代数据库表结构，并保证部署到测试环境或生产环境时，数据表都是保持一致的。

 

二.flyway使用的好处(解决问题)

数据库的变更也需要版本控制，在日常开发中，我们经常会遇到下面的问题：

自己写的SQL忘了在所有环境执行。
别人写的SQL我们不能确定是否都在所有环境执行过了。
有人修改了已经执行过的SQL，期望再次执行。
需要新增环境做数据迁移。
每次发版需要手动控制先发DB版本，再发布应用版本。
其它场景。
有了flyway，这些问题都能得到很好的解决。
 

三、flyway是如何工作的

flyway工作流程如下：

项目启动，应用程序完成数据库连接池的建立后，Flyway自动运行。

初次使用时，flyway会创建一个 flyway_schema_history 表，用于记录sql执行记录。

Flyway会扫描项目指定路径下(默认是 classpath:db/migration )的所有sql脚本，与 flyway_schema_history 表脚本记录进行比对。如果数据库记录执行过的脚本记录，与项目中的sql脚本不一致，Flyway会报错并停止项目执行。

如果校验通过，则根据表中的sql记录最大版本号，忽略所有版本号不大于该版本的脚本。再按照版本号从小到大，逐个执行其余脚本。

 

四.使用步骤

1.在pom.xml中引入依赖

<dependency>

  <groupId>org.flywaydb</groupId>

  <artifactId>flyway-core</artifactId>

  <version>6.1.0</version>

</dependency>

2.根据配置文件中填写的脚本存放路径，创建文件夹

根据上面配置文件中的脚本存放路径，我们需要在resource目录下建立文件夹 db/migration 

3.添加需要运行的sql脚本。sql脚本的命名一定要规范，否则运行flyway会报错。

命名规则主要有两种：

仅需要被执行一次的SQL命名以大写的"V"开头，V+版本号(版本号的数字间以”.“或”_“分隔开)+双下划线(用来分隔版本号和描述)+文件描述+后缀名。例如：  V20240420__add_user.sql
可重复运行的SQL，则以大写的“R”开头，后面再以两个下划线分割，其后跟文件名称，最后以.sql结尾。（不推荐使用）比如： R__truncate_user_dml.sql 。
　　其中，V开头的SQL执行优先级要比R开头的SQL优先级高。

4.application.yml中新增flyway配置

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/hualian_goods?characterEncoding=UTF8&serverTimezone=Asia/Shanghai
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: 12345
    type: com.alibaba.druid.pool.DruidDataSource
  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

4.idea中flyway执行console中执行

5.数据中新生成的flyway_schema_history表记录idea中SQL脚本执行

6.使用flyway修改数据库后，数据表结构

 

 五.idea中SQL执行脚本已经运行过，如果对脚本进行修改，idea执行时会报下边错误

[ERROR] Migration checksum mismatch for migration version 2 

改正办法:

1.将flyway_schema_history中原来执行脚本记录先删除，再重新运行项目，让flyway重新执行修改后的SQL语句

2.重修生成一个SQL文件，版本号要大于flyway_schema_history表中已有version最大的，这个SQL脚本才能执行