環(huán)境：SpringBoot2.7.18 + Flyway8.5.13

1. 簡(jiǎn)介

Flyway是一個(gè)開(kāi)源的數(shù)據(jù)庫(kù)遷移工具，它通過(guò)定義一系列有序的SQL腳本（稱(chēng)為遷移），幫助你管理數(shù)據(jù)庫(kù)的結(jié)構(gòu)變更。這些遷移腳本可以用于創(chuàng)建表、修改列、添加索引等任何數(shù)據(jù)庫(kù)更改操作。Flyway的主要特性和優(yōu)勢(shì)包括：

• 版本控制：Flyway為數(shù)據(jù)庫(kù)的每個(gè)變更分配一個(gè)版本號(hào)，只有新的變更才會(huì)被應(yīng)用，已經(jīng)應(yīng)用過(guò)的變更不會(huì)重復(fù)執(zhí)行。這使得數(shù)據(jù)庫(kù)變更更加可控和可追蹤。
• 跨平臺(tái)：Flyway支持主流的關(guān)系型數(shù)據(jù)庫(kù)，包括MySQL、PostgreSQL、Oracle、SQL Server等。
• 易用性：Flyway提供了簡(jiǎn)單的命令行界面和API，使得開(kāi)發(fā)人員可以輕松地集成到他們的項(xiàng)目中。同時(shí)，它還支持與Spring Boot等主流開(kāi)發(fā)框架進(jìn)行集成。
• 自動(dòng)化：Flyway可以自動(dòng)化執(zhí)行數(shù)據(jù)庫(kù)遷移，這使得敏捷開(kāi)發(fā)團(tuán)隊(duì)可以更快地開(kāi)發(fā)新功能，同時(shí)也可以更容易地進(jìn)行測(cè)試和部署。

在實(shí)際項(xiàng)目開(kāi)發(fā)中通過(guò)Flyway可以確保每個(gè)數(shù)據(jù)庫(kù)變更都有一個(gè)唯一的版本號(hào)，并按照版本號(hào)順序執(zhí)行，從而避免了重復(fù)或錯(cuò)亂的變更。這使得開(kāi)發(fā)人員能夠清晰地跟蹤和管理數(shù)據(jù)庫(kù)的歷史變更，并確保不同環(huán)境（如開(kāi)發(fā)、測(cè)試和生產(chǎn)）之間的數(shù)據(jù)庫(kù)結(jié)構(gòu)一致性。

2. 實(shí)戰(zhàn)案例

注意：我當(dāng)前使用的版本Flyway對(duì)應(yīng)的數(shù)據(jù)庫(kù)mysql版本必須是8。

2.1 引入依賴(lài)

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

2.2 配置數(shù)據(jù)庫(kù)

spring:
  datasource:
    driverClassName: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/pack?serverTimezone=GMT%2B8&useSSL=false&characterEncoding=UTF-8
    username: root
    password: xxxooo
    type: com.zaxxer.hikari.HikariDataSource

2.3 Flyway配置

spring:
  flyway:
    enabled: true
    # 用于存儲(chǔ)遷移歷史記錄的表名, 默認(rèn): flyway_schema_history
    table: flyway_schema_history
    # 遷移腳本編碼, 默認(rèn): UTF-8
    encoding: UTF-8
    # 當(dāng)遷移數(shù)據(jù)庫(kù)存在但沒(méi)有元數(shù)據(jù)的表時(shí)，自動(dòng)執(zhí)行基準(zhǔn)遷移，新建flyway_schema_history表
    baseline-on-migrate: true
    # 數(shù)據(jù)庫(kù)遷移腳本的位置, 默認(rèn): classpath:db/migration
    # 這里也支持文件系統(tǒng)路徑，前綴：filesystem:
    locations:
    - classpath:db/migration

上面的配置都使用的默認(rèn)值，如果你沒(méi)有自定義需求，你完全可以不進(jìn)行配置。

最終項(xiàng)目目錄結(jié)構(gòu)如下：

圖片

初始數(shù)據(jù)庫(kù)中有如下表：

圖片

2.4 準(zhǔn)備數(shù)據(jù)庫(kù)升級(jí)腳本

接下來(lái)在db/migration下新建一個(gè)遷移腳本（升級(jí)），文件名：V1.0_001__create_table.sql

