Java使用flyway實現(xiàn)腳本自動化的方法詳解

更新時間：2023年10月27日 09:40:39 作者：生命猿于運動

Flyway是一個開源的數(shù)據(jù)庫版本控制工具,主要用于管理數(shù)據(jù)庫的版本和變更,它可以自動化地將數(shù)據(jù)庫遷移到不同的版本,同時支持多種數(shù)據(jù)庫類型,本文給大家介紹了如何使用flyway實現(xiàn)腳本自動化,需要的朋友可以參考下

如何使用

使用Flyway，僅需將編寫的好SQL語句寫成sql腳本文件，根據(jù)版本規(guī)定填寫正確的文件名，存放到指定的目錄底下，在項目進行啟動時即可自動掃描指定目錄底下的腳本，根據(jù)數(shù)據(jù)庫Flyway配置表進行對比，將未執(zhí)行的腳本按順序自動執(zhí)行。

Flyway腳本遷移文件命名需要遵循以下規(guī)則：

如上圖，文件命名規(guī)范主要分為以下幾個部分：

前綴：V表示版本化遷移，U表示撤銷遷移，R表示可重復遷移。
下劃線：在版本號中下劃線會被.替換。
分隔符：兩個下劃線，用來分隔版本號與文件描述詞
描述：腳本文件內容的簡短描述，執(zhí)行后內容中的下劃線則會被替換為空格。

文件名版本號與文件描述內容以兩個下劃線分隔開，命名示例：

V1_20231026154401__create_student_table.sql
V1_20231026162233__insert_student_data.sql

通常情況下我們都是直接以V前綴進行命名，在需要進行回退操作時，直接在腳本中寫好回退的腳本即可。

更多內容可以參考官方文檔說明：https://documentation.red-gate.com/fd/migrations-184127470.html#versioned-migrations

案例分析

首先需要引入flyway依賴包：

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

在application.yml文件中添加flyway相關配置信息，開啟flyway腳本遷移功能：

spring:
  flyway:
    # flyway 開啟/關閉
    enabled: true
    # 當遷移時發(fā)現(xiàn)目標schema非空，而且?guī)в袥]有元數(shù)據(jù)的表時，是否自動執(zhí)行基準遷移，默認false.
    baseline-on-migrate: true
    # 是否允許無序的遷移，默認false.
    out-of-order: true
    # 遷移時是否校驗，默認為true
    validate-on-migrate: false
    # 遷移腳本的位置，默認db/migration.
    locations: classpath:db
    # flyway 基線版本號
    baseline-version: 0
    # flyway 執(zhí)行記錄表
    table: demo_flyway_schema_history

在上面的配置中也描述了每個屬性參數(shù)的作用，上面的腳本位置配置的是locations: classpath:db，在這里我們就可以將需要進行遷移執(zhí)行的腳本文件，按上面的命名規(guī)范配置好之后存放到此目錄下：

確認好文件存放位置無誤之后，我們就可以直接啟動服務：

如圖服務啟動成功后，我們就可以看到相關flyway執(zhí)行的日志信息，如果是首次使用flyway遷移腳本的話，那么就會自動幫我們創(chuàng)建一個flyway執(zhí)行記錄表，表結構如下：

installed_rank：主鍵
version：版本號
description：文件描述
type：腳本類型
script：完整文件名
checksum：flyway通過特定的算法根據(jù)文件內容計算出來的一個整數(shù)，可以簡單理解為文件內容的標識符，如果我們在配置中開啟校驗時(validate-on-migrate=true)，如果我們文件內容有修改將計算出新的checksum與執(zhí)行過的的checksum不一致時即會報mismatch的錯誤，以此來告知開發(fā)者腳本有變動。
installed_by：執(zhí)行腳本的數(shù)據(jù)庫用戶
execution_time：執(zhí)行時間
success：執(zhí)行結果，0：失敗，1：成功