[[337597]]

本文轉(zhuǎn)載自微信公眾號(hào)「Java極客技術(shù)」，作者鴨血粉絲。轉(zhuǎn)載本文請(qǐng)聯(lián)系Java極客技術(shù)公眾號(hào)。 

Hello 大家好，我是阿粉，不知道你有沒(méi)有遇到過(guò)這種場(chǎng)景，一套代碼部署在不同的環(huán)境中，隨著時(shí)間的過(guò)去，各個(gè)環(huán)境代碼有版本差異，代碼層面可以通過(guò)不同的版本來(lái)控制，但是數(shù)據(jù)庫(kù)層面經(jīng)常容易忘記更新!

前言

比如剛開始環(huán)境 A 和環(huán)境 B 的代碼版本是一樣的，但是隨著版本的迭代，環(huán)境 A 的系統(tǒng)一直持續(xù)迭代，但是環(huán)境 B 的系統(tǒng)由于種種原因沒(méi)有升級(jí)，一直保持在最初的版本。如果某個(gè)時(shí)候需要對(duì)環(huán)境 B 的系統(tǒng)進(jìn)行升級(jí)的話，你會(huì)發(fā)現(xiàn)，中間已經(jīng)過(guò)了好多個(gè)版本，各個(gè)版本的差距很大，數(shù)據(jù)庫(kù)結(jié)構(gòu)有調(diào)整，不能直接打包發(fā)布，需要把之前所有對(duì)環(huán)境 A 調(diào)整的 SQL 都在環(huán)境 B 中執(zhí)行一遍才行。

這個(gè)時(shí)候如果 SQL 版本做的好的問(wèn)題不大，依次執(zhí)行就行了，但是如果中間有人員離職或者記錄缺失，那只能通過(guò)對(duì)比數(shù)據(jù)庫(kù)結(jié)構(gòu)來(lái)進(jìn)行解決了。

數(shù)據(jù)遷移

前面我們的提到的場(chǎng)景專業(yè)的名詞叫數(shù)據(jù)遷移，那為什么會(huì)出現(xiàn)數(shù)據(jù)遷移的場(chǎng)景呢?我從官網(wǎng)截了一張圖大家可以看下，雖然說(shuō)可能跟我實(shí)際開發(fā)不是一樣，但是也差不多類似會(huì)出現(xiàn)這種場(chǎng)景，存在多個(gè)環(huán)境。可以看到雖然我們的代碼可以通過(guò)版本迭代來(lái)控制，但是我們的數(shù)據(jù)庫(kù)卻不行，很多時(shí)候連腳本是否執(zhí)行過(guò)都會(huì)忘記，這種事情光靠人記是很難的。

Flyway

Flyway 就是用來(lái)解決像這樣的數(shù)據(jù)庫(kù)遷移的工具，接入了 Flyway 過(guò)后，在數(shù)據(jù)庫(kù)中會(huì)生成一張默認(rèn)名為flyway_schema_history 的數(shù)據(jù)表，用來(lái)追蹤數(shù)據(jù)庫(kù)的變化。程序啟動(dòng)的時(shí)候 Flyway 都會(huì)在文件系統(tǒng)或者 classpath 路徑下面尋找遷移腳本。每個(gè)遷移腳步都有相應(yīng)的命名規(guī)則，F(xiàn)lyway 會(huì)根據(jù)文件的版本號(hào)進(jìn)行遷移，每次遷移過(guò)后都會(huì)在flyway_schema_history 表中插入一條類似如下的記錄，記錄版本已經(jīng)對(duì)應(yīng)的腳本文件和校驗(yàn)碼等信息：

每次啟動(dòng)的時(shí)候只會(huì)執(zhí)行最高版本的腳本，而且如果版本沒(méi)變，腳本變了是啟動(dòng)不了的。

Flyway 的遷移類型

版本遷移

最常見(jiàn)的遷移就是就是版本化遷移，每次遷移都會(huì)對(duì)應(yīng)的遷移版本，遷移的版本必須全局唯一，版本遷移最大的特點(diǎn)就是依次只被執(zhí)行依次。

撤銷遷移

