数据库版本管理工具Flyway应用

时间 2019-11-18

原文原文链接

Flyway介绍

Flyway是一款开源的数据库版本管理工具，它更倾向于规约优于配置的方式。Flyway能够独立于应用实现管理并跟踪数据库变动，支持数据库版本自动升级，而且有一套默认的规约，不须要复杂的配置，Migrations能够写成SQL脚本，也能够写在Java代码中，不只支持Command Line和Java API，还支持Build构建工具和Spring Boot等，同时在分布式环境下可以安全可靠地升级数据库，同时也支持失败恢复等。mysql

Flyway用途

一般在项目开始时会针对数据库进行全局设计，但在开发产品新特性过程当中，不免会遇到须要更新数据库Schema的状况，好比：添加新表，添加新字段和约束等，这种状况在实际项目中也常常发生。那么，当开发人员完成了对数据库更的SQL脚本后，如何快速地在其余开发者机器上同步？而且如何在测试服务器上快速同步？以及如何保证集成测试可以顺利执行并经过呢？sql

到各测试服务器上手动执行SQL脚本费时费神费力的，干吗不自动化呢，固然，对于高级别和PROD环境，仍是须要DBA手动执行的。最后，写一段自动化程序来自动执行更新，想法是很好的，那若是已经有了一些插件或库能够帮助你更好地实现这样的功能，为什么很差好利用一下呢，固然，若是是为了学习目的，重复造轮子是无可厚非的。其实，以上能够经过Flyway工具来解决，Flyway能够实现自动化的数据库版本管理，而且可以记录数据库版本更新记录。数据库

Flyway命令

Flyway对数据库进行版本管理主要由Metadata表和6种命令完成，Metadata主要用于记录元数据，每种命令功能和解决的问题范围不同，如下分别对metadata表和这些命令进行阐述，其中的示意图都来自Flyway的官方文档。安全

Metadata Table

Flyway中最核心的就是用于记录全部版本演化和状态的Metadata表，在Flyway首次启动时会建立默认名为flyway_schema_history的元数据表，其表结构为(以MySQL为例)：服务器

Migrate

Migrate是指把数据库Schema迁移到最新版本，是Flyway工做流的核心功能，Flyway在Migrate时会检查Metadata(元数据)表，若是不存在会建立Metadata表，Metadata表主要用于记录版本变动历史以及Checksum之类的。maven

Migrate时会扫描指定文件系统或Classpath下的Migrations(能够理解为数据库的版本脚本)，而且会逐一比对Metadata表中的已存在的版本记录，若是有未应用的Migrations，Flyway会获取这些Migrations并按次序Apply到数据库中，不然不须要作任何事情。另外，一般在应用程序启动时应默认执行Migrate操做，从而避免程序和数据库的不一致性。分布式

Clean

清除掉对应数据库Schema中的全部对象，包括表结构，视图，存储过程，函数以及全部的数据等都会被清除。Clean操做在开发和测试阶段是很是有用的，它可以帮助快速有效地更新和从新生成数据库表结构，但特别注意的是：不该在Production的数据库上使用！函数

Info

Info用于打印全部Migrations的详细和状态信息，其实也是经过Metadata表和Migrations完成的，下图很好地示意了Info打印出来的信息。Info可以帮助快速定位当前的数据库版本，以及查看执行成功和失败的Migrations。工具

Validate

Validate是指验证已经Apply的Migrations是否有变动，Flyway是默认是开启验证的。Validate原理是对比Metadata表与本地Migrations的Checksum值，若是值相同则验证经过，不然验证失败，从而能够防止对已经Apply到数据库的本地Migrations的无心修改。post

Baseline

Baseline针对已经存在Schema结构的数据库的一种解决方案，即实如今非空数据库中新建Metadata表，并把Migrations应用到该数据库。Baseline能够应用到特定的版本，这样在已有表结构的数据库中也能够实现添加Metadata表，从而利用Flyway进行新Migrations的管理了。

Repair

Repair操做可以修复Metadata表，该操做在Metadata表出现错误时是很是有用的。Repair会修复Metadata表的错误，一般有两种用途：

移除失败的Migration记录，该问题只是针对不支持DDL事务的数据库。
从新调整已经应用的Migratons的Checksums值，好比：某个Migratinon已经被应用，但本地进行了修改，又指望从新应用并调整Checksum值，不过尽可能不要这样操做，不然可能形成其它环境失败。

