SpringBoot集成Flyway進(jìn)行數(shù)據(jù)庫(kù)版本遷移管理的步驟

更新時(shí)間：2021年03月04日 09:15:30 作者：識(shí)1DD編程

這篇文章主要介紹了SpringBoot集成Flyway進(jìn)行數(shù)據(jù)庫(kù)版本遷移管理的步驟，幫助大家更好的理解和學(xué)習(xí)使用SpringBoot框架，感興趣的朋友可以了解下

0.添加所需依賴
1.application.yml配置數(shù)據(jù)庫(kù)連接與sql腳本所在目錄(不配則默認(rèn)為classpath:db/migration)
2.添加初始化sql文件 V1.0__Base_DDL.sql 到配置目錄下(前綴須以大寫V為前綴，可通過(guò)sql-migration-prefix配置更改)
3.添加版本文件
4.啟動(dòng)SpringBoot應(yīng)用，以下為數(shù)據(jù)庫(kù)為空SpringBoot應(yīng)用運(yùn)行時(shí)的執(zhí)行輸出

參考

Flyway簡(jiǎn)介

Flyway中的遷移(migrations)模式

Flyway對(duì)數(shù)據(jù)庫(kù)的所有更改都稱為 migrations(遷移) 。 migrations(遷移) 分為版本控制(Versioned)遷移與可重復(fù)(Repeatable)的遷移兩種，
而版本控制又分為regular(常規(guī))和undo(撤銷)兩種形式。

版本控制遷移：具有版本號(hào)、描述和校驗(yàn)和，且版本是唯一的。描述用于簡(jiǎn)單記錄遷移的內(nèi)容，校驗(yàn)和用于檢測(cè)意外更改。
版本控制遷移通常用于以下用途：
創(chuàng)建|更新|刪除：表、索引、外鍵、枚舉、UDT…
數(shù)據(jù)更新

常規(guī)版本控制例子：

CREATE TABLE car (
 id INT NOT NULL PRIMARY KEY,
 license_plate VARCHAR NOT NULL,
 color VARCHAR NOT NULL
);
ALTER TABLE owner ADD driver_license_id VARCHAR;
INSERT INTO brand (name) VALUES ('DeLorean');

撤消(undo)遷移與常規(guī)版本遷移相反，但形式上看也是版本遷移的一種，具有相同版本的版本遷移影響。針對(duì)上例中的撤銷遷移例子如下：

DELETE FROM brand WHERE name='DeLorean';
ALTER TABLE owner DROP driver_license_id;
DROP TABLE car;

可重復(fù)遷移：只有描述、校驗(yàn)和(checksum)，沒(méi)有版本號(hào)。可重復(fù)遷移不止執(zhí)行一次，每次校驗(yàn)和(checksum)發(fā)生變更時(shí)就會(huì)被執(zhí)行。
可重復(fù)遷移主要有以下兩種用途：

（重新）創(chuàng)建視圖/存儲(chǔ)過(guò)程/函數(shù)/包/…
批量插入?yún)⒄諗?shù)據(jù)

在一次遷移運(yùn)行中，在所有版本遷移執(zhí)行之后，可重復(fù)遷移在最后執(zhí)行?？芍貜?fù)遷移按照它們描述的順序執(zhí)行。

Flyway遷移的命名模式如下：

前綴：V指版本控制， U用于撤消和 R用于可重復(fù)遷移（可配置）
版本：帶點(diǎn)或下劃線的版本可根據(jù)需要分隔任意多個(gè)部分（不適用于可重復(fù)的遷移）
分隔符：兩個(gè)下劃線__（可配置）
描述：下劃線或空格分隔單詞

Flaway的版本命名十分靈活，以下版本都是有效的迭代版本：

1
001
5.2
1.2.3.4.5.6.7.8.9
205.68
20130115113556
2013.1.15.11.35.56
2013.01.15.11.35.56

Flyway歷史記錄表flyway_history_schema

Flyway通過(guò)創(chuàng)建表flyway_history_schema來(lái)記錄遷移，表中的主要字段如下：

Spring Boot集成示例

0.添加所需依賴

