SpringBoot整合Flyway完成數據庫持久化迭代更新

• 2019 年 11 月 5 日
• 筆記

每次服務的代碼更新部署，難免會存在數據庫結構的變更以及字典數據的添加，手動執行更新腳本是一個耗時耗力的工作，而且還會出現遺漏或者其他狀況，SpringBoot內部集成了一個自動執行數據庫腳本的第三方依賴Flyway來解決這個繁瑣的問題。

什麼是Flyway

官網給出的定義是Version control for your database. Robust schema evolution across all your environments. With ease, pleasure and plain SQL.（數據庫的版本控制，在所有環境中進行穩健的架構演變，輕鬆，愉快和簡單的SQL。）

Flyway 是一款開源的數據庫版本管理工具，它更傾向於規約優於配置的方式。

Flyway 可以獨立於應用實現管理並跟蹤數據庫變更，支持數據庫版本自動升級，並且有一套默認的規約，不需要複雜的配置，Migrations 可以寫成 SQL 腳本，也可以寫在 Java 代碼中，不僅支持 Command Line 和 Java API，還支持 Build 構建工具和 Spring Boot 等，同時在分佈式環境下能夠安全可靠地升級數據庫，同時也支持失敗恢復等。

Flyway運行原理

當我們運行配置使用Flyway的應用程序時，會自動在配置數據源的數據庫內創建一個名為 flyway_schema_history的表，該表內存放了數據庫的歷史記錄信息。

然後通過掃碼應用程序的/reosurces/db/migration目錄下的歷史版本腳本SQL文件，文件格式為：V?__desc.sql，如：V1__init-db.sql，根據版本號進行排序後，獲取最大的版本號與flyway_schema_history表內執行成功的最大版本號進行比對，如果項目內版本較高，則自動執行腳本文件。

創建項目

通過idea工具創建SpringBoot項目，在pom.xml添加相關依賴如下所示：

<dependencies>      <dependency>          <groupId>org.springframework.boot</groupId>          <artifactId>spring-boot-starter</artifactId>      </dependency>      <dependency>          <groupId>org.flywaydb</groupId>          <artifactId>flyway-core</artifactId>      </dependency>      <dependency>          <groupId>org.springframework.boot</groupId>          <artifactId>spring-boot-starter-jdbc</artifactId>      </dependency>      <dependency>          <groupId>com.zaxxer</groupId>          <artifactId>HikariCP</artifactId>      </dependency>      <dependency>          <groupId>mysql</groupId>          <artifactId>mysql-connector-java</artifactId>          <scope>runtime</scope>      </dependency>      <dependency>          <groupId>org.springframework.boot</groupId>          <artifactId>spring-boot-starter-test</artifactId>          <scope>test</scope>          <exclusions>              <exclusion>                  <groupId>org.junit.vintage</groupId>                  <artifactId>junit-vintage-engine</artifactId>              </exclusion>          </exclusions>      </dependency>  </dependencies>

添加數據庫配置

在application.yml配置文件內添加數據源信息，如下所示：

spring:    datasource:      driver-class-name: com.mysql.cj.jdbc.Driver      url: jdbc:mysql://localhost:3306/flyway      username: root      password: 123456      type: com.zaxxer.hikari.HikariDataSource

添加Flyway版本腳本

腳本比較簡單，大家可以任意添加一些SQL來查看結構或者數據變動。

db.migration目錄是SpringBoot在整合Flyway時默認讀取版本腳本的目錄，我們可以在application.yml配置spring.flyway.locations參數進行修改。

測試

當我們啟動項目時，會自動比對腳本的版本，在db.migration目錄內找到V1.1__add_logging.sql為最高版本，拿着1.1再去flyway_schema_history表內執行成功最大的版本比對，如果低於1.1則自動執行V1.1_add_logging.sql腳本內容，否則跳過。

flyway_schema_history表

每次啟動項目如果存在可更新的腳本信息，執行完成後會自動在flyway_schema_history表內添加一條記錄。

敲黑板，劃重點

本章簡單的介紹了Flyway的基本使用方法，它很強大，功能遠遠不止於此，使用腳本統一自動執行可大大減少手動執行出現的遺漏、錯誤等。 存在既有道理，為什麼不嘗試使用呢？