Java使用Flyway实现数据库版本控制的技术指南_Java

1、简述

在现代应用开发中，数据库结构经常随着业务需求不断演变。使用手动 sql 脚本管理数据库版本，不仅容易出现错误，还难以跟踪和回滚。flyway 是一个强大的数据库迁移工具，能够帮助开发者高效管理和自动化数据库的版本控制。本文将介绍 flyway 的基本功能及其在 spring boot 项目中的实践。

2、主要特性

flyway 是一个开源的数据库迁移工具，支持多种数据库（如 mysql、postgresql、oracle 等），可在应用启动时自动执行数据库迁移脚本。flyway 采用“迁移脚本版本管理”的方式，跟踪每个版本的 sql 变更，确保数据库结构与代码一致。flyway 的主要特性包括：

自动化迁移：在应用启动时自动执行未应用的脚本。
版本控制：记录每个脚本的版本号，确保不会重复执行。
可回滚：支持定义回滚脚本，简化问题排查。
支持 sql 和 java 脚本：可使用 sql 文件或 java 编写的自定义迁移逻辑。

3、项目集成

在 spring boot 中使用 flyway 非常简单，spring boot 内置对 flyway 的支持。我们只需要添加依赖并配置相应的数据库连接信息。

3.1 添加 flyway 依赖

在 pom.xml 中添加 flyway 依赖：

<dependency>
    <groupid>org.flywaydb</groupid>
    <artifactid>flyway-core</artifactid>
</dependency>

3.2 约束条件

flyway 使用以下命名约定和约束来管理迁移：

迁移文件命名格式：v{版本号}__描述.sql，例如 v1__initial_setup.sql。v 代表版本，双下划线后跟简要描述。
迁移版本：每个脚本都有唯一的版本号，确保按顺序执行。
回滚文件（可选）：文件名 r{版本号}__描述.sql，用于回滚该版本。

3.3 配置数据库连接

在 application.yml 中配置数据库连接信息：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydatabase
    username: root
    password: password
  # flyway 配置
  flyway:
    # 开启 flyway
    enabled: true
    # 是否禁用数据库清理
    clean-disabled: true
    # sql 迁移的编码
    encoding: utf-8
    # 迁移脚本的位置，默认 db/migration.
    locations: classpath:db/migration
    # sql 迁移的文件名前缀。
    sql-migration-prefix: v
    # sql 迁移的文件名分隔符。
    sql-migration-separator: __
    # sql 迁移的文件名后缀。
    sql-migration-suffixes: .sql
    # 是否在执行迁移时自动调用验证。
    validate-on-migrate: true
    # 迁移时发现目标 schema 非空，而且带有没有元数据的表时，是否自动执行基准迁移，默认 false.
    baseline-on-migrate: true
    # 是否允许乱序的迁移
    out-of-order: true 
    # 忽略缺失的迁移脚本           
    ignore-missing-migrations: true  
    # jdbc 驱动程序的完全限定名称。 默认根据 url 自动检测。
    driver-class-name:
    # 要迁移的数据库的 dbc url。 如果未设置，则使用主要配置的数据源。
    url: jdbc:mysql://localhost:3306/zq?useunicode=true&characterencoding=utf8&servertimezone=gmt
    # 要迁移的数据库的登录密码。
    password: root
    # 要迁移的数据库的登录用户。
    user: root

baseline-on-migrate：对于已有数据的数据库，使用该配置可以从指定版本开始迁移。
out-of-order：允许迁移不按顺序执行。
ignore-missing-migrations：如果有缺失的迁移脚本不会报错，可用于已删除的旧迁移脚本。

3.4 编写迁移脚本

在项目中创建一个 db/migration 文件夹，然后添加 sql 文件。例如，我们创建以下三个 sql 文件：

v1__initial_setup.sql：用于初始建表
v2__add_new_column.sql：添加新列
v3__insert_initial_data.sql：插入初始数据

v1__initial_setup.sql：

-- v1__initial_setup.sql: 创建表 `users`
create table users (
    id int primary key auto_increment,
    username varchar(50) not null,
    email varchar(100),
    created_at timestamp default current_timestamp
);

v2__add_new_column.sql：

-- v2__add_new_column.sql: 为 `users` 表添加 `status` 列
alter table users
add column status varchar(20) default 'active';

v3__insert_initial_data.sql：

-- v3__insert_initial_data.sql: 向 `users` 表插入初始数据
insert into users (username, email, status) values ('alice', 'alice@example.com', 'active');
insert into users (username, email, status) values ('bob', 'bob@example.com', 'inactive');

在应用启动时，flyway 会自动扫描 db/migration 文件夹中的脚本并依次执行。每次执行的迁移都会记录在数据库中的 flyway_schema_history 表中，表中包含已应用的所有迁移的版本和执行状态。

create table `flyway_schema_history` (
  `installed_rank` int(11) not null,
  `version` varchar(50) default null,
  `description` varchar(200) not null,
  `type` varchar(20) not null,
  `script` varchar(1000) not null,
  `checksum` int(11) default null,
  `installed_by` varchar(100) not null,
  `installed_on` timestamp not null default current_timestamp,
  `execution_time` int(11) not null,
  `success` tinyint(1) not null,
  primary key (`installed_rank`),
  key `flyway_schema_history_s_idx` (`success`)
) engine=innodb default charset=utf8;

可以通过查看日志或数据库中的 flyway_schema_history 表来验证迁移是否成功

3.5 编写回滚脚本（可选）

如果需要为每个迁移版本定义回滚操作，可以在同一目录中创建 r{版本号}__描述.sql 文件。例如：

r2__drop_new_column.sql：

-- r2__drop_new_column.sql: 删除 `users` 表中的 `status` 列
alter table users
drop column status;

注意： spring boot 默认不自动执行回滚操作，回滚脚本需要手动执行或借助 flyway 命令行。

4、flyway 命令操作

除了在应用启动时自动执行迁移，还可以通过 flyway 的命令行工具或 java api 手动执行常用操作，如 migrate、validate、repair 等。

migrate：执行未应用的迁移脚本。
validate：验证数据库当前状态是否符合迁移脚本的定义。
repair：修复历史迁移记录。

假设已经安装了 flyway cli，可以在命令行中执行以下命令：

# 迁移
flyway -url=jdbc:mysql://localhost:3306/mydatabase -user=root -password=password migrate

# 验证
flyway -url=jdbc:mysql://localhost:3306/mydatabase -user=root -password=password validate

# 修复
flyway -url=jdbc:mysql://localhost:3306/mydatabase -user=root -password=password repair

5、总结

flyway 为数据库版本管理提供了可靠、可维护的方案，在数据库结构不断变化的项目中尤为重要。通过本文的实践，我们可以使用 flyway 实现数据库的自动化迁移、版本控制和快速回滚，大幅提升开发效率和系统的可维护性。

常见问题与注意事项：

版本冲突：如果多个开发者同时对数据库进行迁移，可能会产生版本冲突。建议定期同步代码库或采用全局版本号管理。
回滚问题：flyway 默认不支持自动回滚，因此需要手动定义回滚脚本，适用于有严格版本控制需求的系统。
迁移文件的存储：建议将迁移文件纳入版本控制系统（如 git），以便所有开发者可以访问和修改迁移记录。

以上就是java使用flyway实现数据库版本控制的技术指南的详细内容，更多关于java flyway数据库版本控制的资料请关注代码网其它相关文章！

Java使用Flyway实现数据库版本控制的技术指南

2025年02月25日 • Java •我要评论