<dependencies>
 <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
 </dependency>
 <!-- spring-boot-dependencies已包含了flyway的版本設(shè)置 -->
 <dependency>
  <groupId>org.flywaydb</groupId>
  <artifactId>flyway-core</artifactId>
 </dependency>
 <dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
 </dependency>

1.application.yml配置數(shù)據(jù)庫(kù)連接與sql腳本所在目錄(不配則默認(rèn)為classpath:db/migration)

spring:
 datasource:
 url: jdbc:mysql://localhost:3306/spring_boot_series?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true&serverTimezone=GMT
 username: root
 password: tiger
 driver-class-name: com.mysql.cj.jdbc.Driver
 # 自動(dòng)讀取spring.datasource配置進(jìn)行遷移操作
 flyway:
 locations: classpath:db

2.添加初始化sql文件 V1.0__Base_DDL.sql 到配置目錄下(前綴須以大寫V為前綴，可通過(guò)sql-migration-prefix配置更改)

CREATE SCHEMA IF NOT EXISTS `spring_boot_series` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
USE `spring_boot_series`;

-- -----------------------------------------------------
-- Table `spring_boot_series`.`user_base`
-- -----------------------------------------------------

CREATE TABLE IF NOT EXISTS `spring_boot_series`.`user_base`
(
 `id`   BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
 `nickname` VARCHAR(45)  NOT NULL DEFAULT '' COMMENT '昵稱',
 `status`  VARCHAR(45)  NOT NULL,
 `sex`   TINYINT   NULL COMMENT '性別(MALE:1-男性,FEMALE:0-女性)',
 `mobile`  VARCHAR(13)  NOT NULL DEFAULT '' COMMENT '手機(jī)號(hào)碼',
 `email`  VARCHAR(100) NOT NULL DEFAULT '' COMMENT '郵箱',
 `birthday` BIGINT   NOT NULL DEFAULT 0 COMMENT '生日',
 `create_time` DATETIME  NOT NULL DEFAULT CURRENT_TIMESTAMP,
 `update_time` DATETIME  NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
 PRIMARY KEY (`id`)
)
 ENGINE = InnoDB;


CREATE TABLE IF NOT EXISTS `spring_boot_series`.`user_auth`
(
 `id`   BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
 `uid`   BIGINT   NOT NULL,
 `identity_type` TINYINT   NOT NULL,
 `identifier` VARCHAR(50)  NOT NULL DEFAULT '',
 `certificate` VARCHAR(30)  NOT NULL DEFAULT '',
 `create_time` TIMESTAMP  NOT NULL DEFAULT CURRENT_TIMESTAMP,
 `update_time` TIMESTAMP  NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
 PRIMARY KEY (`id`),
 INDEX `idx_uid_certificate` (`uid` ASC, `certificate` ASC),
 INDEX `idx_type_identity` (`identity_type` ASC, `identifier` ASC)
)
 ENGINE = InnoDB
 COMMENT = '用戶授權(quán)表';

3.添加版本文件

V1.0.1__Modify_user_birthday.sql:

alter table user_base modify birthday datetime null comment '生日';

V1.0.2__Modify_user_birthday.sql:

alter table user_base modify birthday timestamp null comment '生日';
alter table user_base add login_time timestamp null;

4.啟動(dòng)SpringBoot應(yīng)用，以下為數(shù)據(jù)庫(kù)為空SpringBoot應(yīng)用運(yùn)行時(shí)的執(zhí)行輸出

由于配置連接的數(shù)據(jù)庫(kù)里沒(méi)有任何表，所以SpringBoot應(yīng)用運(yùn)行時(shí)flyway會(huì)根據(jù)腳本進(jìn)行數(shù)據(jù)庫(kù)的初始化，執(zhí)行的順序會(huì)根據(jù)腳本版本號(hào)由低到高按順序執(zhí)行(1.0 -> 1.0.1 -> 1.0.2)，每執(zhí)行完一個(gè)版本腳本都會(huì)向記錄表flyway_history_schema插入一條數(shù)據(jù)。
若添加了新的版本腳本，應(yīng)用啟動(dòng)時(shí)flyway會(huì)根據(jù)腳本文件版本到記錄表flyway_history_schema查詢是否有對(duì)應(yīng)的版本腳本被執(zhí)行了，如果沒(méi)有相應(yīng)的版本腳本記錄才會(huì)執(zhí)行腳本。