Flyway 与 Spring Boot 集成

🕗 发布于 2024-09-23 09:11 spring boot oracle 后端

Flyway 与 Spring Boot 集成

Flyway 是一个流行的数据库版本控制工具，它帮助开发者和运维人员管理数据库模式和数据变更。Flyway 可以自动执行数据库迁移脚本，确保数据库结构在不同环境中的一致性。Spring Boot 与 Flyway 的集成非常紧密，可以在应用启动时自动执行数据库迁移，使得数据库的管理变得更加简单、自动化。

1. Flyway 与 Spring Boot 的关系

Spring Boot 提供了对 Flyway 的原生支持。当 Spring Boot 启动时，Flyway 会自动扫描并执行数据库迁移脚本，无需手动编写代码来调用 Flyway 的 API。这种集成方式可以让开发者更加专注于业务逻辑，而不用担心数据库版本管理问题。

Flyway 的迁移文件通常是 SQL 文件，存放在 Spring Boot 项目的 resources/db/migration 目录下。Flyway 会根据文件名中的版本号按顺序执行这些 SQL 文件。

2. Maven 依赖配置

要在 Spring Boot 项目中集成 Flyway，首先需要在 pom.xml 中添加 Flyway 的依赖。

<dependencies>
    <!-- Flyway 依赖 -->
    <dependency>
        <groupId>org.flywaydb</groupId>
        <artifactId>flyway-core</artifactId>
        <version>8.5.13</version>
    </dependency>

    <!-- Spring Boot Starter JDBC（根据数据库类型选择）-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jdbc</artifactId>
    </dependency>

    <!-- 数据库驱动，例如 MySQL -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.31</version>
    </dependency>
</dependencies>

在引入 Flyway 依赖后，Spring Boot 会自动检测并执行数据库迁移操作。

3. 基本配置

Flyway 的配置可以通过 application.yml 或 application.properties 文件来实现。最常见的配置包括数据库连接信息和迁移文件的位置。

3.1 数据库连接配置

在 application.yml 文件中添加数据库连接的配置信息：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: yourpassword
    driver-class-name: com.mysql.cj.jdbc.Driver
  flyway:
    enabled: true  # 默认启用 Flyway
    locations: classpath:db/migration  # 迁移文件存放路径

spring.datasource.url、spring.datasource.username 和 spring.datasource.password：用于配置数据库连接的 URL、用户名和密码。
spring.flyway.enabled：用于启用或禁用 Flyway，默认为启用。
spring.flyway.locations：指定迁移文件的位置，默认为 classpath:db/migration，即项目中的 resources/db/migration 目录。

3.2 迁移文件的命名规则

Flyway 使用严格的命名规则来管理数据库的迁移文件。迁移文件的命名格式如下：

V[版本号]__[描述].sql

例如：

V1__Create_user_table.sql：表示版本 1，创建用户表。
V2__Add_email_column.sql：表示版本 2，为用户表添加邮箱字段。

Flyway 会按照版本号的顺序依次执行这些 SQL 文件，并将执行记录存储在数据库中的 flyway_schema_history 表中。

4. Flyway 的使用场景

Flyway 与 Spring Boot 集成后，可以自动执行数据库迁移操作，适用于多种场景，如数据库的初始化、版本升级、数据修复等。

4.1 数据库初始化

在一个新的项目中，数据库通常是从无到有的。在项目启动时，Flyway 会自动执行数据库迁移文件，创建初始的数据库结构。

例如，创建用户表的迁移文件 V1__Create_user_table.sql：

CREATE TABLE users (
    id INT PRIMARY KEY AUTO_INCREMENT,
    username VARCHAR(50) NOT NULL,
    email VARCHAR(100)
);

将该文件放置在 resources/db/migration 目录下，当 Spring Boot 应用启动时，Flyway 会自动执行该 SQL 文件，并在数据库中创建 users 表。

4.2 数据库版本升级

随着项目的迭代，数据库表结构可能会发生变化。Flyway 可以帮助开发者管理数据库的版本升级操作。

