使用 Flyway 在 Java 中自動(dòng)執(zhí)行資料庫(kù)遷移

資料庫(kù)遷移是軟體開(kāi)發(fā)的重要方面，特別是在持續(xù)整合和交付 (CI/CD) 為標(biāo)準(zhǔn)實(shí)踐的環(huán)境中。隨著應(yīng)用程式的成長(zhǎng)和發(fā)展，它所依賴(lài)的資料庫(kù)模式也必須如此。手動(dòng)管理這些架構(gòu)變??更可能會(huì)導(dǎo)致錯(cuò)誤並消耗大量時(shí)間。

Flyway 登場(chǎng)，這是一款專(zhuān)為簡(jiǎn)化資料庫(kù)遷移而客製化的寶貴開(kāi)源工具。 Flyway 為您的資料庫(kù)引入了版本控制，使您能夠安全可靠地遷移架構(gòu)。在本文中，我們將探索如何使用 Flyway 在多模組 gragle java 專(zhuān)案中自動(dòng)化資料庫(kù)遷移，確保管理資料庫(kù)變更成為一個(gè)簡(jiǎn)化的、防錯(cuò)的過(guò)程。

更多有關(guān)飛行路線(xiàn)的詳細(xì)資訊

了解 Gradle 中的多項(xiàng)目構(gòu)建

雖然一些較小的專(zhuān)案或整體應(yīng)用程式可能僅使用一個(gè)建置檔案和統(tǒng)一的來(lái)源結(jié)構(gòu)進(jìn)行管理，但較大的專(zhuān)案經(jīng)常被組織成多個(gè)相互依賴(lài)的模組。術(shù)語(yǔ)「相互依賴(lài)」是這裡的關(guān)鍵，強(qiáng)調(diào)了透過(guò)單一建置過(guò)程連接這些模組的需要。

Gradle 以其多專(zhuān)案建置功能（通常稱(chēng)為多模組專(zhuān)案）來(lái)滿(mǎn)足這種設(shè)定。在 Gradle 的術(shù)語(yǔ)中，這些模組稱(chēng)為子項(xiàng)目。

多專(zhuān)案建置是圍繞一個(gè)根專(zhuān)案建構(gòu)的，並且可以包含其下的多個(gè)子專(zhuān)案。

目錄結(jié)構(gòu)應(yīng)如下圖所示：

├── .gradle
│   └── ?
├── gradle
│   ├── libs.versions.toml
│   └── wrapper
├── gradlew
├── gradlew.bat
├── settings.gradle.kts (1)
├── sub-project-1
│   └── build.gradle.kts (2) 
├── sub-project-2
│   └── build.gradle.kts (2) 
└── sub-project-3
    └── build.gradle.kts (2)

(1) settings.gradle.kts 檔案應(yīng)包含所有子項(xiàng)目。
(2) 每個(gè)子項(xiàng)目應(yīng)該有自己的build.gradle.kts檔案。

利用 Gradle 子模組實(shí)現(xiàn)簡(jiǎn)潔的架構(gòu)

清潔架構(gòu)是一種強(qiáng)調(diào)關(guān)注點(diǎn)分離的設(shè)計(jì)模式，使軟體更易於維護(hù)和測(cè)試。在專(zhuān)案中實(shí)作此架構(gòu)的實(shí)用方法之一是使用 Gradle 的子模組結(jié)構(gòu)來(lái)組織程式碼庫(kù)。以下是如何將 Clean Architecture 與 Gradle 子模組結(jié)合：

乾淨(jìng)的架構(gòu)層：
核心：

• 包含業(yè)務(wù)邏輯、領(lǐng)域模型和應(yīng)用程式規(guī)則。 不依賴(lài)外部或網(wǎng)路。
• 應(yīng)盡可能獨(dú)立於特定於框架的實(shí)作。

外在：

• 處理外部操作或集成，例如資料庫(kù)遷移或第三方服務(wù)互動(dòng)。
• 業(yè)務(wù)邏輯可能依賴(lài) Core，但不應(yīng)依賴(lài) Web。

網(wǎng)頁(yè)：

• 入口點(diǎn)，公開(kāi) REST API 並處理 HTTP 請(qǐng)求。
• 業(yè)務(wù)邏輯依賴(lài)核心，整合可能依賴(lài)外部。

