使用Spring Boot和Flyway进行数据库迁移

小蓝 • 2024-12-22 15:45 • 编程

一、为什么需要数据库迁移

一般情况下，随着软件的使用，数据库中的表、字段、索引等会不断地进行修改，但是如果直接修改生产环境数据库，会存在一定的风险，因此我们需要一种可靠的方式来管理这些变化，这就是数据库迁移。

数据库迁移是在数据库已经存在的情况下，在不影响数据库现有数据和结构完整性的情况下，根据需要升级或降级、增加或删除列、表、约束等，保持与代码同步，保证数据库的版本控制。

二、为什么要使用Spring Boot和Flyway

关于数据库迁移工具，目前市面上有很多不同的工具可供选择，那么Spring Boot和Flyway有何优势呢？

Spring Boot是一款基于Spring框架的快速开发微服务的脚手架，使用Spring Boot可以快速搭建一个完整的Web应用服务。
Flyway是一款数据库迁移工具，与Spring Boot天生集成，能够很好地与Spring Boot无缝集成，使用起来比较便捷。
Spring Boot和Flyway的共同点是都采用了约定大于配置的思想，让开发者能够更加专注于业务逻辑的编写。

三、如何使用Spring Boot和Flyway进行数据库迁移

1、添加依赖

首先，在pom.xml中添加Spring Boot和Flyway的依赖：

<dependencies>
    ...省略其他依赖...
    <dependency>
        <groupId>org.flywaydb</groupId>
        <artifactId>flyway-core</artifactId>
        <version>7.5.1</version>
    </dependency>
</dependencies>

2、配置数据库连接

接下来，配置数据库连接，可以在application.properties或application.yml中配置，这里以application.yml为例：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/demo?useSSL=false&serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

3、编写数据库迁移脚本

接下来，我们需要编写数据库迁移脚本，Flyway支持多种数据库脚本，包括SQL、Java脚本等。这里我们以编写SQL脚本为例：

V1__create_user_table.sql

CREATE TABLE IF NOT EXISTS `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键自增',
  `username` varchar(20) NOT NULL COMMENT '用户名',
  `password` varchar(32) NOT NULL COMMENT '密码',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COMMENT='用户表';

4、配置Flyway

接下来，我们需要配置Flyway，告诉它哪些目录下存放了数据库迁移脚本，以及使用的是哪个数据库：

@Configuration
public class FlywayConfig {
    @Bean
    public Flyway flyway(DataSource dataSource) {
        Flyway flyway = new Flyway();
        flyway.setDataSource(dataSource);
        flyway.setLocations("classpath:/db/migration");
        flyway.setBaselineOnMigrate(true);
        flyway.setEncoding("UTF-8");
        return flyway;
    }
}

5、运行并验证

完成以上准备工作后，我们可以执行Spring Boot应用程序，在启动时，Flyway将自动检查数据库状态并执行相应的迁移脚本。

在启动时，我们可以在控制台输出中看到如下信息：

Database: jdbc:mysql://localhost:3306/demo (MySQL 8.0)
Successfully validated 1 migration (execution time 00:00.023s)
Creating Schema History table `demo`.`flyway_schema_history`...
Current version of schema `demo`: <>
Migrating schema `demo` to version "1 - create user table"
Successfully applied 1 migration to schema `demo` (execution time 00:00.233s)

如果我们需要进行其他的数据库迁移操作，比如升级某个表，添加某个字段等，只需要在相应的目录下编写对应的数据库迁移脚本即可。（注意脚本文件命名规则，使用V开头表示版本号，多个脚本按版本号依次执行）。

四、小结

通过本文的介绍，我们了解了数据库迁移的概念以及Spring Boot与Flyway的优势与使用方式。在实际应用中，数据库迁移工具的使用可以帮助我们更方便地管理数据库结构和数据，避免不必要的风险。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/285605.html