当前位置：首页 > article >正文

Flyway 基本概念

article 2024/9/22 17:52:30

Flyway 基本概念详解

Flyway 是一款非常流行的数据库版本控制工具，专为管理数据库的变更而设计。它帮助开发者在项目开发过程中自动管理数据库的迁移与版本控制，确保数据库结构的变更和代码版本一致。Flyway 可以自动执行 SQL 脚本或 Java 代码来管理数据库 schema 的迁移、回滚、验证等操作，支持多种数据库类型，如 MySQL、PostgreSQL、Oracle 等。

一、为什么需要 Flyway

在现代软件开发中，数据库 schema 的变更是不可避免的，尤其在持续集成和部署过程中，如何有效管理这些变更变得非常关键。传统的数据库变更管理方式通常是通过手动执行 SQL 脚本来实现，但这种方式存在以下问题：

难以追踪历史变更：手动执行的 SQL 脚本很难记录变更历史，开发团队也难以同步数据库的不同版本。
容易出现版本不一致：数据库版本和代码版本容易出现不同步，导致生产环境中代码与数据库结构不匹配。
难以自动化：在 CI/CD（持续集成/持续交付）管道中，手动执行数据库脚本难以自动化。

Flyway 通过自动化和版本控制的方式解决了这些问题，确保数据库的变更可控、可追踪，并且与代码版本保持一致。

二、Flyway 的工作原理

Flyway 通过管理 SQL 脚本或 Java 代码的方式来控制数据库的版本。每次数据库变更时，开发者创建一个迁移文件（通常是 SQL 脚本），Flyway 会在每次应用启动时检查是否有新的迁移文件，并按顺序执行它们。Flyway 记录已经执行的迁移，并确保每个迁移文件只会执行一次。

1. 核心概念

Migration（迁移）：表示一次数据库变更，通常是 SQL 脚本或 Java 代码。Flyway 会根据迁移文件的命名顺序逐一执行它们。
Version（版本）：每个迁移文件对应一个版本号，Flyway 使用版本号来确定数据库的当前版本和需要执行的迁移文件。
Schema History Table（模式历史表）：Flyway 会在数据库中创建一张用于记录迁移执行历史的表，默认表名为 flyway_schema_history。这张表会记录每个迁移文件的执行状态、执行时间等信息，确保迁移的可追踪性。

2. 迁移文件的命名规则

Flyway 通过迁移文件的命名规则来管理迁移的执行顺序。文件的命名格式为：V{版本号}__{描述}.sql，其中：

V 表示这是一个版本迁移（Versioned Migration）。
{版本号} 表示版本号，Flyway 会根据版本号来确定执行顺序。
{描述} 用于描述这个迁移文件的功能，双下划线 __ 用于分隔版本号和描述。

示例：

V1__Create_users_table.sql：版本 1 的迁移文件，创建 users 表。
V2__Add_email_column_to_users.sql：版本 2 的迁移文件，给 users 表添加 email 列。

Flyway 会根据版本号的顺序执行这些迁移文件，并记录在 flyway_schema_history 表中。

3. 执行流程

Flyway 的执行流程如下：

检查当前数据库版本：Flyway 首先会检查数据库的 flyway_schema_history 表，查看当前数据库版本。
扫描迁移文件：Flyway 会扫描迁移目录下的 SQL 文件，并根据文件的命名顺序确定哪些文件需要执行。
执行未执行的迁移文件：Flyway 会逐一执行那些版本号大于当前数据库版本的迁移文件。
记录迁移历史：每次迁移执行成功后，Flyway 会将迁移文件的信息记录到 flyway_schema_history 表中。

三、Flyway 的核心功能

Flyway 提供了多个与数据库版本控制相关的核心功能，包括迁移、回滚、验证等操作。

1. 数据库迁移

Flyway 的核心功能就是执行数据库迁移。通过 flyway migrate 命令，Flyway 会扫描迁移文件并应用新的数据库变更。

迁移操作：执行所有未执行的迁移文件，将数据库升级到最新版本。
幂等性：每个迁移文件只会执行一次，如果迁移文件已经在数据库中执行过，Flyway 不会重复执行。

示例：执行数据库迁移操作

flyway migrate

2. 回滚（Undo）

Flyway 支持通过 undo 迁移来实现回滚操作。这是为了在数据库迁移后，如果发现问题，可以撤销已经应用的迁移。回滚文件以 U{版本号}__{描述}.sql 命名，Flyway 会根据版本号倒序执行回滚文件。

示例：回滚文件命名

U1__Undo_create_users_table.sql

执行回滚操作：

flyway undo

注意：Flyway 只有在 Flyway Teams 版本中才支持 undo 操作，开源版本不支持。

3. 验证迁移文件

Flyway 提供了 validate 命令，用于验证迁移文件的完整性和一致性。如果某个已经执行过的迁移文件被修改过，Flyway 会在验证时抛出异常，确保迁移的安全性。

示例：执行验证操作

flyway validate

4. 清空数据库

Flyway 提供了 clean 命令，用于清空数据库中的所有表、视图、索引等。这个操作会删除数据库中的所有数据，因此应谨慎使用。

示例：执行清空操作

flyway clean

5. 修复历史记录

有时迁移文件可能会发生丢失或版本冲突，Flyway 提供了 repair 命令，用于修复 flyway_schema_history 表中的不一致信息。

示例：修复历史记录

flyway repair

四、Flyway 的使用方法

Flyway 可以通过命令行、Maven 插件、Gradle 插件、Spring Boot 自动配置等多种方式使用。下面是几种常见的使用方式。

1. 命令行使用

Flyway 提供了独立的命令行工具，开发者可以通过下载 Flyway，并配置数据库连接参数后直接在命令行中使用。

Flyway 配置文件 flyway.conf 示例：

flyway.url=jdbc:mysql://localhost:3306/mydb
flyway.user=root
flyway.password=secret
flyway.locations=filesystem:./db/migration

在命令行中执行迁移操作：

flyway migrate

2. 与 Maven 集成

Flyway 提供了 Maven 插件，开发者可以在项目的 pom.xml 文件中引入 Flyway 插件，并通过 Maven 构建时执行数据库迁移。

在 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>

在 Maven 中执行迁移：

mvn flyway:migrate

3. 与 Spring Boot 集成

Flyway 与 Spring Boot 集成非常紧密，Spring Boot 会自动扫描 db/migration 目录并在应用启动时自动执行迁移。

在 application.yml 中配置 Flyway：

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