Flyway的使用

環(huán)境：SpringBoot 2.0.4.RELEASE

為什么要用Flyway？

開發(fā)人員在合作的時候經(jīng)常遇到以下場景：

1.開發(fā)人員A在自己的本地數(shù)據(jù)庫做了一些表結(jié)構(gòu)的改動，并根據(jù)這些改動調(diào)整了DAO層的代碼，然后將代碼上傳到svn或git等版本控制服務器上。此時如果開發(fā)人員B拉取了A的代碼改動，在運行項目的時候很可能會報錯，因為B的本地SQL數(shù)據(jù)庫并沒有修改。

2.在項目上線的時候，當服務器拉取的版本控制服務器的最新修改后，必須同時運行SQL數(shù)據(jù)庫的修改腳本，如果忘了跑數(shù)據(jù)庫腳本，那么會出現(xiàn)嚴重的問題。

傳統(tǒng)的解決方案就是在一個固定的文件夾中，將需要跑的SQL腳本放在里面。開發(fā)人員在合作的時候，A修改了數(shù)據(jù)庫，在B遇到問題的時候，可能需要交流溝通一下，去跑需要的腳本。在項目上線的過程中，也是運維人員在規(guī)定的文件夾中，找到需要跑的SQL腳本。運行它們。

Flyway等migration工具就是要把開發(fā)人員和運維人員從以上這些場景的繁瑣工作中解放出來，如果使用maven的話，那么在項目編譯（SpringBoot運行Application）的時候，SQL數(shù)據(jù)庫的改動就自動進入數(shù)據(jù)庫，只要啟動成功，開發(fā)或者運維人員對SQL數(shù)據(jù)庫的migrate過程是無感知的，項目依然可以照常運行。

Flyway是什么？

官方網(wǎng)站：https://flywaydb.org/

Flyway是一個簡單開源數(shù)據(jù)庫版本控制器（約定大于配置），主要提供migrate、clean、info、validate、baseline、repair等命令。它支持SQL（PL/SQL、T-SQL）方式和Java方式，支持命令行客戶端等，還提供一系列的插件支持（Maven、Gradle、SBT、ANT等）。

Flyway最核心的就是用于記錄所有版本演化和狀態(tài)的MetaData表，F(xiàn)lyway首次啟動會創(chuàng)建默認名為SCHEMA_VERSION的元素局表。 表中保存了版本，描述，要執(zhí)行的sql腳本等；

sql腳本的格式：V + 版本號 + 雙下劃線(__) + 描述 + 結(jié)束符(.sql)

例如：V1__INIT_DATABASE.sql

命令解釋：

Migrate

Migrate 是指把數(shù)據(jù) Schema 遷移到最新版本，在 Migrate 時會檢查 MetaData 元數(shù)據(jù)表，如果不存在就創(chuàng)建 MetaData 表，MetaData 用于記錄數(shù)據(jù)庫歷史變更等信息；

Migrate會掃描指定文件系統(tǒng)或者 classpath 下的 Migrations。會與 MetaData 中的記錄進行對比，進行版本升級；

clean

清除掉對應數(shù)據(jù)庫 Schema 中所有的對象，包括表結(jié)構(gòu)，視圖，存儲過程等，clean 操作在 dev 和 test 階段很好用；

info

用于打印所有的 Migrations 的詳細和狀態(tài)信息，也是通過 MetaData 和 Migrations 完成的，可以快速定位當前的數(shù)據(jù)庫版本；

validate

驗證以及apply的Migrations是否有變更，默認開啟的；原理是對比MetaData表與本地Migrations的checkNum值，如果值相同則驗證通過，否則失敗

baseline

對已經(jīng)存在數(shù)據(jù)庫Schema結(jié)構(gòu)的數(shù)據(jù)庫一種解決方案。實現(xiàn)在非空數(shù)據(jù)庫新建MetaData表，并把Migrations應用到該數(shù)據(jù)庫；也可以應用到已有表結(jié)構(gòu)的數(shù)據(jù)庫中也可以實現(xiàn)添加Metadata表

repair

repair操作能夠修復metaData表，該操作在metadata出現(xiàn)錯誤時很有用

用途：

1）：移除失敗的Migration記錄，只針對不支持DDL事務的數(shù)據(jù)庫

SpringBoot中使用Flyway管理數(shù)據(jù)庫版本

一、添加maven依賴及插件

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

<plugin>
 <groupId>org.flywaydb</groupId>
 <artifactId>flyway-maven-plugin</artifactId>
</plugin>

添加插件的目的是為了使用上面講到的一些命令：如下圖：

二、開啟Flyway支持、配置Flyway

######################FlyWay#######################
# 在沒有元數(shù)據(jù)表的情況下，針對非空Schema執(zhí)行遷移時是否自動調(diào)用基線。 （默認值：false）
spring.flyway.baseline-on-migrate=true
# 下面幾個配置不寫也行，都是默認配置，這里寫了是方便以后改
# 執(zhí)行基線時用來標記已有Schema的版本。（默認值：1）
spring.flyway.baseline-version=1
spring.flyway.enabled=true
spring.flyway.sql-migration-prefix=V
spring.flyway.locations=classpath:db/migration

三、在resource目錄下創(chuàng)建db/migration目錄添加sql腳本

如圖：

下面是 V1.0.0.20190509.0957__flyway_test.sql 腳本

use `spring_boot_building`;

DROP TABLE IF EXISTS `table1`;

CREATE TABLE `table1` (
 `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 `name` varchar(20) NOT NULL,
 PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

spring_boot_building 是我的項目連接的數(shù)據(jù)庫

四、驗證是否成功

啟動項目，看啟動日志：

打開數(shù)據(jù)庫管理工具，查看數(shù)據(jù)庫：

五、SQL文件版本號命名的規(guī)范

每個公司的規(guī)范肯定不一樣.開發(fā)時,只需要項目內(nèi)遵循該規(guī)范即可,規(guī)范的確定并沒有對錯.提供一種sql文件命名規(guī)范僅供大家參考。

遇到的問題

因為我的項目數(shù)據(jù)庫連接池使用的是Druid，在啟動項目時發(fā)現(xiàn)報異常sql injection violation, part alway true condition not allow，原因是Flyway通過 SQL 腳本來執(zhí)行數(shù)據(jù)庫的建立與更新。當同時集成了 Druid 和 Flyway 之后，Druid 的 wall 防火墻極可能直接干預 SQL 腳本的操作，繼而導致 Flyway 執(zhí)行中斷。

網(wǎng)上教程是去掉wall防火墻配置，我試了確實可以，但是個人覺得這種做法不安全，應該還有其他的方法。

參考：

Spring Boot項目使用Flyway
Spring Boot中使用Flyway來管理數(shù)據(jù)庫版本
SpringBoot項目集成Flyway進行數(shù)據(jù)庫版本控制
Flyway詳解以及Springboot集成Flyway

到此這篇關于Java 中Flyway的使用詳解的文章就介紹到這了,更多相關java Flyway 使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

最新評論