Spring Boot中使用Flyway來管理數據庫版本

久違了的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 Boxfuse
INFO 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 version
WARN 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 Boxfuse
INFO 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`: 1
INFO 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 failed

org.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/S...
• Gitee：https://gitee.com/didispace/S...

原文： http://blog.didispace.com/spr...