Flyway 安装与配置

最新推荐文章于 2025-06-05 09:00:40 发布

原创最新推荐文章于 2025-06-05 09:00:40 发布 · 2.1k 阅读

12 ·

CC 4.0 BY-SA版权

文章标签：

#oracle #数据库

Flyway 安装与配置详解

Flyway 是一个开源的数据库版本控制工具，它帮助开发者在多个环境中保持数据库结构的一致性，并实现数据库 schema 的变更自动化管理。本文将详细介绍 Flyway 的安装与配置，包括命令行工具的安装、集成 Maven 和 Spring Boot 的方法，以及如何配置和使用 Flyway。

一、Flyway 的安装

Flyway 可以通过多种方式安装和使用，最常见的方式是使用命令行工具或集成到构建工具（如 Maven、Gradle）中。下面我们分别介绍命令行工具的安装、Maven 插件和 Spring Boot 集成的使用方法。

1. 命令行工具安装

Flyway 提供了跨平台的命令行工具，适用于 Linux、macOS 和 Windows 系统。通过命令行工具，开发者可以直接执行 Flyway 的各种操作，如迁移、验证、回滚等。

（1）下载 Flyway 命令行工具

首先，从 Flyway 的官方网站下载适合你操作系统的版本：

官网下载地址：https://flywaydb.org/download

（2）解压安装

下载完成后，将压缩包解压到指定的目录。

# Linux 或 macOS
unzip flyway-commandline-*.zip
# Windows
Extract the .zip file

解压完成后，可以将 Flyway 的 flyway 命令添加到环境变量中，方便在任何目录下执行。

（3）验证安装

安装完成后，可以通过以下命令验证 Flyway 是否安装成功：

flyway -v

如果显示 Flyway 的版本信息，则说明安装成功。

2. 使用 Homebrew 安装（macOS）

macOS 用户可以通过 Homebrew 安装 Flyway：

brew install flyway

安装完成后，可以通过以下命令验证：

flyway -v

3. 通过 Docker 安装

Flyway 也可以通过 Docker 镜像使用，这是一个方便的方式，特别是在 CI/CD 管道中。可以通过以下命令运行 Flyway 的 Docker 容器：

docker run --rm -v /path/to/sql:/flyway/sql flyway/flyway migrate

这条命令会执行挂载目录中的 SQL 脚本文件并进行数据库迁移。

二、Flyway 配置

Flyway 需要一个配置文件来连接数据库并指定数据库迁移脚本的存储位置。Flyway 的配置文件通常命名为 flyway.conf 或者通过命令行直接传递配置参数。

1. 配置文件 `flyway.conf`

Flyway 使用 flyway.conf 文件来读取数据库的连接参数和迁移脚本位置。默认情况下，Flyway 会在当前目录中查找该配置文件。

示例 flyway.conf 配置文件：

# 数据库连接配置
flyway.url=jdbc:mysql://localhost:3306/mydb
flyway.user=root
flyway.password=secret

# SQL 文件的存储位置
flyway.locations=filesystem:./sql

在这个配置文件中：

flyway.url 是数据库的 JDBC 连接 URL。
flyway.user 和 flyway.password 是数据库的连接用户名和密码。
flyway.locations 指定了迁移 SQL 脚本的存储位置，这里指向项目根目录下的 sql 文件夹。

2. 配置环境变量

Flyway 也可以通过环境变量来配置。常用的 Flyway 环境变量如下：

export FLYWAY_URL=jdbc:mysql://localhost:3306/mydb
export FLYWAY_USER=root
export FLYWAY_PASSWORD=secret
export FLYWAY_LOCATIONS=filesystem:./sql

配置好环境变量后，Flyway 将自动读取这些变量，无需配置 flyway.conf 文件。

3. 命令行参数配置

Flyway 的配置也可以直接通过命令行参数指定。以下是通过命令行参数执行迁移的示例：

flyway -url=jdbc:mysql://localhost:3306/mydb -user=root -password=secret migrate

三、Flyway 命令行工具的使用

安装并配置好 Flyway 之后，可以使用命令行工具执行各种数据库操作。Flyway 提供了丰富的命令，常用的有 migrate、clean、info、validate、repair 等。

