SpringBoot使用Flyway進行數(shù)據(jù)庫遷移的實現(xiàn)示例

更新時間：2023年08月15日 10:46:53 作者：程序猿大波

Flyway是一個數(shù)據(jù)庫遷移工具,它提供遷移歷史和回滾的功能,本文主要介紹了如何使用Flyway來管理Spring Boot應用程序中的SQL數(shù)據(jù)庫架構(gòu),感興趣的可以了解一下

應用程序設置

我們將使用的 Spring Boot 應用程序可以使用此Spring Initializr鏈接生成。它包含所有必要的依賴項。
下載應用程序并解決依賴關系后，我們將創(chuàng)建一個名為spring-boot-flyway的新 Postgres 數(shù)據(jù)庫，并配置應用程序以連接到它。

清單 2.1 application.properties：

spring.datasource.url=jdbc:postgresql://localhost:5432/spring-boot-flyway
spring.datasource.username=demo
spring.datasource.password=demo

默認情況下，F(xiàn)lyway 會在類路徑中的db/migration/目錄中搜索包含用于管理數(shù)據(jù)庫表和記錄的 SQL 語句的遷移文件。

對于舊版本的庫，我們可能需要在resources/db/migration/ 中創(chuàng)建一個名為.keep的空文本文件，以確保該目錄在應用程序啟動期間被編譯并可用，以避免錯誤。

完成此操作后，我們現(xiàn)在可以啟動應用程序并且它應該成功運行。

基本用法

Flyway 的工作方式是，我們在resources/db/migration目錄中創(chuàng)建一個遷移文件，Spring Boot 會自動執(zhí)行遷移腳本，因為我們已經(jīng)在第 2 節(jié)中將 Flyway 依賴項添加到了類路徑中。

清單3.1 V1__Users.sql：

CREATE TABLE IF NOT EXISTS users
(
    id    SERIAL,
    email VARCHAR(200) NOT NULL,
    name  VARCHAR(200) NOT NULL,
    PRIMARY KEY (id)
);

讓我們花一點時間來檢查一下清單 3.1 中的代碼片段。文件名V1__Users.sql遵循一定的約定：

“ V ”表示這是版本化遷移。
V后面的“ 1 ”是實際版本號。它也可以是“ V1_1 ”，這將轉(zhuǎn)換為版本 1.1。
后面是分隔符“ __ ”（兩個下劃線）。這會將版本信息與遷移文件的名稱（在本例中為Users ）分開。
最后一部分“ .sql ”是擴展名；因此，該文件包含一個簡單的 SQL 語句。

此時，重新啟動應用程序?qū)⒃跀?shù)據(jù)庫中創(chuàng)建用戶表。此外，我們可以看到還有另一個我們沒有顯式創(chuàng)建的表 - Flyway_schema_history 。

Flyway_schema_history由 Flyway 本身用來跟蹤已應用的遷移。如果該表丟失，F(xiàn)lyway 將假設我們是第一次初始化數(shù)據(jù)庫，并按照版本號的順序運行所有遷移。

當Flyway_schema_history表存在時，F(xiàn)lyway 將僅應用之前未應用過的較新的遷移文件。這意味著，為了添加新表，我們只需創(chuàng)建具有更新版本號的更新的遷移文件并重新啟動應用程序。

除了使用 SQL 之外，我們還可以使用Java編寫遷移腳本。在Java遷移風格中，我們的遷移文件是Java類，必須擴展抽象BaseJavaMigration類并實現(xiàn)migrate方法。

IDE 通常不希望 Java 類位于resources目錄中，因此我們將在src/main/java中創(chuàng)建一個名為db/migration的新包。非常重要的是要知道這個新包db/migration應該位于src/main/jav目錄中。

讓我們創(chuàng)建一個新的 Java 遷移來添加新表：

清單 3.2 V2__Posts.java ：

public class V2__Posts extends BaseJavaMigration {
    @Override
    public void migrate(Context context) throws Exception {
        var sql = """
                CREATE TABLE posts (
                     id SERIAL,
                     author_id INT NOT NULL,
                     post TEXT NOT NULL,
                     created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
                     updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
                     PRIMARY KEY (id)
                );
                """;
        try(var statement = context.getConnection().createStatement()) {
            statement.execute(sql);
        }
    }
}

與 SQL 文件相比，使用 Java 遷移的優(yōu)點是我們可以添加使用普通 SQL 無法實現(xiàn)的自定義邏輯、條件和驗證。例如，我們可以檢查另一個表是否存在或從環(huán)境中獲取某些值等。

正如您現(xiàn)在可能猜到的那樣，是的，可以在同一個代碼庫中混合 SQL 和 Java 風格的遷移，只要我們確保兩種情況下的 Flyway 位置相同。

Flyway配置和定制

