App下載

學習springboot項目集成flyway的詳細過程

我的夏天來了 2021-08-19 15:18:07 瀏覽數(shù) (4726)
反饋

一、Flyway

Flyway是獨立于數(shù)據(jù)庫的應用、管理并跟蹤數(shù)據(jù)庫變更的數(shù)據(jù)庫版本管理工具。用通俗的話講,F(xiàn)lyway可以像Git管理不同人的代碼那樣,管理不同人的sql腳本,從而做到數(shù)據(jù)庫同步。

二、流程

1、 首先配置好flyway的基本信息后,運行項目,會在數(shù)據(jù)庫表中默認新建一個數(shù)據(jù)表用于存儲flyway的運行信息,默認的數(shù)據(jù)庫名:flyway_schema_history

2、 緊接著Flyway將開始掃描文件系統(tǒng)或應用程序的類路徑進行遷移。然后,F(xiàn)lyway的數(shù)據(jù)遷移將基于對用sql腳本的版本號進行排序,并按順序應用:

可以看到執(zhí)行數(shù)據(jù)庫表后在checksum中儲存一個數(shù)值,用于在之后運行過程中對比sql文件執(zhí)行是否有變化。

注意:

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

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數(shù)據(jù)源
  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
    # 已經(jīng)存在表結構數(shù)據(jù)的已有數(shù)據(jù)庫使用flyway需要設置為true,且版本號要比1大
    #baseline-on-migrate: true

2.3 創(chuàng)建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 = '系統(tǒng)用戶' 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腳本開始執(zhí)行

執(zhí)行成功后可以發(fā)現(xiàn)數(shù)據(jù)庫中多出一張flyway_schema_history 的表來記錄每次腳本的執(zhí)行

image-20210425161021257

以后只要數(shù)據(jù)庫有更新,只需要在db文件夾下創(chuàng)建更高版本的sql腳本(V1.x__xxx.sql,V2__xxx.sql),重啟項目的時候就會自動執(zhí)

行。

2.5 常見問題

1、可以基于環(huán)境變量,實現(xiàn)不同的環(huán)境,做不同的初始化腳本嗎?
基于我們的配置中 心,可以對flyway.locations配置進行修改,不同環(huán)境的初始化腳本可以放到不同的目錄下。

2、初始化數(shù)據(jù)過程會發(fā)生錯誤回滾?
每 一個sql 文件會有 一個單獨的事物,如果單個文件中發(fā) 生錯誤,單個文件的操作會回滾, 比如有1、2、3個 文件,第 二個文件發(fā)生錯誤,第二個文件所有操作將會回滾,第三個文件不會執(zhí)行。但: 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的內容,請搜索W3Cschool以前的文章或繼續(xù)瀏覽下面的相關文章,希望大家以后多多支持!

0 人點贊