每個(gè)撤銷遷移都對(duì)應(yīng)的一個(gè)版本遷移，也就是說(shuō)撤銷遷移是針對(duì)版本遷移所存在的，每一個(gè)撤銷遷移與版本遷移都是一一對(duì)應(yīng)的，而且對(duì)應(yīng)的版本號(hào)必須一致。

可重復(fù)遷移

可重復(fù)遷移有描述和校驗(yàn)碼，但是沒(méi)有版本號(hào)，程序在每次啟動(dòng)的時(shí)候，如果發(fā)現(xiàn)腳本文件有變化就會(huì)執(zhí)行。

基于 SQL 的遷移

上面提到的幾種類型都是基于 SQL 文件來(lái)執(zhí)行的，只不過(guò)每種類型的命名格式不一樣，下圖是從官網(wǎng)上截下來(lái)的，大家看下每種類型的文件應(yīng)該按照如下的格式去命令，其中的 Separator 是兩個(gè)下劃線。

主要分為下面幾個(gè)部分：

prefix：前綴，不同的類型采用不同的前綴，版本遷移使用 V，撤銷遷移使用 U，可重復(fù)遷移使用 R，當(dāng)然這些都是可配置的;

Version：版本號(hào)，可以使用點(diǎn)符號(hào)或者單下劃線鏈接;

Separator：分隔符，兩個(gè)下劃線，也是可以配置的;

Description：版本描述可以用下劃線和空格分隔;

Suffix：后綴，一般都是 .sql

SpringBoot 項(xiàng)目接入 Flyway

SpringBoot 項(xiàng)目接入 Flyway 非常簡(jiǎn)單，主要分為如下幾步即可，我們依次來(lái)看一下。

加入依賴

<!-- flyway --> 
<dependency> 
    <groupId>org.flywaydb</groupId> 
    <artifactId>flyway-core</artifactId> 
</dependency> 

在項(xiàng)目 pom.xml 文件中加入上面的依賴即可。

增加配置

# 啟用 flyway 
spring.flyway.enabled=true 
# 禁止清理數(shù)據(jù)表 
spring.flyway.clean-disabled=true 
# 是否已經(jīng)有數(shù)據(jù)庫(kù) 
spring.flyway.baseline-on-migrate=true 
# 基礎(chǔ)版本號(hào)，依次遞增 
spring.flyway.baseline-version=0 
# 遷移腳本的存放的位置 
spring.flyway.locations=classpath:db/migration 

這里因?yàn)楹芏嗲闆r下我們并不是一個(gè)新項(xiàng)目就開始使用 Flyway，而是項(xiàng)目在迭代中才引入的，所以上面的配置spring.flyway.clean-disabled=true 一定要禁用。上面幾個(gè)配置由于已經(jīng)繼承到 SpringBoot 中了所以配置起來(lái)十分簡(jiǎn)單。

遷移腳本

文件腳本的命名規(guī)則按照上面說(shuō)的，我們這邊采用版本遷移。我們創(chuàng)建一個(gè)版本的 SQL 文件放到對(duì)應(yīng)的類路徑文件夾里面，文件名叫V1.2__create_test_table.sql，文件內(nèi)容如下，然后我們啟動(dòng)項(xiàng)目。

CREATE TABLE `test_table`  ( 
  `id` int(11) NULL COMMENT 'ID', 
  `name` varchar(255) NULL COMMENT 'Name' 
); 

啟動(dòng)過(guò)程中我們看到如下日志，顯示了當(dāng)前的版本，以及遷移的版本。

我們?cè)俨榭磾?shù)據(jù)庫(kù)，首先 test_table 已經(jīng)創(chuàng)建成功了

另外我們?cè)诓榭磃lyway_schema_history 表，會(huì)發(fā)現(xiàn)已經(jīng)多了一條版本數(shù)據(jù)，至此我們介入 Flyway 已經(jīng)成功了。

總結(jié)

今天阿粉給大家介紹了一個(gè)數(shù)據(jù)庫(kù)版本遷移的工具，這么好的工具大家趕緊用起來(lái)吧，這樣在以后的版本迭代的過(guò)程中再也不會(huì)忘記執(zhí)行SQL 了。這篇文章先跟大家介紹 Flyway 的使用，下篇文章我們?cè)俜窒硭膶?shí)現(xiàn)原理。