Flyway使用入门

Flyway简介

Flyway 是一款开源的数据库版本管理工具。它能够很方便的在命令行中使用，或者在Java应用程序中引入，用于管理咱们的数据库版本。

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

Flyway支持的数据库不少，从官网摘抄以下：

Supported databases are Oracle, SQL Server (including Amazon RDS and Azure SQL Database), Azure Synapse (Formerly Data Warehouse), DB2, MySQL (including Amazon RDS, Azure Database & Google Cloud SQL), Aurora MySQL, MariaDB, Percona XtraDB Cluster, TestContainers, PostgreSQL (including Amazon RDS, Azure Database, Google Cloud SQL & Heroku), Aurora PostgreSQL, Redshift, CockroachDB, SAP HANA, Sybase ASE, Informix, H2, HSQLDB, Derby, Snowflake, SQLite and Firebird.

更多的特性，可直接在官网上查询，这里再也不一一罗列。

Flyway是如何工做的

Flyway工做流程以下：

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

二、初次使用时，Flyway会建立一个flyway_schema_history表，用于记录sql执行记录。

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

四、若是校验经过，则根据表中的sql记录最大版本号，忽略全部版本号不大于该版本的脚本。再按照版本号从小到大，逐个执行其他脚本。

在SpringBoot项目使用Flyway

如下演示如何在SpringBoot项目中使用Flyway，代码保存个人Github仓库。

一、初始化一个SpringBoot项目，引入MySQL数据库驱动依赖等，而且须要引入Flyway依赖：

<!--引入flyway--><dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-core</artifactId>
    <version>6.1.0</version></dependency>

二、添加Flyway配置：

spring:  # 数据库链接配置  datasource:    driver-class-name: com.mysql.cj.jdbc.Driver    url: jdbc:mysql://localhost:3306/ssm-demo?characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8    username: xxx    password: xxx  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

三、根据在配置文件的脚本存放路径的配置，在resource目录下创建文件夹db/migration。

四、添加须要运行的sql脚本。sql脚本的命名规范为：V+版本号(版本号的数字间以”.“或”_“分隔开)+双下划线(用来分隔版本号和描述)+文件描述+后缀名，例如：V20201100__create_user.sql。如图所示：

五、启动项目。启动成功后，在数据库中能够看到已按照定义好的脚本，完成数据库变动，并在flyway_schema_history表插入了sql执行记录：

建立成功的表sql执行记录