Flyway 清理（Clean）

Flyway 是一个流行的数据库迁移管理工具，主要用于管理和跟踪数据库结构和数据的变更。除了数据库的迁移功能外，Flyway 还提供了一个功能强大的命令：clean，用于删除数据库中的所有对象，包括表、视图、索引、存储过程和触发器。clean 命令可以将数据库恢复到一个全新的状态，类似于“重置”数据库的功能。

clean 命令非常适合在开发和测试环境中使用，允许开发者快速清空数据库，以便重新执行所有的迁移文件。然而，clean 命令在生产环境中应谨慎使用，因为它会删除所有数据和结构。

1. 什么是 Flyway Clean？

Flyway 的 clean 命令用于清空数据库中的所有对象，将数据库恢复到一个初始的空白状态。Flyway 清理的对象包括但不限于：

• 表
• 视图
• 索引
• 外键约束
• 存储过程
• 函数
• 触发器

此外，Flyway 还会删除其用来记录迁移历史的 flyway_schema_history 表。

1.1 清理的作用

在开发过程中，数据库的表结构和数据可能会随着业务需求不断变化。为了保持数据库的干净和一致，特别是在测试或开发环境中，开发者有时需要将数据库重置为初始状态，以便重新执行所有的迁移文件。此时，Flyway 的 clean 命令提供了快速清空数据库的方式。

1.2 什么时候使用 Flyway Clean？

Flyway clean 命令的主要使用场景包括：

• 开发环境：开发人员在本地调试时，可能需要频繁重置数据库状态，以便反复执行迁移文件进行测试。
• 测试环境：在测试环境中执行自动化测试时，清空数据库并重新应用所有迁移，可以确保数据库的状态与测试需求一致。
• 数据库重构：在进行数据库重构或变更较大时，可以通过 clean 重置数据库结构，确保所有的迁移文件都能够正确执行。

注意：clean 命令会删除数据库中的所有对象，因此在生产环境中应谨慎使用。

2. Flyway Clean 的工作原理

clean 命令执行时，会按照以下步骤清空数据库：

1. 删除数据库对象：Flyway 会扫描数据库中所有的表、视图、索引、触发器等对象，并逐个删除。
2. 删除 Flyway 历史记录表：flyway_schema_history 表用于记录每个迁移文件的执行历史，clean 命令执行时会将该表一并删除。
3. 恢复数据库到空白状态：执行完所有删除操作后，数据库将恢复为一个干净的初始状态，没有任何表和数据。

3. 使用 Flyway Clean 命令

Flyway 提供了多种方式来执行 clean 命令，包括通过命令行、Spring Boot 和 Flyway 的 Java API。下面将分别介绍这些方式的使用方法。

3.1 命令行使用 Flyway Clean

最直接的使用方式是通过 Flyway 的命令行工具来执行 clean 命令。Flyway 的命令行工具需要先进行安装，安装后可以通过如下命令来执行 clean 操作：

flyway clean

Flyway 会根据配置文件中的数据库连接信息，连接到目标数据库并执行清空操作。

3.2 Spring Boot 集成中的 Flyway Clean

在 Spring Boot 项目中，Flyway 的 clean 命令可以通过 Spring Boot 提供的配置类手动调用，或在应用启动时自动执行。

通过 Spring Boot 启动时执行 clean 操作，可以通过 Flyway Bean 自定义配置来实现：

import org.flywaydb.core.Flyway;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FlywayConfig {

    @Bean(initMethod = "clean")
    public Flyway flyway() {
        return Flyway.configure()
                .dataSource("jdbc:mysql://localhost:3306/mydb", "root", "password")
                .load();
    }
}

这个配置将在应用启动时自动执行 clean 命令，清空数据库中的所有内容。

3.3 使用 Flyway Java API 执行 Clean

开发者还可以通过 Flyway 的 Java API 手动执行 clean 命令，这在需要编程控制时非常有用。使用 Java API 执行 clean 的代码示例如下：

