Java 中 Flyway 的使用详解

什么是 Flyway

Flyway 是一款开源的数据库版本控制工具，采用简单易用的方式为数据库提供更好的管理。Flyway 是用 Java 语言编写的并且支持多种主流数据库，如 MySQL、PostgreSQL、Oracle 等。

Flyway 的工作原理如下：

创建一个名为 flyway_schema_history 的表用于记录数据库的版本信息；
检查该表是否存在，如果不存在则会创建该表；
执行 SQL 脚本，并将执行过的 SQL 脚本信息保存到 flyway_schema_history 中。

Flyway 的安装和配置

Flyway 的使用需要先安装和配置，而安装和配置 Flyway 的过程主要分为以下几个步骤：

步骤一：添加 Maven 依赖

在 pom.xml 文件中添加以下依赖：

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

步骤二：配置数据库连接

在 application.properties 文件中配置以下属性：

# 数据库 URL
spring.datasource.url=jdbc:mysql://localhost:3306/demo?serverTimezone=UTC
# 数据库用户名
spring.datasource.username=root
# 数据库密码
spring.datasource.password=root
# 配置 Flyway 相关属性
# Flyway 执行 SQL 脚本的位置
spring.flyway.locations=classpath:db/migration/mysql
# 让 Flyway 在启动时自动执行数据库脚本
spring.flyway.enabled=true

步骤三：创建数据库脚本

在项目中创建一个名为 db/migration/mysql 的目录，用于存放数据库脚本。在该目录下创建一个名为 V1__init.sql 的文件，用于创建数据库表，如下：

CREATE TABLE user (
    id INT(11) PRIMARY KEY AUTO_INCREMENT,
    username VARCHAR(32) NOT NULL,
    password VARCHAR(32) NOT NULL,
    email VARCHAR(64) NOT NULL,
    phone VARCHAR(16) NOT NULL
);

该脚本将创建一个名为 user 的表，包含 id、username、password、email 和 phone 等字段。

步骤四：执行数据库脚本

在程序启动时，Flyway 将自动创建 flyway_schema_history 表，并执行位于 db/migration/mysql 目录下的 SQL 脚本。

Flyway 的使用示例

下面是两个 Flyway 的使用示例：

示例一：添加一个新字段

假设我们需要为 user 表添加一个名为 age 的字段，那么我们可以在 db/migration/mysql 目录下创建一个名为 V2__add_age.sql 的 SQL 脚本，如下：

ALTER TABLE user
ADD age INT(3) NOT NULL DEFAULT 0 AFTER phone;

该脚本将在 user 表中添加一个名为 age 的整型字段，并将其默认值设置为 0。

执行完该脚本后，Flyway 会在 flyway_schema_history 表中插入一条记录，表示该脚本已执行成功。

示例二：修改一个字段

假设我们需要将 user 表中的 email 字段更名为 user_email，那么我们可以在 db/migration/mysql 目录下创建一个名为 V3__rename_email.sql 的 SQL 脚本，如下：

ALTER TABLE user
CHANGE COLUMN email user_email VARCHAR(64) NOT NULL;

该脚本将 user 表中的 email 字段更名为 user_email，并将其类型设置为 VARCHAR(64)。