├── .gradle
│   └── ?
├── gradle
│   ├── libs.versions.toml
│   └── wrapper
├── gradlew
├── gradlew.bat
├── settings.gradle.kts (1)
├── sub-project-1
│   └── build.gradle.kts (2) 
├── sub-project-2
│   └── build.gradle.kts (2) 
└── sub-project-3
    └── build.gradle.kts (2)

第 1 步： 建立一個(gè)基於 Java 的 Gradle 專(zhuān)案並將其命名為「SchoolStaff」。

第 2 步： 前往 Spring Initializr 並產(chǎn)生一個(gè)名為 Web.

的 REST API 項(xiàng)目

第 3 步： 建立一個(gè)基於 Java 的 Gradle 專(zhuān)案並命名為 External.

第 4 步： 建立一個(gè)基於 Java 的 Gradle 專(zhuān)案並將其命名為 Core.

根目錄 build.gradle.kts

SchoolStaff/
├── Core/
│   ├── src/
│   │   └── main/
│   │       ├── java/         # Business logic and domain objects
│   │       └── resources/    # Core-specific resources (if any)
│   └── build.gradle.kts
├── External/
│   ├── src/
│   │   └── main/
│   │       ├── java/         # External integration code
│   │       └── resources/    # db/migration and other external resources
│   └── build.gradle.kts
├── Web/
│   ├── src/
│   │   └── main/
│   │       ├── java/         # REST controllers and entry-point logic
│   │       └── resources/    # Application-specific configuration
│   └── build.gradle.kts
├── build.gradle.kts          # Root Gradle build
└── settings.gradle.kts       # Project module settings

settings.gradle.kts

plugins {
    id("java")
}

allprojects {
    group = "school.staff"
    version = "1.0.0"

    repositories {
        mavenLocal()
        mavenCentral()
    }
}

subprojects {
    apply(plugin = "java")

    dependencies {
        testImplementation(platform("org.junit:junit-bom:5.10.0"))
        testImplementation("org.junit.jupiter:junit-jupiter")
    }

    tasks.test {
        useJUnitPlatform()
    }
}

「Web」專(zhuān)案所需的依賴(lài)項(xiàng)。

rootProject.name = "SchoolStaff"

include("Core", "External", "Web")

「核心」專(zhuān)案所需的依賴(lài)項(xiàng)。

dependencies {
    implementation(project(":Core"))
    implementation(project(":External"))
}

「外部」項(xiàng)目所需的依賴(lài)項(xiàng)。

dependencies {
    runtimeOnly(project(":External"))
}

我們使用以下插件進(jìn)行 Flyway 遷移：

import java.sql.DriverManager
import java.util.Properties
// Function to load properties based on the environment
fun loadProperties(env: String): Properties {
    val properties = Properties()
    val propsFile = file("../web/src/main/resources/application-$env.properties")

    if (propsFile.exists()) {
        propsFile.inputStream().use { properties.load(it) }
    } else {
        throw GradleException("Properties file for environment '$env' not found: ${propsFile.absolutePath}")
    }

    return properties
}
// Set the environment (default is 'dev' if no argument is passed)
val env = project.findProperty("env")?.toString() ?: "dev"

// Load properties for the chosen environment
val dbProps = loadProperties(env)
buildscript {
    dependencies {
        classpath("org.flywaydb:flyway-database-postgresql:11.1.0") // This is required for the flyway plugin to work on the migration, otherwise it will throw an error as No Database found
        classpath("org.postgresql:postgresql:42.7.4")
    }
}
plugins {
    id("java-library")
    id("org.flywaydb.flyway") version "11.0.1"
}

group = "school.staff"
version = "unspecified"

repositories {
    mavenLocal()
    mavenCentral()
}

dependencies {
    implementation("org.springframework.boot:spring-boot-starter-data-jpa:3.4.0")
    implementation("org.postgresql:postgresql:42.7.4")
    implementation("org.flywaydb:flyway-core:11.0.1")
    implementation("org.flywaydb:flyway-database-postgresql:11.0.1")
    implementation("org.flywaydb:flyway-gradle-plugin:11.0.1")

    implementation (project(":Core"))
    testImplementation(platform("org.junit:junit-bom:5.10.0"))
    testImplementation("org.junit.jupiter:junit-jupiter")
}

tasks.test {
    useJUnitPlatform()
}

