17370845950

Spring Cloud Alibaba中集中管理公共模块Entity、Mapper、Service的最佳实践

在使用Spring Cloud Alibaba构建微服务架构时，合理组织代码结构至关重要。本文探讨如何将多个业务模块的Entity、Mapper、Service组件集中到一个公共模块（Common模块）中，并解决可能出现的冲突和问题，最终提升代码复用性和可维护性。

项目结构:

假设项目包含以下模块：

1. common模块: 包含Entity、Mapper、Service接口和实现类、数据库连接配置、统一异常处理、Redis JSON序列化、统一响应结果封装、Swagger配置、MyBatis Plus配置、CORS配置等公共组件。
2. merchant模块 (商户端): 包含Controller，调用common模块中的Service处理业务逻辑并对外提供API接口。
3. supply模块 (供货商): 类似merchant模块，包含Controller和业务逻辑，同样依赖common模块。

问题及解决方案:

启动merchant模块时，出现javax.management.InstanceAlreadyExistsException错误，这通常与Spring Boot Admin冲突有关，也可能与不正确的包扫描配置有关。 解决方法如下：

1. 精确的包扫描配置: 在每个业务模块（merchant和supply）的启动类中，使用@ComponentScan精确指定需要扫描的包路径。避免使用通配符*，只扫描业务模块自身的Controller，而依赖common模块中的组件。例如，merchant模块的启动类：

   @SpringBootApplication
   @ComponentScan(basePackages = "com.quanneng.merchant") // 只扫描merchant模块下的组件
   @MapperScan("com.quanneng.common.mapper") //单独扫描mapper接口
   public class MerchantApiApplication {
       // ...
   }

2. 避免Spring Boot Admin冲突: 如果使用了Spring Boot Admin，确保其配置正确，并且不会与其他组件产生冲突。 检查Spring Boot Admin的配置，确保其监控的应用名称唯一。 如果问题依然存在，可以暂时禁用Spring Boot Admin，排查是否为其引起的冲突。

3. Mapper接口扫描: 使用@MapperScan注解单独扫描common模块下的Mapper接口，避免与其他模块的Mapper接口冲突。 确保@MapperScan指定的包路径准确无误。

4. 公共组件的依赖管理: 确保common模块中所有公共组件的依赖都已正确声明，并且版本与其他模块兼容。

5. 模块化设计: 将common模块设计为一个独立的模块，并将其打包成一个Spring Boot Starter。这样，其他模块只需要依赖这个Starter，即可方便地使用common模块中的组件，避免包扫描配置的复杂性。

改进建议:

• 使用Spring Boot Starter: 将common模块打包成一个Spring Boot Starter，简化依赖管理和配置。
• 统一异常处理: 在common模块中实现统一的异常处理机制，并在所有模块中使用。
• 统一响应结果: 在common模块中定义统一的响应结果格式，提高API接口的一致性。
• 模块化原则: 遵循模块化设计原则，将公共组件与业务组件分离，提高代码的可维护性和可重用性。

通过以上步骤，可以有效地将Entity、Mapper、Service组件集中到common模块，并避免潜在的冲突。 精确的包扫描配置和模块化设计是解决此类问题的关键。 如果仍然遇到问题，请检查日志信息，找出具体的错误原因。