基於Flyway實現簡化Spring Boot項目部署

1.什麼是 Flyway

我們在公司做開發時，由於項目需求的變化，或者前期設計缺陷，導致在後期需要修改數據庫，這應該是一個比較常見的事情，如果項目還沒上線，你可能把表刪除了重新創建，但是如果項目已經上線了，就不能這樣簡單粗暴了，我們需要通過 SQL 腳本在已有數據表的基礎上進行升級。

目前 Java 這塊，想要對數據庫的版本進行管理主要有兩個工具：

Flyway

Liquibase

兩個工具各有千秋，但是核心功能都是數據庫的版本管理，這裡主要來看 Flyway。就像我們使用 Git 來管理代碼版本一樣，Flyway 可以用來管理數據庫版本。

好了，接下來我們就來看看用 Flyway 如何簡化微人事部署，然後再來說說 Flyway 的一個大致原理。

2.嵌入到微人事

如果是在一個全新的項目中使用 Flyway，那麼在新建一個 Spring Boot 項目時，就有 Flyway 的選項，如下圖：

項目創建成功後，resources 目錄下也會多出來一個 db/migration 目錄，這個目錄用來存放數據庫腳本，如下：

注意

這個如果創建項目時就選擇了 Flyway 依賴，就會有這個目錄。現在我要在已經做好的微人事中加入 Flyway，這個目錄就需要我手動創建了。

首先在微人事中添加 flyway 依賴：

  org.flywaydbflyway-core

然後在 vhr-web 模塊下的 resources 目錄下，手動創建 db/migration 目錄，然後在該目錄下創建數據庫腳本，數據庫腳本的命名方式如下：

V__.sql

首先是大寫字母 V，然後是版本號，要是有小版本可以用下劃線隔開，例如 2_1，版本號後面是兩個下劃線，然後是腳本名稱，文件後綴是 .sql。

例如我這裡創建我的第一個數據庫腳本，取名為 V1__vhr.sql，腳本內容就是微人事的數據庫腳本，大家可以在 https://github.com/lenve/vhr 這裡獲取到。

完了之後，可以不用添加額外配置，大家只需要在本地 MySQL 中創建一個空的 vhr 數據庫即可，然後直接啟動微人事項目，項目啟動成功後，我們查看啟動日誌：

從這段啟動日誌中，我們可以看到 Flyway 的執行信息，數據庫腳本的執行執行，同時這裡還說了，Flyway 還給創建了一個 flyway_schema_history 表，這個表用來記錄數據庫的更新歷史。

這個時候，打開本地數據庫，我們發現 vhr 庫中該有的表都有了。同時還發現了 flyway_schema_history 表，如下：

有了這條記錄，下次再啟動 vhr 項目，V1__vhr.sql 這個腳本文件就不會執行了，因為系統知道這個腳本已經執行過了，如果你還想讓 V1__vhr.sql 腳本再執行一遍，需要手動刪除 flyway_schema_history 表中的對應記錄，那麼項目啟動時，這個腳本就會被執行了。

3.執行細節

• 我們在定義腳本的時候，除了 V 字開頭的腳本之外，還有一種 R 字開頭的腳本，V 字開頭的腳本只會執行一次，而 R 字開頭的腳本，只要腳本內容發生了變化，啟動時候就會執行。

• 使用了 Flyway 之後，如果再想進行數據庫版本升級，就不用該以前的數據庫腳本了，直接創建新的數據庫腳本，項目在啟動時檢測了有新的更高版本的腳本，就會自動執行，這樣，在和其他同事配合工作時，也會方便很多。因為正常我們都是從 Git 上拉代碼下來，不拉數據庫腳本，這樣要是有人更新了數據庫，其他同事不一定能夠收到最新的通知，使用了 Flyway 就可以有效避免這個問題了。

• 所有的腳本，一旦執行了，就會在 flyway_schema_history 表中有記錄，如果你不小心搞錯了，可以手動從 flyway_schema_history 表中刪除記錄，然後修改 SQL 腳本後再重新啟動（生產環境不建議）。

4.其他配置

在 Spring Boot 中，關於 Flyway 也有不少配置，這些配置都在 application.properties 中進行配置，常用的幾個來和大家說下：

• spring.flyway.enabled：是否開啟 flyway，默認就是開啟的

• spring.flyway.encoding：flyway 字符編碼

• spring.flyway.locations：sql 腳本的目錄，默認是 classpath:db/migration，如果有多個，用 , 隔開

• spring.flyway.clean-disabled：這個屬性非常關鍵，它表示是否要清除已有庫下的表，如果執行的腳本是 V1__xxx.sql，那麼會先清除已有庫下的表，然後再執行腳本，這在開發環境下還挺方便，但是在生產環境下就要命了，而且它默認就是要清除，生產環境一定要自己配置設置為 true。

• spring.flyway.table：配置數據庫信息表的名稱，默認是 flyway_schema_history。

好了，關於 Flyway 我就先說這麼多，代碼也已經更新到 vhr （https://github.com/lenve/vhr）上了，感興趣的小夥伴不妨下載試一下。