// Task to create the database if it doesn't exist
tasks.register("createDatabase") {
    doLast {
        val dbUrl = dbProps["spring.datasource.url"] as String
        val dbUsername = dbProps["spring.datasource.username"] as String
        val dbPassword = dbProps["spring.datasource.password"] as String

        // Extract the base URL and database name
        val baseDbUrl = dbUrl.substringBeforeLast("/")+ "/"
        val dbName = dbUrl.substringAfterLast("/")

        // Connect to the PostgreSQL server (without the specific database)
        DriverManager.getConnection(baseDbUrl, dbUsername, dbPassword).use { connection ->
            val stmt = connection.createStatement()
            val resultSet = stmt.executeQuery("SELECT 1 FROM pg_database WHERE datname = '$dbName'")
            if (!resultSet.next()) {
                println("Database '$dbName' does not exist. Creating it...")
                stmt.executeUpdate("CREATE DATABASE \"$dbName\"")
                println("Database '$dbName' created successfully.")
            } else {
                println("Database '$dbName' already exists.")
            }
        }
    }
}

flyway {
    url = dbProps["spring.datasource.url"] as String
    user = dbProps["spring.datasource.username"] as String
    password = dbProps["spring.datasource.password"] as String
    locations = arrayOf("classpath:db/migration")
    baselineOnMigrate = true
}

 //Ensure classes are built before migration
tasks.named("flywayMigrate").configure {
    dependsOn(tasks.named("createDatabase"))
    dependsOn(tasks.named("classes"))
}

這種方法非常適合生產(chǎn)環(huán)境，因?yàn)樗_保了受控且可靠的遷移。我們不會(huì)在每次應(yīng)用程式啟動(dòng)時(shí)自動(dòng)運(yùn)行遷移，而是僅在必要時(shí)執(zhí)行遷移，從而提供更大的靈活性和控制力。

我們也利用 Spring 應(yīng)用程式中的 application.properties 檔案來(lái)管理資料庫(kù)連線(xiàn)和憑證。 BaselineOnMigrate = true 設(shè)定可確保將初始遷移用作未來(lái)遷移的基準(zhǔn)。

 plugins {
    id("org.flywaydb.flyway") version "11.0.1"
}

我們可以使用 JPA Buddy 產(chǎn)生外部專(zhuān)案的 resources/db/migration 目錄中的所有遷移檔案。

V1__Initial_Migration

flyway {
    url = dbProps["spring.datasource.url"] as String
    user = dbProps["spring.datasource.username"] as String
    password = dbProps["spring.datasource.password"] as String
    locations = arrayOf("classpath:db/migration")
    baselineOnMigrate = true
}

從根項(xiàng)目中，我們可以使用以下命令執(zhí)行 Flyway 遷移：

CREATE TABLE _user
(
    id                 UUID NOT NULL,
    created_by         UUID,
    created_date       TIMESTAMP WITH TIME ZONE,
    last_modified_by   UUID,
    last_modified_date TIMESTAMP WITH TIME ZONE,
    first_name         VARCHAR(255),
    last_name          VARCHAR(255),
    email              VARCHAR(255),
    password           VARCHAR(255),
    tenant_id          UUID,
    CONSTRAINT pk__user PRIMARY KEY (id)
);

這會(huì)將所有遷移檔案套用到資料庫(kù)。

結(jié)論

我們探索如何在 Gradle 多模組專(zhuān)案中使用 Flyway 自動(dòng)化資料庫(kù)遷移，這對(duì)於在 CI/CD 環(huán)境中維護(hù)架構(gòu)一致性至關(guān)重要。

我們還介紹了 Gradle 如何支援多項(xiàng)目構(gòu)建，將複雜的項(xiàng)目組織成可管理的子項(xiàng)目，每個(gè)子項(xiàng)目都有自己的構(gòu)建配置，統(tǒng)一在根構(gòu)建腳本下。

最後，我們將 Clean Architecture 與 Gradle 模組結(jié)合起來(lái)，將專(zhuān)案建置為核心層、外部層和 Web 層，促進(jìn)關(guān)注點(diǎn)和依賴(lài)管理的清晰分離。

這些實(shí)踐增強(qiáng)了模組化、自動(dòng)化和可維護(hù)性，為可擴(kuò)展、無(wú)錯(cuò)誤的軟體開(kāi)發(fā)奠定了基礎(chǔ)。

以上是多模組 Gradle 專(zhuān)案中的 Flyway 遷移（乾淨(jìng)架構(gòu)）的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！