企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(二)

前言

上一篇我們介紹了在分佈式項目中,如何新建單獨的配置子項目,來解決整個系統的配置問題,也順便介紹了一般多環境的處理方案

但我們遺留了2個問題,那今天老顧介紹一下怎麼解決遺留的問題。

遺留問題一

如何不要新建多個配置文件,如:application-dev.yml,application-prod.yml;這樣的方案很多的子項目都要新建這些文件,太麻煩了。我們來介紹一下下面的方案。

我們利用maven的Profiles來幫我們區分一下環境;我們分佈式項目中正好都會有一個parent pom父項目,起到統一依賴版本,以及公共的依賴包的作用,如下圖:

企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(二)

修改父POM

企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(二)

上面有兩段profile,分別代表開發環境和生產環境,核心以id為準,properties標籤裡面包含不同環境的參數值。

激活 profile 配置

用戶可以在 mvn 命令行中添加參數“-P”,指定要激活的 profile 的 id。如果一次要激活多個 profile,可以用逗號分開一起激活。例如:

<code>


1. `mvn clean install -Pdev`


/<code>

如果希望某個 profile 默認一直處於激活狀態,可以在 profile 中配置 activation 元素,指定某個 profile 為默認激活狀態,樣例配置代碼如下:

<code>


1. `<activation>`

2. `<activebydefault>true/<activebydefault>`

3. `/<activation>`


/<code>

那我們yml的配置文件中,如何引用到pom裡面配置profile的參數呢?那就是利用@@標記。我們可以在rb-common-config子項目的配置文件中引用pom文件中profile參數值,如下

企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(二)

在maven進行構建時,會把@XXX@替換為相應的參數值。這樣就起到了通過maven構建達到區分不同的環境。

這種方案最大的好處就是,我們只需要建一個配置文件,不需要為每個環境新建一個配置文件了,看上去還比較清晰。

其他引用項目rb-user-server如何引用rb-common-config配置的參數呢?其實比較簡單就是${}方式,如圖

企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(二)

獲取配置參數流程

我們總結一下上面的整個獲取參數的流程

企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(二)

遺留問題二

還有一個問題就是安全性問題,我們不可能把生產環境的一些重要的參數暴露給開發人員,生產環境一般都是運維進行管理的,那如何配置生產環境呢?

一般我們配置的方式就是外部化配置,什麼意思呢?繼續往下看。

採用springboot項目,默認是把配置文件和lib依賴都打到了一個jar中,我們在運行的時候直接採用

<code>


1. `java -jar xxx.jar`


/<code>

這種方式簡化了jar包的啟動,但是也有不好的地方。

第一:jar包比較大,這是因為這個jar包含了第三方依賴的jar包,所以很大,給運維帶來一些麻煩,這個還不是太重要。

上面的問題還不是太重要,下面的問題就比較致命了。

第二:配置文件也打進了jar包中,不方便我們進行查看配置,而且不能夠修改配置,這個也太難受了,要修改配置,需要重新打包。

那怎麼處理呢?

分離lib和resources

就是利用maven插件把springboot的jar裡面的lib和resources文件分離出來,裡面涉及到

maven-jar-plugin spring-boot-maven-plugin maven-dependency-plugin maven-resources-plugin

各自插件的使用,這裡就不介紹了,直接上配置。

spring-boot-maven-plugin 排除啟動jar包中依賴的jar包

企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(二)

maven-jar-plugin 自定義maven jar打包內容

企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(二)

maven-dependency-plugin 複製項目的依賴包到指定目錄

企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(二)

分離lib中,需要把config子項目中的配置文件解壓裡面,也一起放到當前項目的config中。

maven-resources-plugin複製配置文件

企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(二)

通過上面的配置,我們就分離出了lib和resources文件,用maven構建。

企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(二)

這樣我們達到了把config配置文件分離了出來。

我們把配置文件分離出來了就好辦了,在生產環境的時候,真實的配置文件在運維手上,運維會替換掉maven構建出來的config配置文件。

這樣就很好的保護了生產環境的參數值。

備註:如果配置文件包含其他的,就需要在啟動的時候 加上--spring.config.location;通過此屬性指定配置

外部配置文件絕對目錄,如果是目錄需要/結尾,也可以直接指定文件。

如果指定的是目錄,spring則會讀取目錄中的所有配置文件。

總結

介紹到這裡我們已經做到了配置文件外部化了,大型項目在配置規劃時,會引入配置中心這個概念(這個之前老顧已經介紹過了),不需要引入子項目config,直接連接配置中心即可。

還有在企業級應用中,還要結合持續化集成方案,自動打包、部署。這些就不是這篇文章介紹的內容了,老顧下次再介紹。

企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(二)

上篇內容:· 企業級SpringBoot應用多個子項目配置文件規劃、多環境支持(一)


分享到:


相關文章: