Flyway使用说明

Flyway简介

Flyway是源自Google的数据库版本控制插件。项目开发中，数据库往往需要随着软件版本进行变化，相比起手动执行SQL脚本，flyway可以实现自动化的数据库版本修改，让开发/测试等环境的部署更加Easy。例如：

模块A从版本1.0.0升级到1.2.0，需要在student表中添加2个字段并赋予默认值。

• 传统方式：升级模块A时，需要运维大佬同时执行ddl脚本修改表字段+dml脚本赋予默认值，否则程序会报错。如果环境比较多，那么部署其实是一个比较麻烦的事。
• Flyway：把对数据库做修改的sql放入到flyway的目录，模块A升级后，启动时会自动执行sql脚本，运维无需关心数据库的改动。

Flyway使用简介

Flyway基本原理

Flyway的核心就是db.migrate这个文件夹和flyway_schema_history表。db.migrate下每个sql文件对应flyway_schema_history的一条记录。

如下图：



Flyway会在数据库中维护一张flyway_schema_history表。如下图：



表中字段说明：

• installed_rank 脚本执行编号，自动累加
• version 数据库版本号，由用户定义（后续会解释）
• description 版本修改说明，用户编写
• type 脚本类型，一般都是SQL
• script 脚本文件名
• checksum 这是对脚本文件进行CRC32运算得到的数值，用以确保已经执行过的sql脚本不会再发生变化
• installed_by 脚本运行的DB用户
• installed_on 脚本运行时间
• execution_time 脚本执行耗时(ms)
• success 脚本是否执行成功

当引入了flyway的项目启动时，运行flyway.migrate()方法（Spring Boot引入会自动执行），Flyway会将db.migrate文件夹中的sql脚本和数据库flyway_schema_history表做对比，当检测到db.migrate中存在版本号大于flyway_schema_history最新版本的SQL脚本时，就会执行脚本，并更新flyway_schema_history表。

Flyway默认约定

Flyway遵循约定大于配置的原则，有一些默认的约定，按照约定创建脚本，flyway就可以自动识别并执行。

属性	约定	说明
版本控制表	flyway_schema_history	数据库中版本控制的表名，默认就是flyway_schema_history，可配置
脚本路径	db/migrate	默认SQL脚本的存放路径，是相对于classPath的相对路径
脚本文件命名规则	V/R__.sql	这是Flyway约定的脚本文件命名。

脚本文件命名规则

Flyway的脚本文件命名有以下规则：

首先是大写字母 V/R，然后是版本号，要是有小版本可以用下划线隔开，例如 2_1，版本号后面是两个下划线，然后是脚本名称，文件后缀是 .sql。

1. 以V或者R开头
   • V表示这个脚本是版本控制脚本，只会执行一次，如果在执行之后修改该脚本，则运行flyway.migrate()时flyway会报错（checksum校验失败）；
   • R表示这是个可重复运行脚本，每次修改这个脚本，flyway.migrate()执行时都会再次执行这个脚本；
2. 版本号
   
   版本号之间如果有小版本，以下划线隔开
3. 版本修改说明
   
   版本号和版本修改说明之间以两个下划线隔开，版本说明的单词之间以下划线隔开

例如V1_0_0_3__change_thing_parent_to_code.sql，则是说明这是一个版本号为1.0.0.3的数据库版本脚本，说明就是change thing parent to code。

Flyway可配置项

默认情况下建议遵循Flyway的默认约定，就可以很流畅地使用flyway进行数据库版本控制了。如果确实需要做一些调整，Flyway的约定项都是可以配置的，参照以下：

spring:
  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

Flyway使用配置

Spring Boot方式

1. POM
   
   pom里引入依赖

    <dependency>
        <groupId>org.flywaydb</groupId>
        <artifactId>flyway-core</artifactId>
    </dependency>
   

2. 建立文件夹
   
   在resources文件夹下新建文件夹db/migrate
3. 编写SQL脚本