Flyway 与 Gradle/Maven 集成

Flyway 是一个用于数据库版本控制和迁移的工具，可以通过 SQL 脚本自动化管理数据库结构的变更。为了将 Flyway 更好地融入开发流程，Flyway 可以与 Gradle 或 Maven 构建工具集成，使数据库迁移变得更为高效和自动化。

一、Flyway 与 Gradle 集成

1. 添加 Flyway 插件

要在 Gradle 中集成 Flyway，需要在 build.gradle 文件中添加 Flyway 插件。

plugins {
    id 'org.flywaydb.flyway' version '9.10.2'  // Flyway 插件
}

同时，Flyway 需要通过 JDBC 连接数据库，因此还需要添加数据库驱动依赖。以 MySQL 为例：

dependencies {
    implementation 'mysql:mysql-connector-java:8.0.32'
}

2. Flyway 配置

接下来，配置 Flyway 的数据库连接信息。在 build.gradle 中的 flyway 配置块中添加数据库连接参数：

flyway {
    url = 'jdbc:mysql://localhost:3306/mydatabase'
    user = 'root'
    password = 'password'
    locations = ['filesystem:src/main/resources/db/migration'] // 迁移文件路径
}

上述配置项包括：

url：数据库连接的 URL。
user 和 password：数据库的用户名和密码。
locations：迁移文件的位置，通常放在 src/main/resources/db/migration 下。

3. 执行 Flyway 任务

在 Gradle 中集成 Flyway 后，可以通过 Flyway 提供的任务来执行数据库迁移。常用的 Flyway 任务包括：

flywayMigrate：执行所有未执行的迁移文件。
flywayClean：清空数据库，删除所有表和数据（慎用！）。
flywayInfo：查看当前数据库的迁移状态。
flywayValidate：验证迁移文件的正确性。
flywayRepair：修复迁移历史记录。

执行 Flyway 迁移任务的命令示例：

./gradlew flywayMigrate

执行该命令后，Flyway 将会读取 src/main/resources/db/migration 目录下的 SQL 文件，并将其应用到数据库中。

4. 示例：编写迁移文件

在 src/main/resources/db/migration 目录下，创建 SQL 文件。文件命名规则为 V<版本号>__<描述>.sql。

示例：创建用户表的迁移文件 V1__Create_users_table.sql：

CREATE TABLE users (
    id BIGINT PRIMARY KEY AUTO_INCREMENT,
    name VARCHAR(50) NOT NULL,
    email VARCHAR(100) NOT NULL UNIQUE
);

执行 ./gradlew flywayMigrate 后，Flyway 会将该 SQL 应用于数据库。

5. Gradle 与 Flyway 的优势

通过 Gradle 集成 Flyway 的优势包括：

自动化迁移：数据库迁移任务可以与构建任务集成，确保在应用构建时自动执行迁移操作。
灵活性：开发者可以根据需求编写自定义的 Gradle 任务，结合 Flyway 提供的任务来增强数据库管理的自动化。
统一管理：将数据库迁移作为构建流程的一部分，使数据库 schema 的变更更加可控。

二、Flyway 与 Maven 集成

1. 添加 Flyway 插件

与 Gradle 类似，Flyway 也可以与 Maven 集成。在 pom.xml 文件中添加 Flyway 插件：

<build>
    <plugins>
        <plugin>
            <groupId>org.flywaydb</groupId>
            <artifactId>flyway-maven-plugin</artifactId>
            <version>9.10.2</version>
        </plugin>
    </plugins>
</build>

同样，需要添加数据库驱动依赖，以便 Flyway 通过 JDBC 连接数据库。以 MySQL 为例：

<dependencies>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.32</version>
    </dependency>
</dependencies>

2. Flyway 配置

在 pom.xml 中配置 Flyway 的数据库连接信息。可以在插件的 <configuration> 部分中添加这些信息：

<build>
    <plugins>
        <plugin>
            <groupId>org.flywaydb</groupId>
            <artifactId>flyway-maven-plugin</artifactId>
            <version>9.10.2</version>
            <configuration>
                <url>jdbc:mysql://localhost:3306/mydatabase</url>
                <user>root</user>
                <password>password</password>
                <locations>
                    <location>filesystem:src/main/resources/db/migration</location>
                </locations>
            </configuration>
        </plugin>
    </plugins>
</build>

url：数据库的 JDBC 连接地址。
user 和 password：用于连接数据库的凭据。
locations：迁移文件的路径。

3. 执行 Flyway 迁移

在 Maven 中，Flyway 插件提供了多种命令来执行迁移任务：

mvn flyway:migrate：执行所有新的迁移文件。
mvn flyway:clean：清空数据库（慎用）。
mvn flyway:info：查看迁移状态。
mvn flyway:validate：验证已执行的迁移文件的合法性。
mvn flyway:repair：修复 flyway_schema_history 表中的错误记录。

执行命令示例：

mvn flyway:migrate

运行上述命令后，Flyway 将扫描指定目录下的迁移文件，并将其应用到数据库中。

4. 示例：编写迁移文件

在 src/main/resources/db/migration 目录下编写迁移文件。文件的命名格式为 V<版本号>__<描述>.sql。

示例：创建一个包含用户信息的表，文件名为 V1__Create_users_table.sql：

CREATE TABLE users (
    id BIGINT PRIMARY KEY AUTO_INCREMENT,
    name VARCHAR(50),
    email VARCHAR(100) UNIQUE NOT NULL
);

执行 mvn flyway:migrate 命令后，Flyway 将会读取这个文件并将其应用到数据库中。

5. Maven 与 Flyway 的优势

通过 Maven 集成 Flyway 的优势包括：

简化数据库迁移管理：Flyway 插件可以与 Maven 构建流程紧密结合，确保数据库迁移自动化。
易于配置和使用：通过简单的配置，Flyway 插件可以管理多种数据库迁移任务，使得迁移工作流更具一致性。
适用于 CI/CD：Flyway 可以与 Maven 构建流程中的其他插件（如测试、打包等）结合使用，方便在 CI/CD 环境中进行自动化部署。

三、Flyway 与 Gradle/Maven 集成的对比

虽然 Flyway 与 Gradle 和 Maven 的集成都非常方便，但二者在某些方面有一些细微的区别：

特性	Gradle 集成	Maven 集成
配置灵活性	Gradle 配置更加灵活，可以通过自定义任务扩展功能。	Maven 的插件体系较为简单，直接通过配置项进行控制。
自动化集成	可以轻松与其他 Gradle 插件集成，支持复杂任务依赖。	可以与 Maven 生命周期集成，如 `install`、`deploy` 等。
易用性	配置文件较为简洁，可通过 Kotlin DSL 或 Groovy DSL 进行配置。	配置较为直观，基于 XML 进行管理。
多环境支持	可以通过不同的 Gradle 配置块支持多环境数据库迁移。	可以通过 `profiles` 实现多环境配置。