快捷導(dǎo)航

SpringBoot中使用Flyway進(jìn)行數(shù)據(jù)庫(kù)遷移的詳細(xì)流程

更新時(shí)間：2025年02月17日 10:08:36 作者：一口酥Hac

本文介紹了如何在Spring Boot項(xiàng)目中使用Flyway進(jìn)行數(shù)據(jù)庫(kù)遷移,Flyway通過(guò)SQL腳本管理數(shù)據(jù)庫(kù)變更,支持自動(dòng)執(zhí)行和版本控制,避免了手動(dòng)執(zhí)行SQL腳本的錯(cuò)誤和維護(hù)困難,需要的朋友可以參考下

概要

在 Spring Boot 項(xiàng)目開(kāi)發(fā)中，數(shù)據(jù)庫(kù)的變更不可避免。手動(dòng)執(zhí)行 SQL 腳本不僅容易出錯(cuò)，也難以維護(hù)數(shù)據(jù)庫(kù)版本的一致性。Flyway 作為一款輕量級(jí)的數(shù)據(jù)庫(kù)遷移工具，能夠幫助我們優(yōu)雅地解決這些問(wèn)題。

Spring Boot 集成 Flyway

1、添加 Flyway 依賴

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

2、配置 Flyway

spring:
  flyway:
    enabled: true
    locations: classpath:db/migration
    baseline-on-migrate: true
    placeholder-replacement: false
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/my_info?useUnicode=true&characterEncoding=utf8&autoReconnect=true&allowMultiQueries=true&useSSL=false
    username: root
    password: iuowiebd

3、創(chuàng)建數(shù)據(jù)庫(kù)遷移腳本

Flyway 使用 SQL 腳本來(lái)定義數(shù)據(jù)庫(kù)的變更。腳本需要放在 src/main/resources/db/migration 目錄下（默認(rèn)路徑），并且遵循特定的命名規(guī)則：V<版本號(hào)>__<描述>.sql

例如：V1__create_user_table.sql

CREATE TABLE user
(
    id    INT PRIMARY KEY AUTO_INCREMENT,
    name  VARCHAR(255) NOT NULL,
    email VARCHAR(255) NOT NULL
);

insert into user (name, email)
values ('user1', 'user1@qq.com');

4、啟動(dòng)應(yīng)用
啟動(dòng) Spring Boot 應(yīng)用，F(xiàn)lyway 會(huì)自動(dòng)執(zhí)行 db/migration 目錄下的遷移腳本，并將執(zhí)行記錄存儲(chǔ)在 flyway_schema_history 表中。

控制臺(tái)關(guān)于 flyway 的日志信息：

在這里插入圖片描述

成功創(chuàng)建表：

在這里插入圖片描述

Flyway 其他用法

1、禁用 Flyway 自動(dòng)遷移

在某些場(chǎng)景下，可能需要手動(dòng)控制 Flyway 的遷移，可以禁用自動(dòng)遷移：

spring:
  flyway:
    enabled: false

bug錯(cuò)誤

Flyway版本不兼容

如果使用的 Flyway 版本與 Spring Boot 版本不兼容，可能會(huì)導(dǎo)致 Flyway 無(wú)法正常工作。

控制臺(tái)不打印任何關(guān)于 flyway 的日志。

數(shù)據(jù)庫(kù)存在表了

數(shù)據(jù)庫(kù)存在表了，就不會(huì)執(zhí)行 sql 了。

Flyway 只會(huì)執(zhí)行比當(dāng)前數(shù)據(jù)庫(kù)版本號(hào)更高的遷移腳本。如果數(shù)據(jù)庫(kù)的當(dāng)前版本是 1，而你的遷移腳本的版本號(hào)也是 1 或者更低，F(xiàn)lyway 會(huì)認(rèn)為這些腳本已經(jīng)執(zhí)行過(guò)，因此不會(huì)再次執(zhí)行。

所以只需把 sql 腳本的版本改一下，V2__create_user_table.sql（升高版本）