到目前為止，我們一直在使用默認的 Flyway 行為。我們可以進一步調(diào)整 Flyway 以滿足我們的需求。例如，我們可以更改遷移文件的默認位置、配置數(shù)據(jù)庫架構(gòu)（也稱為表空間）、將 SQL 遷移前綴從“V”更改為我們想要的任何內(nèi)容等等。

在下面的配置中，我們配置了遷移文件所在的路徑并禁用清理數(shù)據(jù)庫（即刪除所有表）以防止在生產(chǎn)環(huán)境中意外使用。

清單4.1 application.properties：

spring.flyway.locations=classpath:migrations
spring.flyway.clean-disabled=true

該鍵下還有其他可配置屬性spring.flyway，我們可以使用它們來微調(diào)庫的行為。另外，我們可以查閱Flyway 文檔頁面以供參考。

飛行路線回調(diào)

Flyway為我們提供了配置回調(diào)的能力，這些回調(diào)可以在遷移過程的不同階段調(diào)用?；卣{(diào)機制是在遷移生命周期的不同階段執(zhí)行某些操作的便捷方法。

假設我們有一些默認數(shù)據(jù)想要在應用程序啟動時播種。我們可以簡單地創(chuàng)建一個支持該AFTER_MIGRATE事件的回調(diào)。

清單 5.1 FlywayDatabaseSeeder.java：

public class FlywayDatabaseSeeder implements Callback {
    @Override
    public boolean supports(Event event, Context context) {
        return event.name().equals(Event.AFTER_MIGRATE.name());
    }
    @Override
    public void handle(Event event, Context context) {
        try(var statement = context.getConnection().createStatement()) {
            var ADMIN_EMAIL = "superadmin@example.com";
            var checkQuery = "SELECT id FROM users WHERE email = %s"
                    .formatted(ADMIN_EMAIL);
            statement.execute(checkQuery);
            ResultSet resultSet = statement.getResultSet();
            resultSet.last();
            //return if the seeder has already been executed
            if(resultSet.getRow() >= 0) return;
            var sql = """
                    INSERT INTO users (email, name) VALUES
                    ('%s', 'Super Admin')
                    """.formatted(ADMIN_EMAIL);
            statement.execute(sql);
        } catch (SQLException e) {
            throw new RuntimeException(e);
        }
    }
    @Override
    public boolean canHandleInTransaction(Event event, Context context) {
        return true;
    }
    @Override
    public String getCallbackName() {
        return FlywayDatabaseSeeder.class.getName();
    }
}

在上面的清單中，在supports方法中，我們聲明只應針對AFTER_MIGRATE事件執(zhí)行此回調(diào)，并且在handle方法中，我們概述了插入默認超級管理員用戶（如果尚不存在）的邏輯。

在這之前，我們需要在 SpringBoot 中向 Flyway 注冊回調(diào)類。我們通過創(chuàng)建一個FlywayMigrationStrategybean 來做到這一點。

清單 5.2 SpringBootFlywayApplication.java ：

@Bean
public FlywayMigrationStrategy flywayMigrationStrategy() {
	return (flywayOld) -> {
		/*
		 Update the existing autoconfigured Flyway
		 bean to include our callback class
		*/
		Flyway flyway = Flyway.configure()
				.configuration(flywayOld.getConfiguration())
				.callbacks(new FlywayDatabaseSeeder())
				.load();
		flyway.migrate();
	};
}

rg.flywaydb.core.api.callback.Event枚舉中還有其他事件，我們可以配置Callback類來支持。例如，您可以有一個回調(diào)來支持該AFTER_MIGRATE_ERROR事件并發(fā)送 Slack 通知來提醒工程師。

技巧和竅門

在本地環(huán)境中進行開發(fā)時，您可以從Flyway_schema_history表中刪除遷移條目。

下次啟動應用程序時，您刪除其歷史記錄的遷移將再次執(zhí)行。這樣，您可以更正錯誤或更新架構(gòu)，同時仍在本地計算機上進行開發(fā)，而無需刪除整個數(shù)據(jù)庫。

此外，在 SpringBoot 中，您可以控制 Flyway 在應用程序啟動時何時執(zhí)行遷移腳本。例如，假設我們不希望在本地環(huán)境中自動執(zhí)行遷移。我們可以執(zhí)行以下操作：

清單6.1 SpringBootFlywayApplication.java：

@Bean
public FlywayMigrationStrategy flywayMigrationStrategy(@Value("${spring.profiles.active}") String activeProfile) {
	return (flywayOld) -> {
		/*
		 Update the existing autoconfigured Flyway
		 bean to include our callback class
		*/
		Flyway flyway = Flyway.configure()
				.configuration(flywayOld.getConfiguration())
				.callbacks(new FlywayDatabaseSeeder())
				.load();
		if(!"local".equalsIgnoreCase(activeProfile)) {
			flyway.migrate();
		}
	};
}