例如，为 users 表添加邮箱字段的迁移文件 V2__Add_email_column.sql：

ALTER TABLE users ADD COLUMN email VARCHAR(100);

当应用启动时，Flyway 会自动检测到版本 2 的迁移文件，并执行该文件的内容，将数据库表结构更新到最新的版本。

4.3 数据修复与迁移

除了结构变更外，Flyway 还可以执行数据迁移和修复操作。例如，将一些默认数据插入到表中的迁移文件 V3__Insert_default_users.sql：

INSERT INTO users (username, email) VALUES ('admin', 'admin@example.com');

Flyway 会在执行迁移时插入这些默认数据，确保数据库的一致性。

5. 高级配置与使用

除了基本的迁移功能外，Flyway 还提供了一些高级功能，如基准点、校验、回滚等。Spring Boot 对这些功能提供了便捷的配置选项。

5.1 基准点（Baseline）

在某些情况下，数据库已经存在一段时间，但未使用 Flyway 进行版本控制。这时可以使用 基准点 功能，将当前数据库状态标记为某个版本，之后的迁移会从该版本开始。

在 application.yml 中启用基准点：

spring:
  flyway:
    baseline-on-migrate: true  # 如果数据库为空时，是否执行基准点操作
    baseline-version: 1        # 基准点的版本号，默认为 1

启用基准点后，Flyway 会将当前数据库状态标记为版本 1，并从下一个版本开始执行迁移文件。

5.2 校验（Validate）

校验是 Flyway 的一个重要功能，用于在执行迁移前验证所有迁移文件的完整性和一致性。Flyway 会检查迁移文件的版本号和校验和（Checksum），确保迁移文件没有被修改过。

在 application.yml 中启用校验功能：

spring:
  flyway:
    validate-on-migrate: true  # 每次迁移前验证迁移文件

启用后，Flyway 会在每次迁移前执行校验，确保所有迁移文件的版本和内容没有发生变化。如果发现文件内容被修改，Flyway 会报错并终止迁移。

5.3 回滚（Undo）

Flyway 支持 回滚迁移，即在某些情况下，如果某次迁移发生错误或不再需要，可以通过回滚迁移撤销该变更。回滚迁移文件的命名以 U 开头，例如：

U1__Drop_user_table.sql：撤销第一个迁移，删除 users 表。

Flyway 会自动识别回滚迁移文件，并在需要时执行回滚操作。需要注意的是，回滚功能并不是默认启用的，开发者需要显式地编写回滚脚本。

5.4 忽略迁移失败

在某些场景中，开发者希望忽略某些迁移文件的执行错误，并继续执行后续的迁移。可以通过配置 Flyway 来忽略迁移失败：

spring:
  flyway:
    ignore-failed-migrations: true  # 忽略迁移失败的错误

启用该选项后，Flyway 在遇到迁移失败时不会终止执行，而是继续执行后续的迁移文件。

6. 自定义 Flyway 配置

Spring Boot 提供了对 Flyway 的默认配置，但在某些场景下，开发者可能需要自定义 Flyway 的行为。可以通过 Java 配置类来自定义 Flyway 的配置。

例如，禁用 Flyway 的自动迁移，并手动执行迁移操作：

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

