SpringBoot公共模塊配置

開發(fā)微服務的項目中，很多時候會將公共的部分抽離出來單獨實現(xiàn)，以便于重用、易于維護，為此，我們一般會將公共的配置信息放在公共模塊中，這樣能盡量減少重復的配置，使得代碼結(jié)構(gòu)更簡潔清晰，下面是簡單的兩個模塊的配置案例

先看下兩個模塊的配置結(jié)構(gòu)，common-provider公共模塊，包含公共的服務和公共的配置信息，merchant-provider具體業(yè)務模塊

這是公共模塊dev環(huán)境配置中的一個參數(shù)，后面將讀取這個參數(shù)來測試

這個是最頂層的父pom，需要在當中配置上面兩個模塊的profile，其中

<profiles.active>dev</profiles.active>是當前業(yè)務模塊的profile，

<commonactive>common-dev</commonactive>是公共模塊的profile，<commonactive>標簽的名稱可以根據(jù)自己的需要取名稱

父pom配置好了后，接下來只需要在merchant-provider模塊的bootstrap.yml引入profile就可以了

active的參數(shù)值跟父pom中的profile配置的名稱需要對應

接著在merchant-provider模塊中引入common-provider模塊

下面是common-provider模塊中的一個文件服務接口，在里面引用了配置文件中的uploadFilePath參數(shù)

接下來啟動merchant-provider模塊

可以看到common-provider模塊中uploadFile參數(shù)讀取到了

Spring Bean和Mybatis接口 掃描路徑配置

先看下兩個模塊的目錄結(jié)構(gòu)

common-provide模塊

merchant-provider模塊

在common-provide模塊中，定義了一些公共服務，如FileService文件上傳服務，系統(tǒng)配置服務，這些服務在其他的業(yè)務模塊很多地方會用到，接下來通過配置后，在merchant-provider模塊中調(diào)用common-provide模塊中的FileService服務接口

在common-provide模塊定義好了業(yè)務Bean以后，接下來就是要配置如何能調(diào)用到，也就是要配置掃描Bean的路徑，以便Spring掃描到并加載到Spring容器，通常設置Bean的掃描路徑無非就是在配置文件中指定路徑、在啟動類中通過注解@ComponentScan、@MapperScan注解指定，或者通過自定已的配置文件中指定

先看看在啟動類中指定

上圖中指定了三個掃描路徑

@ComponentScan(basePackages ={"com.mall.comservice.service"})

指定common-provider公共模塊服務Bean的掃描路徑，這里把指定范圍限定在最小的service目錄，這樣可以減少Spring掃描的范圍

@MapperScan(basePackages = {"com.mall.merchant.dao,com.mall.comservice.dao"})

這里指定了common-provider公共模的掃描Mapper接口的路徑com.mall.comservice.dao

指定了當前模塊掃描Mapper接口的路徑com.mall.merchant.dao

以上是比較常用的一種做法，但是我們這里是將common-provider公共模抽離出來重用，因此應該盡量減少代碼侵入，而上面的這種做法意味著以后其他每個模塊要調(diào)用common-provider模塊時，都需要重復的在每個啟動類上配置掃描路徑，這種方式不便于維護

因此比較好的做法是，將掃描路徑配置到common-provider模塊的自定已配置類中，讓公共模塊自動掃描，而不依賴調(diào)用方來指定路徑，這樣其他業(yè)務模塊就不用再重復的配置掃描路徑了，只需要在pom文件中引入該模塊即可

那么接下來我們在common-provider模塊中定義一個配置類，并指定服務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)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論