SpringBoot公共模塊配置方式
SpringBoot公共模塊配置
開發(fā)微服務(wù)的項目中,很多時候會將公共的部分抽離出來單獨實現(xiàn),以便于重用、易于維護,為此,我們一般會將公共的配置信息放在公共模塊中,這樣能盡量減少重復(fù)的配置,使得代碼結(jié)構(gòu)更簡潔清晰,下面是簡單的兩個模塊的配置案例
先看下兩個模塊的配置結(jié)構(gòu),common-provider公共模塊,包含公共的服務(wù)和公共的配置信息,merchant-provider具體業(yè)務(wù)模塊
這是公共模塊dev環(huán)境配置中的一個參數(shù),后面將讀取這個參數(shù)來測試
這個是最頂層的父pom,需要在當(dāng)中配置上面兩個模塊的profile,其中
<profiles.active>dev</profiles.active>是當(dāng)前業(yè)務(wù)模塊的profile,
<commonactive>common-dev</commonactive>是公共模塊的profile,<commonactive>標(biāo)簽的名稱可以根據(jù)自己的需要取名稱
父pom配置好了后,接下來只需要在merchant-provider模塊的bootstrap.yml引入profile就可以了
active的參數(shù)值跟父pom中的profile配置的名稱需要對應(yīng)
接著在merchant-provider模塊中引入common-provider模塊
下面是common-provider模塊中的一個文件服務(wù)接口,在里面引用了配置文件中的uploadFilePath參數(shù)
接下來啟動merchant-provider模塊
可以看到common-provider模塊中uploadFile參數(shù)讀取到了
Spring Bean和Mybatis接口 掃描路徑配置
先看下兩個模塊的目錄結(jié)構(gòu)
common-provide模塊
merchant-provider模塊
在common-provide模塊中,定義了一些公共服務(wù),如FileService文件上傳服務(wù),系統(tǒng)配置服務(wù),這些服務(wù)在其他的業(yè)務(wù)模塊很多地方會用到,接下來通過配置后,在merchant-provider模塊中調(diào)用common-provide模塊中的FileService服務(wù)接口
在common-provide模塊定義好了業(yè)務(wù)Bean以后,接下來就是要配置如何能調(diào)用到,也就是要配置掃描Bean的路徑,以便Spring掃描到并加載到Spring容器,通常設(shè)置Bean的掃描路徑無非就是在配置文件中指定路徑、在啟動類中通過注解@ComponentScan、@MapperScan注解指定,或者通過自定已的配置文件中指定
先看看在啟動類中指定
上圖中指定了三個掃描路徑
@ComponentScan(basePackages ={"com.mall.comservice.service"})
指定common-provider公共模塊服務(wù)Bean的掃描路徑,這里把指定范圍限定在最小的service目錄,這樣可以減少Spring掃描的范圍
@MapperScan(basePackages = {"com.mall.merchant.dao,com.mall.comservice.dao"})
這里指定了common-provider公共模的掃描Mapper接口的路徑com.mall.comservice.dao
指定了當(dāng)前模塊掃描Mapper接口的路徑com.mall.merchant.dao
以上是比較常用的一種做法,但是我們這里是將common-provider公共模抽離出來重用,因此應(yīng)該盡量減少代碼侵入,而上面的這種做法意味著以后其他每個模塊要調(diào)用common-provider模塊時,都需要重復(fù)的在每個啟動類上配置掃描路徑,這種方式不便于維護
因此比較好的做法是,將掃描路徑配置到common-provider模塊的自定已配置類中,讓公共模塊自動掃描,而不依賴調(diào)用方來指定路徑,這樣其他業(yè)務(wù)模塊就不用再重復(fù)的配置掃描路徑了,只需要在pom文件中引入該模塊即可
那么接下來我們在common-provider模塊中定義一個配置類,并指定服務(wù)Bean和Mapper接口的掃描路徑
因為需要讓公共模塊自動掃描,所以還需要針對配置類在建目錄resources/META-INF/spring,在該目錄下建org.springframework.boot.autoconfigure.AutoConfiguration.imports文件,并在該文件中指定配置類的路徑,讓spring通過該路徑掃描到配置類
注:因為本案例采用的是SpringBoot3,SpringBoot3對自動配置類進行了升級,對與SpringBoot2.7版本以下的還是按原來的配置方式,即在resources/META-INF/spring.factories文件中指定配置類的路徑,SpringBoot2.7以上版本不在支持這種方式
接下來把merchant-provider模塊中起啟動類中指定的掃描路徑去掉
啟動運行看看效果
可以看到日志顯示Common-provider模塊中的Mapper接口被加載了
然后調(diào)用公共模塊的FileService接口,接口被@Autowired注入進來了,可以正常的訪問
總結(jié)
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
Spring Boot項目集成UidGenerato的方法步驟
這篇文章主要介紹了Spring Boot項目集成UidGenerato的方法步驟,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-12-12MyBatis-Plus數(shù)據(jù)庫配置與數(shù)據(jù)源整合方案
本文詳細介紹了在MyBatis-Plus中進行數(shù)據(jù)庫配置與數(shù)據(jù)源整合的常見方法,包括單數(shù)據(jù)源和多數(shù)據(jù)源的配置步驟,以及如何使用SpringBoot的自動配置和手動配置來管理數(shù)據(jù)源,通過合理的配置,開發(fā)者可以簡化數(shù)據(jù)庫操作,實現(xiàn)高效的數(shù)據(jù)庫管理和復(fù)雜的應(yīng)用架構(gòu)2025-02-02通過Java實現(xiàn)zip文件與rar文件解壓縮的詳細步驟
這篇文章主要給大家介紹了如何通過?Java?來完成?zip?文件與?rar?文件的解壓縮,文中通過代碼示例講解的非常詳細,對大家的學(xué)習(xí)或工作有一定的幫助,需要的朋友可以參考下2024-07-07java圖的深度優(yōu)先遍歷實現(xiàn)隨機生成迷宮
這篇文章主要為大家詳細介紹了java圖的深度優(yōu)先遍歷實現(xiàn)隨機生成迷宮,文中示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2018-01-01