@Configuration
public class FlywayConfig {

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

在这个配置中，使用 `Flyway

.configure()手动配置数据源和基准点选项，并通过migrate()` 方法在应用启动时执行迁移。

7. Flyway 与 CI/CD 集成

Flyway 很容易与 CI/CD 流水线集成，确保数据库的自动化管理。通过将 Flyway 命令行工具集成到 Jenkins、GitLab CI 等工具中，可以在每次代码部署时自动执行数据库迁移，确保数据库结构与代码同步。

例如，在 CI/CD 流水线中使用 Flyway 命令行工具执行迁移：

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

通过这种方式，Flyway 可以在部署过程中自动管理数据库的变更，确保数据库与应用程序代码的版本一致。

结论

Flyway 与 Spring Boot 的集成为开发者提供了一种简单、自动化的方式来管理数据库的变更。通过 Flyway，开发者可以轻松管理数据库迁移、版本控制、数据修复等操作，并确保数据库在不同环境中的一致性。Flyway 提供的高级功能如基准点、校验和回滚，使得数据库变更的管理更加灵活。无论是在开发阶段、测试阶段还是生产部署中，Flyway 都能为项目的数据库管理提供强有力的支持。

原文地址：https://blog.csdn.net/Flying_Fish_roe/article/details/142435263

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：Redisson分布式锁
下一篇：搭建微服务注册中心（命令行简易版，不使用IDE）

macOS开发环境配置与应用
在本文中，我们详细介绍了如何在macOS上配置一个强大的开发环境，并通过实际案例展示了如何创建和运行一个简单的Node.js Web应用。通过安装和使用各类工具，您能够实现高效的开发流程。
阅读更多2024-09-27
mac 上配置Jmeter代理进行web脚本录制过程&容易踩坑的点
jmeter启动代理服务器录制脚本、jmeter证书问题
阅读更多2024-09-27
电脑usb接口封禁如何实现？5种禁用USB接口的方法分享！(第一种你GET了吗？）
通过BIOS设置、设备管理器、注册表编辑器、专业的USB端口管理软件以及物理移除USB接口等方法，企业可以根据自身需求和实际情况，选择适合的方法来禁用USB接口。因此，对USB接口进行封闭管理，可以有
阅读更多2024-09-27
Hadoop FileSystem Shell 常用操作命令
HDFS 常用命令
阅读更多2024-09-27
java 解析excel （网络资源）
以下是一个简单的Java程序，用于读取Excel文件中的数据（参数类型为文件路径网络资源如：http://192.168.xx.xx:8080/upload/gjcTemporarySt
阅读更多2024-09-27
Fabric V2.5 通用溯源系统——使用Hyperledger Caliper压力测试
Caliper是一款测试区块链性能的工具，支持Hyperledger Fabric、Ethereum等，支持丰富的测试配置参数，测试完成后将直接输出报告，相较于tape更加专业，但是配置稍微有些复杂。
阅读更多2024-09-27
tauri中加载本地文件图片或者下载网络文件图片后存储到本地，然后通过前端页面展示
有一个需求是需要将本地上传的文件或者网络下载的文件存储到本地，并展示在前端页面上的。要想实现上述需求，需要三个步骤，配置相应的文件和文件夹访问权限，然后将文件存储到软件的相应目录中，再从目录中加载这个
阅读更多2024-09-27
CVE-2024-44902 Thinkphp反序列化漏洞
Thinkphp v6.1.3至v8.0.4版本中存在反序列化漏洞，攻击者可利用此漏洞执行任意代码。
阅读更多2024-09-27
SpringBoot 项目打成 jar 后加载外部的配置文件
其实配置项的动态刷新是通过不断的轮询Consul的HTTP API，检测相关的配置目录是否发生了变化来实现的，轮询的间隔时间可以通过spring.cloud.consul.config.watch.d
阅读更多2024-09-27
【Linux】部署 flask
这样的命令在ssh终端退出后，python进程也会被杀掉需要创建一个自定义的系统服务，来保证python程序能够在后台运行。1.创建系统服务内容如下：[Unit][Service][Install]E
阅读更多2024-09-27

Flyway 与 Spring Boot 集成

Flyway 与 Spring Boot 集成

1. Flyway 与 Spring Boot 的关系

2. Maven 依赖配置

3. 基本配置

3.1 数据库连接配置

3.2 迁移文件的命名规则

4. Flyway 的使用场景

4.1 数据库初始化

4.2 数据库版本升级

4.3 数据修复与迁移

5. 高级配置与使用

5.1 基准点（Baseline）

5.2 校验（Validate）

5.3 回滚（Undo）

5.4 忽略迁移失败

6. 自定义 Flyway 配置

7. Flyway 与 CI/CD 集成

结论

相关文章