支持的数据库

目前Flyway支持的数据库仍是挺多的，包括：Oracle, SQL Server, SQL Azure, DB2, DB2 z/OS, MySQL(including Amazon RDS), MariaDB, Google Cloud SQL, PostgreSQL(including Amazon RDS and Heroku), Redshift, Vertica, H2, Hsql, Derby, SQLite, SAP HANA, solidDB, Sybase ASE and Phoenix。

Flyway应用

Flyway能够经过命令行和插件（如maven）的方式运行相应的命令，具体能够参考https://flywaydb.org/getstarted/firststeps/commandline。

本文将会重点讲解在Spring Boot中应用Flyway。

引入依赖

<!-- https://mvnrepository.com/artifact/org.flywaydb/flyway-core -->
<dependency>
	<groupId>org.flywaydb</groupId>
	<artifactId>flyway-core</artifactId>
	<version>5.0.7</version>
</dependency>

配置Flyway

flyway:
  locations: classpath:db/migration
  baseline-on-migrate: true
  url: jdbc:mysql://localhost:3306/test
  sql-migration-prefix: V
  sql-migration-suffix: .sql

咱们在配置文件中指定了如上的属性。Flyway的配置属性意义以下：

flyway.baseline-version：执行基线时用来标记已有Schema的版本（默认值：1）
flyway.enabled：开启Flyway （默认为true）
flyway.sql-migration-prefix：SQL迁移的文件名前缀
flyway.sql-migration-suffix ：SQL迁移的文件名后缀
flyway.baseline-on-migrate：在没有元数据表的状况下，针对非空Schema执行迁移时是否自动调用基线
flyway.location：迁移脚本的位置（默认为db/migration）

正确建立Migrations

Migrations是指Flyway在更新数据库时是使用的版本脚本，好比：一个基于Sql的Migration命名为V1__init_tables.sql，内容便是建立全部表的sql语句，另外，Flyway也支持基于Java的Migration。Flyway加载Migrations的默认Locations为classpath:db/migration，也能够指定filesystem:/project/folder，其加载是在Runtime自动递归地执行的。

除了须要指定Location外，Flyway对Migrations的扫描还必须听从必定的命名模式，Migration主要分为两类：Versioned和Repeatable。

Versioned migrations
通常经常使用的是Versioned类型，用于版本升级，每个版本都有一个惟一的标识而且只能被应用一次，而且不能再修改已经加载过的Migrations，由于Metadata表会记录其Checksum值。其中的version标识版本号，由一个或多个数字构成，数字之间的分隔符能够采用点或下划线，在运行时下划线其实也是被替换成点了，每一部分的前导零会被自动忽略。
Repeatable migrations
Repeatable是指可重复加载的Migrations，其每一次的更新会影响Checksum值，而后都会被从新加载，并不用于版本升级。对于管理不稳定的数据库对象的更新时很是有用。Repeatable的Migrations老是在Versioned以后按顺序执行，但开发者必须本身维护脚本而且确保能够重复执行，一般会在sql语句中使用CREATE OR REPLACE来保证可重复执行。

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

prefix: 可配置，前缀标识，默认值V表示Versioned，R表示Repeatable
version: 标识版本号，由一个或多个数字构成，数字之间的分隔符可用点.或下划线_
separator: 可配置，用于分隔版本标识与描述信息，默认为两个下划线__
description: 描述信息，文字之间能够用下划线或空格分隔
suffix: 可配置，后续标识，默认为.sql

建立sql脚本文件

如上所示即为咱们在服务中建立的sql脚本，启动服务以后会看到以下的日志信息：

说明当前数据库脚本是最新的，schema_version表中最新的版本为1.4。

总结

本文主要介绍了Flyway，包括其提供的6中命令和如何使用Flyway。Flyway能够有效改善数据库版本管理方式，一般在local和dev环境中简化了不少没必要要的繁琐操做，固然在产线上应用Flyway须要很是慎重，可能会对线上的数据形成很是严重的后果。

做者：aoho 连接：https://juejin.im/post/5b7449736fb9a009bb754171 来源：掘金著做权归做者全部。商业转载请联系做者得到受权，非商业转载请注明出处。