1. migrate：数据库迁移

migrate 是 Flyway 最常用的命令，用于执行数据库迁移操作。它会检查所有未执行的 SQL 脚本，并依次执行它们。

flyway migrate

Flyway 会自动执行 flyway.locations 指定目录中的迁移文件。

2. info：查看迁移状态

info 命令用于查看数据库的当前迁移状态，包括已经执行的迁移文件和待执行的文件。

flyway info

该命令会输出每个迁移文件的执行状态、执行时间等信息。

3. validate：验证迁移文件的完整性

validate 命令用于验证迁移文件是否被修改或损坏。如果已经执行的迁移文件发生了修改，Flyway 会抛出异常，提示文件的完整性出现问题。

flyway validate

4. clean：清空数据库

clean 命令用于删除数据库中的所有表、视图、索引等。这是一个危险操作，通常只在开发环境或测试环境中使用。

flyway clean

警告：这个操作会清空整个数据库！

5. repair：修复迁移历史

repair 命令用于修复 flyway_schema_history 表中的不一致记录。通常在迁移文件被删除或迁移失败后使用。

flyway repair

四、集成 Flyway 到 Maven

Flyway 可以集成到 Maven 项目中，Flyway 提供了一个 Maven 插件，开发者可以在构建项目时自动执行数据库迁移。

1. 在 `pom.xml` 中添加 Flyway 插件

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

locations 参数指定了 SQL 脚本的存储位置。

2. 使用 Maven 执行 Flyway 迁移

在 Maven 项目中，可以通过以下命令执行 Flyway 迁移：

mvn flyway:migrate

同样可以使用 flyway:info、flyway:validate 等命令查看迁移状态和验证迁移文件。

五、集成 Flyway 到 Spring Boot

Flyway 与 Spring Boot 的集成非常简单，Spring Boot 自带对 Flyway 的自动配置支持。

1. 引入 Flyway 依赖

在 pom.xml 中添加 Flyway 依赖：

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

2. 配置 Flyway

在 application.yml 中配置 Flyway 参数：

spring:
  flyway:
    enabled: true
    url: jdbc:mysql://localhost:3306/mydb
    user: root
    password: secret
    locations: classpath:/db/migration

enabled 参数表示是否启用 Flyway，默认为 true。
locations 参数指定了 SQL 脚本存储的位置。

3. 执行 Flyway 迁移

在 Spring Boot 项目启动时，Flyway 会自动执行数据库迁移操作，无需手动调用。

六、迁移脚本的编写

Flyway 支持通过 SQL 脚本或 Java 代码进行迁移。最常见的方式是通过 SQL 文件来管理数据库迁移。

1. 迁移脚本的命名规则

迁移文件的命名规则通常为 V{版本号}__{描述}.sql，其中：

V 表示版本号迁移。
{版本号} 表示数据库迁移的版本，Flyway 根据版本号顺序执行迁移。
{描述} 是对迁移内容的简短描述，用双下划线分隔。

示例：

V1__Create_users_table.sql：表示版本 1 的迁移文件，用于创建 users

表。

V2__Add_email_column.sql：表示版本 2 的迁移文件，用于向表中添加 email 列。

2. 编写 SQL 迁移文件

编写 SQL 文件来定义数据库的结构变更，例如创建表、修改表结构等：

-- V1__Create_users_table.sql
CREATE TABLE users (
    id INT PRIMARY KEY AUTO_INCREMENT,
    name VARCHAR(50),
    email VARCHAR(50)
);

Flyway 会根据文件名自动识别版本并按顺序执行。

七、总结

Flyway 是一个功能强大、简单易用的数据库版本控制工具，它通过管理数据库的迁移文件，确保数据库在不同环境下的一致性。通过 Flyway，开发者可以轻松管理数据库 schema 的变更，确保项目在开发、测试、生产等环境中的数据库保持同步。Flyway 提供了多种集成方式，包括命令行工具、Maven 插件和 Spring Boot 集成，开发者可以根据项目需求选择合适的方式来使用 Flyway。