Flyway的使用

環境：SpringBoot 2.0.4.RELEASE

為什麼要用Flyway？

開發人員在合作的時候經常遇到以下場景：

1.開發人員A在自己的本地資料庫做了一些表結構的改動，並根據這些改動調整了DAO層的程式碼，然後將程式碼上傳到svn或git等版本控制伺服器上。此時如果開發人員B拉取了A的程式碼改動，在執行專案的時候很可能會報錯，因為B的本地SQL資料庫並沒有修改。

2.在專案上線的時候，當伺服器拉取的版本控制伺服器的最新修改後，必須同時執行SQL資料庫的修改指令碼，如果忘了跑資料庫指令碼，那麼會出現嚴重的問題。

傳統的解決方案就是在一個固定的資料夾中，將需要跑的SQL指令碼放在裡面。開發人員在合作的時候，A修改了資料庫，在B遇到問題的時候，可能需要交流溝通一下，去跑需要的指令碼。在專案上線的過程中，也是運維人員在規定的資料夾中，找到需要跑的SQL指令碼。執行它們。

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

Flyway是什麼？

官方網站：https://flywaydb.org/

Flyway是一個簡單開源資料庫版本控制器（約定大於配置），主要提供migrate、clean、info、validate、baseline、repair等命令。它支援SQL（PL/SQL、T-SQL）方式和Java方式，支援命令列客戶端等，還提供一系列的外掛支援（Maven、Gradle、SBT、ANT等）。

Flyway最核心的就是用於記錄所有版本演化和狀態的MetaData表，Flyway首次啟動會建立預設名為SCHEMA_VERSION的元素局表。 表中儲存了版本，描述，要執行的sql指令碼等；

sql指令碼的格式：V + 版本號 + 雙下劃線(__) + 描述 + 結束符(.sql)

例如：V1__INIT_DATABASE.sql

命令解釋：

Migrate

Migrate 是指把資料 Schema 遷移到最新版本，在 Migrate 時會檢查 MetaData 元資料表，如果不存在就建立 MetaData 表，MetaData 用於記錄資料庫歷史變更等資訊；

Migrate會掃描指定檔案系統或者 classpath 下的 Migrations。會與 MetaData 中的記錄進行對比，進行版本升級；

clean

清除掉對應資料庫 Schema 中所有的物件，包括表結構，檢視，儲存過程等，clean 操作在 dev 和 test 階段很好用；

info

用於列印所有的 Migrations 的詳細和狀態資訊，也是通過 MetaData 和 Migrations 完成的，可以快速定位當前的資料庫版本；

validate

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

baseline

對已經存在資料庫Schema結構的資料庫一種解決方案。實現在非空資料庫新建MetaData表，並把Migrations應用到該資料庫；也可以應用到已有表結構的資料庫中也可以實現新增Metadata表

repair

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

用途：

1）：移除失敗的Migration記錄，只針對不支援DDL事務的資料庫

SpringBoot中使用Flyway管理資料庫版本

一、新增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#######################
# 在沒有元資料表的情況下，針對非空Schema執行遷移時是否自動呼叫基線。 （預設值：false）
spring.flyway.baseline-on-migrate=true
# 下面幾個配置不寫也行，都是預設配置，這裡寫了是方便以後改
# 執行基線時用來標記已有Schema的版本。（預設值：1）
spring.flyway.baseline-version=1
spring.flyway.enabled=true
spring.flyway.sql-migration-prefix=V
spring.flyway.locations=classpath:db/migration

三、在resource目錄下建立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 是我的專案連線的資料庫

四、驗證是否成功

啟動專案，看啟動日誌：

開啟資料庫管理工具，檢視資料庫：

五、SQL檔案版本號命名的規範

每個公司的規範肯定不一樣.開發時,只需要專案內遵循該規範即可,規範的確定並沒有對錯.提供一種sql檔案命名規範僅供大家參考。

遇到的問題

因為我的專案資料庫連線池使用的是Druid，在啟動專案時發現報異常sql injection violation,part alway true condition not allow，原因是Flyway通過 SQL 指令碼來執行資料庫的建立與更新。當同時集成了 Druid 和 Flyway 之後，Druid 的 wall 防火牆極可能直接干預 SQL 指令碼的操作，繼而導致 Flyway 執行中斷。

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

參考：

Spring Boot專案使用Flyway
Spring Boot中使用Flyway來管理資料庫版本
SpringBoot專案整合Flyway進行資料庫版本控制
Flyway詳解以及Springboot整合Flyway

到此這篇關於Java 中Flyway的使用詳解的文章就介紹到這了,更多相關java Flyway 使用內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！