spring Cloud Alibaba中集中管理公共模塊Entity、Mapper、Service的最佳實踐
在使用spring cloud Alibaba構建微服務架構時，合理組織代碼結構至關重要。本文探討如何將多個業務模塊的Entity、Mapper、Service組件集中到一個公共模塊（Common模塊）中，并解決可能出現的沖突和問題，最終提升代碼復用性和可維護性。
項目結構:
假設項目包含以下模塊：
- common模塊: 包含Entity、Mapper、Service接口和實現類、數據庫連接配置、統一異常處理、redis json序列化、統一響應結果封裝、Swagger配置、mybatis Plus配置、CORS配置等公共組件。
- merchant模塊 (商戶端): 包含Controller，調用common模塊中的Service處理業務邏輯并對外提供API接口。
- supply模塊 (供貨商): 類似merchant模塊，包含Controller和業務邏輯，同樣依賴common模塊。
問題及解決方案:
啟動merchant模塊時，出現javax.management.InstanceAlreadyExistsException錯誤，這通常與spring boot Admin沖突有關，也可能與不正確的包掃描配置有關。 解決方法如下：
-
精確的包掃描配置: 在每個業務模塊（merchant和supply）的啟動類中，使用@ComponentScan精確指定需要掃描的包路徑。避免使用通配符*，只掃描業務模塊自身的Controller，而依賴common模塊中的組件。例如，merchant模塊的啟動類：
@SpringBootApplication @ComponentScan(basePackages = "com.quanneng.merchant") // 只掃描merchant模塊下的組件 @MapperScan("com.quanneng.common.mapper") //單獨掃描mapper接口 public class MerchantApiApplication { // ... } -
避免Spring Boot Admin沖突: 如果使用了Spring Boot Admin，確保其配置正確，并且不會與其他組件產生沖突。 檢查Spring Boot Admin的配置，確保其監控的應用名稱唯一。 如果問題依然存在，可以暫時禁用Spring Boot Admin，排查是否為其引起的沖突。
-
Mapper接口掃描: 使用@MapperScan注解單獨掃描common模塊下的Mapper接口，避免與其他模塊的Mapper接口沖突。 確保@MapperScan指定的包路徑準確無誤。
-
公共組件的依賴管理: 確保common模塊中所有公共組件的依賴都已正確聲明，并且版本與其他模塊兼容。
-
模塊化設計: 將common模塊設計為一個獨立的模塊，并將其打包成一個Spring Boot Starter。這樣，其他模塊只需要依賴這個Starter，即可方便地使用common模塊中的組件，避免包掃描配置的復雜性。
改進建議:
- 使用Spring Boot Starter: 將common模塊打包成一個Spring Boot Starter，簡化依賴管理和配置。
- 統一異常處理: 在common模塊中實現統一的異常處理機制，并在所有模塊中使用。
- 統一響應結果: 在common模塊中定義統一的響應結果格式，提高API接口的一致性。
- 模塊化原則: 遵循模塊化設計原則，將公共組件與業務組件分離，提高代碼的可維護性和可重用性。
通過以上步驟，可以有效地將Entity、Mapper、Service組件集中到common模塊，并避免潛在的沖突。 精確的包掃描配置和模塊化設計是解決此類問題的關鍵。 如果仍然遇到問題，請檢查日志信息，找出具體的錯誤原因。
