Spring Boot中使用Flyway來管理資料庫版本

01-25

久違了的Spring Boot系列，今天抽空更新一篇。去年寫過很多篇關於數據訪問的文章了，比如下面這些：

使用JdbcTemplate
使用Spring-data-jpa簡化數據訪問層（推薦）
多數據源配置（一）：JdbcTemplate
多數據源配置（二）：Spring-data-jpa
使用NoSQL資料庫（一）：Redis
使用NoSQL資料庫（二）：MongoDB
整合MyBatis
MyBatis註解配置詳解
使用事務管理

如果沒有讀過上面內容的讀者，有興趣的可以一閱。在上面的使用JdbcTemplate一文中，主要通過spring提供的JdbcTemplate實現對用戶表的增刪改查操作。在實現這個例子的時候，我們事先在MySQL中創建了用戶表。創建表的過程我們在實際開發系統的時候會經常使用，但是一直有一個問題存在，由於一個系統的程序版本通過git得到了很好的版本控制，而資料庫結構並沒有，即使我們通過Git進行了語句的版本化，那麼在各個環境的資料庫中如何做好版本管理呢？下面我們就通過本文來學習一下在Spring Boot中如何使用Flyway來管理資料庫的版本。

Flyway簡介

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

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

本文對於Flyway的自身功能不做過多的介紹，讀者可以通過閱讀官方文檔或利用搜索引擎獲得更多資料。下面我們具體說說在Spring Boot應用中的應用，如何使用Flyway來創建資料庫以及結構不一致的檢查。

動手試一試

下面我們可以通過對使用JdbcTemplate一文中的例子進行加工完成。讀者也可以拿任何一個與數據訪問相關的工程來做如下內容的實驗：

第一步，在pom.xml中增加flyway的依賴：

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

第二步，按Flyway的規範創建版本化的SQL腳本。

在工程的src/main/resources目錄下創建db目錄
在db目錄下創建版本化的SQL腳本V1__Base_version.sql

DROP TABLE IF EXISTS user ;CREATE TABLE `user` ( `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT "主鍵", `name` varchar(20) NOT NULL COMMENT "姓名", `age` int(5) DEFAULT NULL COMMENT "年齡", PRIMARY KEY (`id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

第三步，在application.properties文件中配置Flyway要載入的SQL腳本位置。按第二步創建的結果配置如下：

flyway.locations=classpath:/db

第四步，執行單元測試ApplicationTests，此時我們在日誌中可以看到如下信息：

INFO 82441 --- [main] o.f.core.internal.util.VersionPrinter : Flyway Community Edition 5.0.3 by BoxfuseINFO 82441 --- [main] o.f.c.internal.database.DatabaseFactory : Database: jdbc:mysql://localhost:3306/test (MySQL 5.7)INFO 82441 --- [main] o.f.core.internal.command.DbValidate : Successfully validated 1 migration (execution time 00:00.022s)INFO 82441 --- [main] o.f.c.i.s.JdbcTableSchemaHistory : Creating Schema History table: `test`.`flyway_schema_history`INFO 82441 --- [main] o.f.core.internal.command.DbMigrate : Current version of schema `test`: << Empty Schema >>INFO 82441 --- [main] o.f.core.internal.command.DbMigrate : Migrating schema `test` to version 1 - Base versionWARN 82441 --- [main] o.f.core.internal.sqlscript.SqlScript : DB: Unknown table "test.user" (SQL State: 42S02 - Error Code: 1051)INFO 82441 --- [main] o.f.core.internal.command.DbMigrate : Successfully applied 1 migration to schema `test` (execution time 00:00.128s)

Flyway監測到需要運行版本腳本來初始化資料庫，因此執行了V1__Base_version.sql腳本，從而創建了user表，這才得以讓一系列單元測試（對user表的CRUD操作）通過。

第五步，我們可以繼續再執行一下單元測試，此時我們會發現日誌輸出與之前不同：

INFO 83150 --- [main] o.f.core.internal.util.VersionPrinter : Flyway Community Edition 5.0.3 by BoxfuseINFO 83150 --- [main] o.f.c.internal.database.DatabaseFactory : Database: jdbc:mysql://localhost:3306/test (MySQL 5.7)INFO 83150 --- [main] o.f.core.internal.command.DbValidate : Successfully validated 1 migration (execution time 00:00.031s)INFO 83150 --- [main] o.f.core.internal.command.DbMigrate : Current version of schema `test`: 1INFO 83150 --- [main] o.f.core.internal.command.DbMigrate : Schema `test` is up to date. No migration necessary.

由於在第四步的時候，初始化腳本已經執行過，所以這次執行就沒有再去執行V1__Base_version.sql腳本來重建user表。

第六步，我們可以嘗試修改一下V1__Base_version.sql腳本中的name欄位長度，然後在運行一下單元測試，此時我們可以得到如下錯誤：

ERROR 83791 --- [main] o.s.boot.SpringApplication : Application startup failedorg.springframework.beans.factory.BeanCreationException: Error creating bean with name "flywayInitializer" defined in class path resource [org/springframework/boot/autoconfigure/flyway/FlywayAutoConfiguration$FlywayConfiguration.class]: Invocation of init method failed; nested exception is org.flywaydb.core.api.FlywayException: Validate failed: Migration checksum mismatch for migration version 1-> Applied to database : 466264992-> Resolved locally : -270269434

由於初始化腳本的改動，Flyway校驗失敗，認為當前的V1__Base_version.sql腳本與上一次執行的內容不同，提示報錯並終止程序，以免造成更嚴重的數據結構破壞。

總結

到這裡為止，本文的內容告一段落。由於博文篇幅問題，對於Flyway更細節的使用沒有說的太多，本文主要作為敲門磚，幫助和引導正在使用Spring Boot做系統開發的個人或團隊在資料庫的版本控制上做的更好提供一些思路。至於更深入的應用還請讀者自行翻閱官方文檔參考和學習。

本文代碼

可以通過下面兩個倉庫中查閱Chapter3-2-9目錄：

Github：https://github.com/dyc87112/SpringBoot-Learning/
Gitee：https://gitee.com/didispace/SpringBoot-Learning

作者：翟永超

地址：Spring Boot中使用Flyway來管理資料庫版本