Spring Boot教程（四十）使用Flyway來管理數據庫版本

在上面的使用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
• 第三步，在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腳本與上一次執行的內容不同，提示報錯並終止程序，以免造成更嚴重的數據結構破壞。

• 源碼來源