SpringBoot整合Flyway實(shí)現(xiàn)數(shù)據(jù)庫(kù)的初始化和版本管理操作
一、Flyway
1、介紹
Flyway 是一款開(kāi)源的
數(shù)據(jù)庫(kù)版本管理工具
。它可以很方便的在命令行中使用,或者在Java應(yīng)用程序中引入,用于管理我們的數(shù)據(jù)庫(kù)版本。
官方文檔:https://flywaydb.org/documentation/
2、業(yè)務(wù)痛點(diǎn)
日常開(kāi)發(fā)中常有以下場(chǎng)景:
- 一個(gè)系統(tǒng)有多套環(huán)境,更新表的SQL可能會(huì)遺漏某一個(gè)環(huán)境
- 每次部署一個(gè)新環(huán)境,就得把所有庫(kù)表的創(chuàng)建SQL手動(dòng)執(zhí)行一遍。多希望服務(wù)啟動(dòng),就創(chuàng)建自己需要的庫(kù)表
- 每次發(fā)版要記錄數(shù)據(jù)庫(kù)變更信息,或者單獨(dú)給出數(shù)據(jù)庫(kù)升級(jí)腳本
- 別人需求新增了SQL你不知道,系統(tǒng)一跑出來(lái)個(gè)數(shù)據(jù)庫(kù)報(bào)錯(cuò)又得問(wèn)人或者排錯(cuò)
3、個(gè)人理解
flyway,就像數(shù)據(jù)庫(kù)界的Git。
git做一個(gè)項(xiàng)目里代碼的版本管理,flyway做一個(gè)項(xiàng)目數(shù)據(jù)庫(kù)的版本管理。
- Version control for your database.
- Robust schema evolution across all your environments.
- With ease, pleasure and plain SQL.
使用了 Flyway 之后,如果再想進(jìn)行數(shù)據(jù)庫(kù)版本升級(jí),就不用改之前的數(shù)據(jù)庫(kù)腳本了,直接創(chuàng)建新的數(shù)據(jù)庫(kù)腳本,項(xiàng)目在啟動(dòng)時(shí)檢測(cè)了有新的更高版本的腳本,就會(huì)自動(dòng)執(zhí)行
二、SpringBoot整合flyway
1、整合 在pom文件中導(dǎo)入flyway依賴
<dependency> <groupId>org.flywaydb</groupId> <artifactId>flyway-core</artifactId> <version>5.2.4</version> </dependency>
- 注意和springboot之間的版本適配問(wèn)題 - flyway版本不建議太高
配置文件application或者bootstrap中新加flyway的配置
# flyway 配置 spring: flyway: # 啟用或禁用 flyway enabled: true # flyway 的 clean 命令會(huì)刪除指定 schema 下的所有 table, 生產(chǎn)務(wù)必禁掉。這個(gè)默認(rèn)值是 false 理論上作為默認(rèn)配置是不科學(xué)的。 clean-disabled: true # SQL 腳本的目錄,多個(gè)路徑使用逗號(hào)分隔 默認(rèn)值 classpath:db/migration locations: classpath:db/migration # metadata 版本控制信息表 默認(rèn) flyway_schema_history table: flyway_schema_history # 如果沒(méi)有 flyway_schema_history 這個(gè) metadata 表, 在執(zhí)行 flyway migrate 命令之前, 必須先執(zhí)行 flyway baseline 命令 # 設(shè)置為 true 后 flyway 將在需要 baseline 的時(shí)候, 自動(dòng)執(zhí)行一次 baseline。 baseline-on-migrate: true # 指定 baseline 的版本號(hào),默認(rèn)值為 1, 低于該版本號(hào)的 SQL 文件, migrate 時(shí)會(huì)被忽略 baseline-version: 1 # 字符編碼 默認(rèn) UTF-8 encoding: UTF-8 # 是否允許不按順序遷移 開(kāi)發(fā)建議 true 生產(chǎn)建議 false out-of-order: false # 需要 flyway 管控的 schema list,這里我們配置為flyway 缺省的話, 使用spring.datasource.url 配置的那個(gè) schema, # 可以指定多個(gè)schema, 但僅會(huì)在第一個(gè)schema下建立 metadata 表, 也僅在第一個(gè)schema應(yīng)用migration sql 腳本. # 但flyway Clean 命令會(huì)依次在這些schema下都執(zhí)行一遍. 所以 確保生產(chǎn) spring.flyway.clean-disabled 為 true schemas: flyway # 執(zhí)行遷移時(shí)是否自動(dòng)調(diào)用驗(yàn)證 當(dāng)你的 版本不符合邏輯 比如 你先執(zhí)行了 DML 而沒(méi)有 對(duì)應(yīng)的DDL 會(huì)拋出異常 validate-on-migrate: true
注意clean-disabled?。。? - 表示是否要清除已有庫(kù)下的表 - 即執(zhí)行腳本V1__xxx.sql,會(huì)先清除已有庫(kù)下的表?。∪缓笤賵?zhí)行腳本 - 設(shè)置為true,即確定關(guān)掉clean功能
resource/db/migration下添加數(shù)據(jù)庫(kù)腳本(這個(gè)路徑是上面配置中寫(xiě)的)
啟動(dòng)服務(wù),顯示控制臺(tái)可以看到SQL被執(zhí)行,并產(chǎn)生了歷史記錄表
2、SQL文件命名
注意SQL的命名規(guī)范有要求:
舉例:V2.0.1.7__create_core_table.sql
- V是前綴 表示這個(gè)文件只會(huì)被執(zhí)行一次
- 2.0.1.7為版本號(hào) ,高版本的執(zhí)行后不會(huì)再執(zhí)行低版本的SQL。如2.0.1.7先執(zhí)行了,2.0.1.6就不會(huì)被執(zhí)行了
__
: 兩個(gè)下劃線表示分隔符- create_user_table :腳本功能表述
- .sql: 后綴
注意flyway比較版本的先后是采用左對(duì)齊原則, 缺位用 0 代替,比如
- 1.0.1.1 比 1.0.1 高 - 1.0.10.0 比 1.0.9.9 高 - 1.0.10 和 1.0.010 一樣高
需要執(zhí)行多次的,以大寫(xiě)"R"開(kāi)頭,命名如R__insertInfo.sql ,R的腳本只要改變了就會(huì)執(zhí)行,R不帶版本號(hào)
。
3、版本號(hào)校驗(yàn)算法
flyway在升級(jí)數(shù)據(jù)庫(kù)時(shí)會(huì)先計(jì)算之前已經(jīng)升級(jí)過(guò)的腳本的checksum值和數(shù)據(jù)庫(kù)的checkSum值進(jìn)行比對(duì),如果老腳本發(fā)生了變化后checkSum校驗(yàn)就會(huì)失敗,從而拋出異常,checkSum計(jì)算算法為CRC32 (循環(huán)冗余校驗(yàn)碼)算法
新增的腳本則會(huì)和數(shù)據(jù)庫(kù)中的版本號(hào)進(jìn)行比較,如果小于數(shù)據(jù)庫(kù)存儲(chǔ)的最后一個(gè)版本號(hào),也不會(huì)繼續(xù)執(zhí)行。
4、工作流程
- 項(xiàng)目啟動(dòng),成功連接到數(shù)據(jù)庫(kù),flyway開(kāi)始運(yùn)行。
- 第一次使用,flyway會(huì)創(chuàng)建flyway_schema_history表,用于記錄SQL的執(zhí)行記錄
- flyway掃描classpath:db/migration路徑下的所有SQL腳本,并與flyway_schema_history表的記錄對(duì)比
- 若表里沒(méi)記錄,即新SQL,執(zhí)行并將信息寫(xiě)入history表 - R開(kāi)頭的文件只要發(fā)生修改,都會(huì)執(zhí)行一遍 - V開(kāi)頭的文件,如果上次執(zhí)行過(guò)后又發(fā)生了修改,則服務(wù)啟動(dòng)報(bào)錯(cuò) - 想讓V開(kāi)頭的已經(jīng)執(zhí)行過(guò)的文件再執(zhí)行一次,就得清楚history表中的數(shù)據(jù)后再啟動(dòng)服務(wù)
5、注意事項(xiàng)
- 報(bào)錯(cuò)后需要?jiǎng)h除flyway_schema_history中記錄,否則啟動(dòng)失敗
- V文件的優(yōu)先級(jí)高于R,假如三個(gè)V遷移腳本和一個(gè)R(無(wú)論新建還是修改)一起執(zhí)行,其中一個(gè)V報(bào)錯(cuò),則V會(huì)全部執(zhí)行完成且記錄到flyway_schema_history中,而R不執(zhí)行且不記錄,刪除表中報(bào)錯(cuò)記錄后,重新啟動(dòng),則執(zhí)行原錯(cuò)誤V和未執(zhí)行的R
- 多個(gè)要執(zhí)行的R中,如果出現(xiàn)了其中一個(gè)出現(xiàn)了錯(cuò)誤,則在其后的R都不執(zhí)行
- R的執(zhí)行順序根據(jù)命名來(lái)進(jìn)行排序
- 一個(gè)文件中ddl并不由一個(gè)事務(wù)管理,比如創(chuàng)建三個(gè)表,中間創(chuàng)建表語(yǔ)句報(bào)錯(cuò),則第一個(gè)表還是會(huì)創(chuàng)建成功并且提交事務(wù)
- 同一個(gè)遷移文件下假設(shè)都是DML(即insert、delete、update),那么如果中間出現(xiàn)錯(cuò)誤,所有的DML語(yǔ)句都會(huì)回滾
- 已經(jīng)執(zhí)行過(guò)的遷移文件(V)不能修改,否則啟動(dòng)報(bào)錯(cuò)
- 版本號(hào)相同會(huì)報(bào)錯(cuò)(Found more than one migration with version 1.0.0.9)
- 刪除sql文件后啟動(dòng)會(huì)報(bào)錯(cuò),報(bào)錯(cuò)如下:
If you removed this migration intentionally, run repair to mark the migration as deleted.
到此這篇關(guān)于SpringBoot整合Flyway實(shí)現(xiàn)數(shù)據(jù)庫(kù)的初始化和版本管理的文章就介紹到這了,更多相關(guān)SpringBoot整合Flyway內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- IDEA創(chuàng)建SpringBoot項(xiàng)目整合mybatis時(shí)mysql-connector-java報(bào)錯(cuò)異常的詳細(xì)分析
- SpringBoot整合Mysql和Redis的詳細(xì)過(guò)程
- springboot整合JPA訪問(wèn)Mysql的實(shí)現(xiàn)方法
- SpringBoot整合Sharding-JDBC實(shí)現(xiàn)MySQL8讀寫(xiě)分離
- Springboot整合camunda+mysql的集成流程分析
- springboot的yml配置文件通過(guò)db2的方式整合mysql的教程
- Springboot 使用maven release插件執(zhí)行版本管理及打包操作
- 如何在spring boot項(xiàng)目中使用Spring Security的BCryptPasswordEncoder類進(jìn)行相同密碼不同密文的加密和驗(yàn)證
相關(guān)文章
Spring Security OAuth2 實(shí)現(xiàn)登錄互踢的示例代碼
這篇文章主要介紹了Spring Security OAuth2實(shí)現(xiàn)登錄互踢的示例代碼,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-04-04Java中tomcat memecached session 共享同步問(wèn)題的解決辦法
這篇文章主要介紹了Java中tomcat memecached session 共享同步問(wèn)題的解決辦法的相關(guān)資料,需要的朋友可以參考下2015-10-10Java流操作之?dāng)?shù)據(jù)流實(shí)例代碼
這篇文章主要介紹了Java流操作之?dāng)?shù)據(jù)流實(shí)例代碼,具有一定借鑒價(jià)值,需要的朋友可以參考下2018-01-01Java日常練習(xí)題,每天進(jìn)步一點(diǎn)點(diǎn)(53)
下面小編就為大家?guī)?lái)一篇Java基礎(chǔ)的幾道練習(xí)題(分享)。小編覺(jué)得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧,希望可以幫到你2021-08-08Spring定時(shí)任務(wù)關(guān)于@EnableScheduling的用法解析
這篇文章主要介紹了Spring定時(shí)任務(wù)關(guān)于@EnableScheduling的用法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-06-06Java Web十條開(kāi)發(fā)實(shí)用小知識(shí)
這篇文章主要介紹了Java Web十條開(kāi)發(fā)實(shí)用小知識(shí)的相關(guān)資料,需要的朋友可以參考下2016-05-05mybatis解決<foreach>標(biāo)簽不能超過(guò)1000的問(wèn)題
MyBatis是一個(gè)開(kāi)源的持久層框架,它可以幫助開(kāi)發(fā)者簡(jiǎn)化數(shù)據(jù)庫(kù)操作的編寫(xiě),而foreach是MyBatis中的一個(gè)重要標(biāo)簽,用于在SQL語(yǔ)句中進(jìn)行循環(huán)操作,本文主要給大家介紹了mybatis解決<foreach>標(biāo)簽不能超過(guò)1000的問(wèn)題,需要的朋友可以參考下2024-05-05SpringBoot中通過(guò)實(shí)現(xiàn)WebMvcConfigurer參數(shù)校驗(yàn)的方法示例
這篇文章主要介紹了SpringBoot中通過(guò)實(shí)現(xiàn)WebMvcConfigurer參數(shù)校驗(yàn)的方法示例,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-11-11java編譯時(shí)與運(yùn)行時(shí)概念與實(shí)例詳解
本篇文章通過(guò)實(shí)例對(duì) java程序編譯時(shí)與運(yùn)行時(shí)進(jìn)行了詳解,需要的朋友可以參考下2017-04-04