Spring Cloud Alibaba：业务模块分离技巧

Spring Cloud Alibaba 项目中的公共模块最佳实践：集中 Entity、Mapper 和 Service

本文探讨如何在 Spring Cloud Alibaba (版本 2021.0.1) 和 Spring Boot (版本 2.6.4) 项目中，有效地将多个业务模块（例如 merchant 和 supply 模块）的 Entity、Mapper 和 Service 集中到一个公共的 common 模块中。 文中将分析常见问题及解决方案，并提供最佳实践建议。

问题背景:

一个典型的多模块 Spring Cloud Alibaba 项目，可能会遇到将公共组件（Entity、Mapper、Service 等）集中到 common 模块后，其他业务模块启动失败的问题。例如，出现 org.springframework.beans.factory.BeanCreationException 错误，提示 RequestMappingHandlerAdapter 或其他 Bean 初始化失败。 即使 Swagger2 配置已正确放置在 common 模块中，并能在业务模块的 Controller 中正常工作，启动问题仍然可能存在。

无效尝试:

一些常见的尝试，例如在业务模块的启动类中使用 @SpringBootApplication(scanBasePackages = "com.quanneng") 或 @ComponentScan({"com.*"}) 进行包扫描，往往无法解决问题，仍然可能导致依赖注入失败（例如 MerchantService 和 MerchantMapper Bean 创建失败）。

解决方案与最佳实践:

问题根源在于 Spring Boot 的自动配置和组件扫描机制。 简单的包扫描可能导致冲突或遗漏。 以下步骤提供更稳健的解决方案：

1. 模块化设计: 将 common 模块设计为一个 Spring Boot Starter。这能显著简化依赖管理，避免复杂的包扫描配置，并确保 common 模块的组件能被其他模块正确识别和使用。

2. Starter 模块结构: Starter 模块应该包含：

   • pom.xml: 定义依赖关系，包含必要的 Spring Boot Starter 和其他依赖。
   • Entity 包: 包含所有业务实体类。
   • Mapper 包: 包含所有 MyBatis Mapper 接口。
   • Service 包: 包含所有业务服务接口和实现类。
   • AutoConfiguration 类: 使用 @Configuration 和 @Enable... 注解，配置必要的 Bean，例如 MyBatis 的 SqlSessionFactory。

3. 业务模块配置: 在每个业务模块（例如 merchant 模块）的 pom.xml 中，添加对 common Starter 模块的依赖。 业务模块的启动类无需进行额外的包扫描配置。

4. 避免重复配置: 确保在整个项目中，像 MyBatis 的配置、全局异常处理等，只在一个地方进行配置，通常在 common 模块的 AutoConfiguration 类中。

5. 细粒度控制: 如果需要对特定组件进行更细粒度的控制，可以在业务模块中创建配置类，并使用 @Import 注解导入 common 模块中的特定配置类或 Bean。

总结:

将公共组件集中到一个 Spring Boot Starter 模块中，是解决 Spring Cloud Alibaba 项目中模块化 Entity、Mapper 和 Service 的最佳实践。 这种方法能有效避免包扫描冲突，简化依赖管理，并提高代码的可维护性和可重用性。 通过这种方式，可以确保 common 模块中的组件在其他业务模块中能被正确地加载和使用，从而避免启动失败等问题。