Flyway的使用

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

為什么要用Flyway？

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

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

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

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

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

Flyway是什么？

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

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

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

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

例如：V1__INIT_DATABASE.sql

命令解釋：

Migrate

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

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

clean

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

info

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

validate

驗(yàn)證以及apply的Migrations是否有變更，默認(rèn)開(kāi)啟的；原理是對(duì)比MetaData表與本地Migrations的checkNum值，如果值相同則驗(yàn)證通過(guò)，否則失敗

baseline

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

repair

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

用途：

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

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

一、添加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>

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

二、開(kāi)啟Flyway支持、配置Flyway

######################FlyWay#######################
# 在沒(méi)有元數(shù)據(jù)表的情況下，針對(duì)非空Schema執(zhí)行遷移時(shí)是否自動(dòng)調(diào)用基線。 （默認(rèn)值：false）
spring.flyway.baseline-on-migrate=true
# 下面幾個(gè)配置不寫(xiě)也行，都是默認(rèn)配置，這里寫(xiě)了是方便以后改
# 執(zhí)行基線時(shí)用來(lái)標(biāo)記已有Schema的版本。（默認(rèn)值：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 是我的項(xiàng)目連接的數(shù)據(jù)庫(kù)

四、驗(yàn)證是否成功

啟動(dòng)項(xiàng)目，看啟動(dòng)日志：

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

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

每個(gè)公司的規(guī)范肯定不一樣.開(kāi)發(fā)時(shí),只需要項(xiàng)目?jī)?nèi)遵循該規(guī)范即可,規(guī)范的確定并沒(méi)有對(duì)錯(cuò).提供一種sql文件命名規(guī)范僅供大家參考。

遇到的問(wèn)題

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

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

參考：

Spring Boot項(xiàng)目使用Flyway
Spring Boot中使用Flyway來(lái)管理數(shù)據(jù)庫(kù)版本
SpringBoot項(xiàng)目集成Flyway進(jìn)行數(shù)據(jù)庫(kù)版本控制
Flyway詳解以及Springboot集成Flyway

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

最新評(píng)論