Flyway 数据库迁移工具详解：安装、配置与使用教程

Flyway 数据库迁移工具详解：安装、配置与使用教程

Flyway 是一个开源的数据库迁移工具，用于管理和自动化数据库的版本控制。它可以与各种关系型数据库配合使用，帮助开发团队在应用程序开发生命周期中轻松处理数据库模式的变更。以下是 Flyway 的详细介绍，包括其核心功能、基本概念、安装和使用步骤。

核心功能

1. 数据库迁移：

• 通过一组迁移脚本管理数据库模式变更，包括创建表、修改表结构、插入初始数据等。

2. 版本控制：

• 每个迁移脚本都有一个唯一的版本号，Flyway 可以确保迁移脚本按正确的顺序应用，并且不会重复执行已经应用过的脚本。

3. 支持多种数据库：

• 支持多种关系型数据库，包括 PostgreSQL、MySQL、Oracle、SQL Server、SQLite 等。

4. 集成工具和框架：

• 可以与多种构建工具（如 Maven、Gradle）和框架（如 Spring Boot）集成，方便在构建和部署过程中自动执行数据库迁移。

基本概念

1. 迁移（Migration）：

• 迁移是一个 SQL 文件或 Java 类，包含需要应用于数据库的变更。Flyway 会按照版本顺序执行这些迁移。

2. 版本号（Versioned）：

• 每个迁移文件都有一个唯一的版本号，格式为 V[版本号]__描述.sql，例如 V1__initial_schema.sql。

3. 重复迁移（Repeatable Migration）：

• 这些迁移没有版本号，而是以 R 开头，格式为 R__描述.sql，例如 R__refresh_views.sql。重复迁移会在每次运行 Flyway 时检查是否有变更，如果有，则重新执行。

4. 元数据表（Metadata Table）：

• Flyway 在数据库中创建一个元数据表（默认名为 flyway_schema_history），用来跟踪已经应用的迁移和其状态。

安装与配置

1. 使用命令行工具

下载并解压 Flyway 命令行工具：

wget https://repo1.maven.org/maven2/org/flywaydb/flyway-commandline/8.5.11/flyway-commandline-8.5.11-linux-x64.tar.gz
tar -xzf flyway-commandline-8.5.11-linux-x64.tar.gz
cd flyway-8.5.11

配置数据库连接：
编辑 conf/flyway.conf 文件，添加数据库连接信息：

flyway.url=jdbc:postgresql://localhost:5432/mydb
flyway.user=myuser
flyway.password=mypassword

创建迁移脚本：
在 sql 目录下创建迁移脚本，例如 V1__initial_schema.sql：

CREATE TABLE example (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100) NOT NULL
);

执行迁移：

./flyway migrate

2. 使用 Maven

2.1 在 pom.xml 中添加 Flyway 插件：

<build>
    <plugins>
        <plugin>
            <groupId>org.flywaydb</groupId>
            <artifactId>flyway-maven-plugin</artifactId>
            <version>8.5.11</version>
            <configuration>
                <url>jdbc:postgresql://localhost:5432/mydb</url>
                <user>myuser</user>
                <password>mypassword</password>
            </configuration>
        </plugin>
    </plugins>
</build>

2.2 创建迁移脚本：
在 src/main/resources/db/migration 目录下创建迁移脚本，例如 V1__initial_schema.sql。

2.3 执行迁移：

mvn flyway:migrate

3. 使用 Gradle

3.1 在 build.gradle 中添加 Flyway 插件：

plugins {
    id 'org.flywaydb.flyway' version '8.5.11'
}

flyway {
    url = 'jdbc:postgresql://localhost:5432/mydb'
    user = 'myuser'
    password = 'mypassword'
}

3.2 创建迁移脚本：
在 src/main/resources/db/migration 目录下创建迁移脚本，例如 V1__initial_schema.sql。

3.3 执行迁移：

./gradlew flywayMigrate

4. 集成 Spring Cloud

4.1 在 pom.xml 中添加 Flyway 依赖：

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

4.2 配置数据库连接：

在 src/main/resources/application.properties 中添加 Flyway 配置：

spring.datasource.url=jdbc:postgresql://localhost:5432/mydb
spring.datasource.username=myuser
spring.datasource.password=mypassword
spring.flyway.enabled=true

4.3 创建迁移脚本：

在 src/main/resources/db/migration 目录下创建迁移脚本，例如 V1__initial_schema.sql。

4.4 启动 Spring Cloud 应用：

在应用启动时，Flyway 会自动检测并执行迁移脚本。

5. 使用示例

假设你有一个 Spring Cloud 应用，并且你需要创建一个用户表和一个订单表。你可以按照以下步骤创建迁移脚本：

5.1 创建第一个迁移脚本 V1__create_user_table.sql：

CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    username VARCHAR(50) NOT NULL,
    password VARCHAR(50) NOT NULL,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

5.2 创建第二个迁移脚本 V2__create_order_table.sql：

CREATE TABLE orders (
    id SERIAL PRIMARY KEY,
    user_id INT NOT NULL,
    product_name VARCHAR(100) NOT NULL,
    price DECIMAL(10, 2) NOT NULL,
    order_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    FOREIGN KEY (user_id) REFERENCES users(id)
);

5.3 将这两个文件放入 src/main/resources/db/migration 目录中。

5.4 启动 Spring Boot 应用，Flyway 会自动执行这两个迁移脚本，创建 users 和 orders 表。

参考资源

• Flyway 官方网站
• Flyway GitHub 仓库

通过以上内容，你应该对 Flyway 有了一个全面的了解，并且知道如何将其集成到你的项目中以管理数据库迁移。如果你有进一步的问题或需要具体的指导，欢迎继续提问。