create table t_person (
  id int auto_increment primary key,
  name varchar(32) not null,
  sex varchar(2) not null,
  age int default 0
);

創(chuàng)建表t_person。

特別說(shuō)明：通常情況下，遷移腳本的格式為 V<VERSION>__<NAME>.sql（其中 <VERSION> 為下劃線分隔的版本，如 "1 "或 "2_1"；<NAME>一般你可以寫(xiě)上該腳本的描述信息）。還有一點(diǎn)要注意：<VERSION>與<NAME>中間是兩個(gè)下劃線：'__'，最終目錄如下：

圖片

到此所有的配置都完成，接下來(lái)只需要啟動(dòng)服務(wù)即可。

2.5 啟動(dòng)應(yīng)用服務(wù)

控制臺(tái)輸出

圖片

通過(guò)控制臺(tái)輸出，得到下面兩個(gè)重要信息：

1. 創(chuàng)建表flyway_schema_history
2. 成功升級(jí)一個(gè)腳本版本是v1.0.001

查看數(shù)據(jù)庫(kù)情況

執(zhí)行了升級(jí)腳本，創(chuàng)建了數(shù)據(jù)庫(kù)。查看flyway_schema_history表數(shù)據(jù)：

記錄了升級(jí)腳本文件及版本信息。當(dāng)多次啟動(dòng)服務(wù)并不會(huì)重復(fù)的執(zhí)行。如果你將這里的記錄刪除再吧t_person表刪除，那么下次重啟服務(wù)還會(huì)執(zhí)行升級(jí)腳本。

經(jīng)過(guò)xxx時(shí)間后系統(tǒng)升級(jí)數(shù)據(jù)庫(kù)腳本也升級(jí)了，我們可以繼續(xù)添加升級(jí)腳本文件，如下：

圖片

新增了一個(gè)腳本文件V1.1_001__update-t_person.sql，文件內(nèi)容：

alter table t_person add column email varchar(32) default '';

啟動(dòng)服務(wù)，控制臺(tái)輸出：

圖片

升級(jí)記錄表中新增了一條記錄

圖片

到此一個(gè)簡(jiǎn)單的Flyway應(yīng)用就完成了，接下來(lái)我們繼續(xù)Flyway在SpringBoot中更多用法。

3. Flyway其它用法

3.1 指定數(shù)據(jù)庫(kù)類(lèi)型

我們可以通過(guò)如下配置來(lái)設(shè)置具體數(shù)據(jù)庫(kù)類(lèi)型的腳本路徑

spring:
  flyway:
    locations:
    - classpath:db/migration/{vendor}

通過(guò){vendor}占位符，該占位符會(huì)更加你當(dāng)前環(huán)境的數(shù)據(jù)庫(kù)類(lèi)型自動(dòng)替換，我們只需要在對(duì)應(yīng)的路徑下建立文件夾及升級(jí)文件即可，如下：

圖片

3.2 使用其它數(shù)據(jù)庫(kù)

在默認(rèn)情況下，F(xiàn)lyway使用的是你當(dāng)前環(huán)境中主數(shù)據(jù)源（存在多個(gè)的時(shí)候，應(yīng)用@Primary標(biāo)記的數(shù)據(jù)源），我們可以通過(guò)如下兩種方式使用其它數(shù)據(jù)源（多數(shù)據(jù)源情況下）：

• 自定義FlywayDataSource

@Bean
@FlywayDataSource
DataSource flywayDataSource() {
  HikariDataSource dataSource = new HikariDataSource();
  dataSource.setJdbcUrl("jdbc:mysql://localhost:3306/msg?serverTimeznotallow=GMT%2B8&nullCatalogMeansCurrent=true&useSSL=false&characterEncoding=UTF-8");
  dataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
  dataSource.setUsername("root");
  dataSource.setPoolName("flyway") ;
  dataSource.setPassword("xxxooo");
  return dataSource ;
}

通過(guò)使用@FlywayDataSource注解。

• 定義flyway數(shù)據(jù)源信息

spring:
  flyway:
    user: root
    password: xxxooo
    url: jdbc:mysql://localhost:3306/msg?serverTimeznotallow=GMT%2B8&nullCatalogMeansCurrent=true&useSSL=false

通過(guò)spring.flyway.*指定flyway自己的數(shù)據(jù)源。