import org.flywaydb.core.Flyway;

public class FlywayCleanExample {

    public static void main(String[] args) {
        Flyway flyway = Flyway.configure()
                .dataSource("jdbc:mysql://localhost:3306/mydb", "root", "password")
                .load();

        // 执行清空操作
        flyway.clean();
    }
}

通过这种方式，开发者可以在代码中灵活控制 Flyway 的 clean 行为，并结合其他业务逻辑进行调用。

4. Flyway Clean 的高级配置

Flyway 提供了几个用于自定义 clean 操作的配置选项，帮助开发者更灵活地控制数据库的清理行为。

4.1 限制 clean 执行

为了防止误操作，Flyway 允许开发者禁用 clean 命令，避免开发人员或系统在不适当的情况下误执行 clean。可以通过以下配置禁用 clean 命令：

spring:
  flyway:
    clean-disabled: true  # 禁用 clean 命令

启用该配置后，即使尝试执行 clean 命令，Flyway 也会抛出异常并阻止数据库清空操作。

4.2 清理特定的 Schema

在一些数据库中，可能存在多个模式（schema），开发者可能只想清理某些特定的模式，而不是整个数据库。Flyway 支持通过 schemas 参数指定要清理的模式：

spring:
  flyway:
    schemas: public, test_schema  # 只清理 public 和 test_schema 模式

通过这种方式，Flyway 只会清理指定的模式，而保留其他模式的内容。

4.3 清理自定义对象

Flyway 默认会清理大多数数据库对象，但如果需要扩展 Flyway 的清理行为，删除特定的自定义对象，可以通过实现 Flyway 的清理扩展来完成。

5. 使用 Flyway Clean 的注意事项

虽然 Flyway 的 clean 命令在开发和测试中非常有用，但在生产环境中使用时应格外谨慎，因为 clean 会删除数据库中的所有对象和数据，操作不可逆。因此，建议采取以下措施来确保 clean 命令的安全性：

5.1 禁用生产环境中的 Clean

在生产环境中，强烈建议禁用 clean 命令，防止误操作导致的灾难性后果。可以通过在生产环境的配置文件中禁用 clean 命令：

spring:
  profiles: production
  flyway:
    clean-disabled: true  # 禁用 clean 命令

5.2 清理前备份数据

在执行 clean 命令之前，建议先对数据库进行备份，以确保能够恢复数据。如果误执行了 clean 操作，备份数据可以帮助快速恢复数据库。

5.3 仅在开发和测试环境使用 Clean

一般来说，Flyway 的 clean 命令应仅用于开发环境和测试环境。在这些环境中，开发者可以随时清理数据库并重新执行迁移，以确保数据库的结构和数据保持一致。在生产环境中，数据库通常不应频繁重置，因此应避免使用 clean 命令。

6. 使用 Flyway Clean 的最佳实践

为了更好地使用 Flyway 的 clean 命令，开发者可以遵循以下最佳实践：

6.1 在 CI/CD 中集成

在 CI/CD 流水线中，clean 命令可以用于重置测试环境的数据库。通过在 CI/CD 流水线中集成 clean 命令，可以确保每次自动化测试开始前，数据库都是一个干净的状态。

例如，在 Jenkins 或 GitLab CI 中，可以通过以下脚本执行 Flyway 的 clean 和 migrate 命令：

flyway clean
flyway migrate

6.2 结合数据填充工具

在执行 clean 命令后，可以结合数据填充工具（如 Spring Boot 的 data.sql 文件）重新填充测试

数据。这样可以在每次清空数据库后，自动恢复一批初始数据用于开发和测试。

结论

Flyway 的 clean 命令是一个非常强大且有用的工具，特别适合在开发和测试环境中使用。通过 clean 命令，开发者可以快速清空数据库中的所有内容，并重新执行迁移操作。然而，在生产环境中，clean 命令应谨慎使用，最好在生产环境中禁用，以避免误操作带来的数据丢失风险。