SpringBoot項目集成Flyway詳細過程

Posted on by

一、Flyway

Flyway是獨立於數據庫的應用、管理並跟蹤數據庫變更的數據庫版本管理工具。用通俗的話講，Flyway可以像Git管理不同人的代碼那樣，管理不同人的sql腳本，從而做到數據庫同步。

二、流程

1、 首先配置好flyway的基本信息後，運行項目，會在數據庫表中默認新建一個數據表用於存儲flyway的運行信息，默認的數據庫名：flyway_schema_history

2、 緊接著Flyway將開始掃描文件系統或應用程序的類路徑進行遷移。然後，Flyway的數據遷移將基於對用sql腳本的版本號進行排序，並按順序應用：

可以看到執行數據庫表後在checksum中儲存一個數值，用於在之後運行過程中對比sql文件執行是否有變化。

註意：

flyway在執行腳本時，會在源數據表中檢查checksum值，並確定上次運行到哪一個腳本文件，本次執行時從下一條腳本文件開始執行。所以編寫腳本的時候不要去修改原有的腳本內容，並且新的腳本版本號要連續

2.1 導入依賴

<!-- flyway依賴開始 -->
<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-core</artifactId>
</dependency>
<!-- postgresql驅動包 -->
<dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <scope>runtime</scope>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
 <!-- flyway依賴結束 -->
<build>
    <plugins>
        <plugin>
            <groupId>org.flywaydb</groupId>
            <artifactId>flyway-maven-plugin</artifactId>
            <version>5.2.1</version>
        </plugin>
    </plugins>
 </build>

2.2 配置yml

spring:
  #druid數據源
  datasource:
    druid:
      db-type: com.alibaba.druid.pool.DruidDataSource
      driverClassName: net.sf.log4jdbc.sql.jdbcapi.DriverSpy
      url: jdbc:log4jdbc:mysql://127.0.0.1/plumvill_test?serverTimezone=Asia/Shanghai&characterEncoding=utf8&useSSL=false&allowPublicKeyRetrieval=true
      username: root
      password: 123456
  flyway:
    # 遷移腳本的位置，默認db/migration，可配置
    locations: classpath:/db
    # 已經存在表結構數據的已有數據庫使用flyway需要設置為true,且版本號要比1大
    #baseline-on-migrate: true

2.3 創建sql腳本

/db/V1__init_database.sql

sql腳本的格式：V+版本號 +雙下劃線+描述.sql

說明：V大寫，中間是兩個下劃線（__）

USE plumvill_test;

SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for sys_user
-- ----------------------------
DROP TABLE IF EXISTS `sys_user`;
CREATE TABLE `sys_user`  (
  `id` bigint(0) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT 'ID',
  `username` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL DEFAULT '' COMMENT '用戶名',
  `nick_name` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL DEFAULT '' COMMENT '昵稱',
  `gender` bit(1) NOT NULL DEFAULT b'0' COMMENT '性別（0為男默認，1為女）',
) ENGINE = InnoDB AUTO_INCREMENT = 3 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci COMMENT = '系統用戶' ROW_FORMAT = Compact;

-- ----------------------------
-- Records of sys_user
-- ----------------------------
INSERT INTO `sys_user` VALUES (1, 'admin', '管理員', b'0');
INSERT INTO `sys_user` VALUES (2, 'test', '測試', b'1',);

2.4 啟動項目

可以看到sql腳本開始執行

執行成功後可以發現數據庫中多出一張flyway_schema_history 的表來記錄每次腳本的執行

image-20210425161021257

以後隻要數據庫有更新，隻需要在db文件夾下創建更高版本的sql腳本（V1.x__xxx.sql，V2__xxx.sql），重啟項目的時候就會自動執

行。

2.5 常見問題

1、可以基於環境變量，實現不同的環境，做不同的初始化腳本嗎？
基於我們的配置中 心，可以對flyway.locations配置進行修改，不同環境的初始化腳本可以放到不同的目錄下。

2、初始化數據過程會發生錯誤回滾？
每 一個sql 文件會有 一個單獨的事物，如果單個文件中發 生錯誤，單個文件的操作會回滾， 比如有1、2、3個 文件，第 二個文件發生錯誤，第二個文件所有操作將會回滾，第三個文件不會執行。但： Unfortunately, today only DB2, PostgreSQL, Derby, EnterpriseDB and to a certain extent SQL Server support DDL statements inside a transaction。 所以，建議不要把ddl 文件和dml語句句放到同 一個文件 裡，避免不必要的麻煩

到此這篇關於SpringBoot項目集成Flyway詳細過程的文章就介紹到這瞭,更多相關SpringBoot集成Flyway內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：