Spring Boot项目使用Flyway的详细教程

当我们开发Spring Boot项目时，我们通常需要在数据库中创建各种数据表、视图等数据结构。随着项目的迭代，这些数据结构往往需要不断地进行更新、迁移、升级等操作。为了方便地管理这些数据库变更，我们可以使用Flyway工具来进行数据库迁移管理。下面是一份详细的Spring Boot项目使用Flyway的教程。

安装和配置Flyway

1. 在Spring Boot项目的pom.xml文件中添加Flyway的依赖项：

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

1. 在Spring Boot的application.yml或application.properties文件中添加Flyway的配置项：

yaml
spring:
datasource:
url: jdbc:mysql://localhost:3306/mydb?serverTimezone=UTC
username: root
password: password
flyway:
enabled: true
locations: classpath:/db/migration

其中，locations表示Flyway迁移脚本所在的路径。

创建Flyway迁移脚本

1. 在项目的src/main/resources目录下创建一个db/migration目录，用于存放Flyway的迁移脚本。

2. 创建一个以V开头的迁移脚本，例如V1__create_users_table.sql，用于创建一个users表。

sql
CREATE TABLE users (
id INT PRIMARY KEY AUTO_INCREMENT,
name VARCHAR(50) NOT NULL,
email VARCHAR(50) DEFAULT NULL
);

1. 创建另一个以V开头的迁移脚本，例如V2__add_age_column_to_users_table.sql，用于将users表添加一个age列。

sql
ALTER TABLE users ADD COLUMN age INT DEFAULT NULL;

运行Flyway迁移脚本

1. 在Spring Boot项目的启动类上添加@FlywayApplication注解，启用Flyway。

java
@SpringBootApplication
@FlywayApplication
public class MyApp {
public static void main(String[] args) {
SpringApplication.run(MyApp.class, args);
}
}

1. 运行Spring Boot项目，Flyway会自动检测并执行db/migration目录下的V1__create_users_table.sql和V2__add_age_column_to_users_table.sql脚本，创建users表并添加age列。

示例说明

下面给出两个关于使用Flyway的示例说明。

示例一：添加一个新的迁移脚本

我们现在需要为users表添加一个新的email_verified字段，类型为BOOLEAN。为了实现这个功能，我们需要添加一个新的迁移脚本到db/migration目录中。

1. 创建一个新的以V开头的迁移脚本，例如V3__add_email_verified_column_to_users_table.sql。

sql
ALTER TABLE users ADD COLUMN email_verified BOOLEAN DEFAULT FALSE;

1. 重新运行Spring Boot项目，Flyway会自动检测并执行V3__add_email_verified_column_to_users_table.sql脚本，为users表添加email_verified列。

示例二：回滚一个已经迁移的脚本

我们发现在上一个示例中添加的email_verified字段是有问题的，需要把它从users表中删除。为了回滚这个已经迁移的脚本，我们需要创建一个回滚脚本并执行它。

1. 创建一个以V开头的回滚脚本，例如V3.1__remove_email_verified_column_from_users_table.sql，注意版本号在原来的版本号基础上加上“.1”。

sql
ALTER TABLE users DROP COLUMN email_verified;

1. 重新运行Spring Boot项目，Flyway会自动检测并执行V3.1__remove_email_verified_column_from_users_table.sql脚本，删除users表中的email_verified列。

总的来说，使用Flyway可以帮助我们方便地管理Spring Boot项目中数据库的迁移，实现数据库结构的版本控制。