基于Gradle为Spring项目条件化添加Bean的方案问询

一、打破循环依赖的核心拆分思路 #

把主项目拆成三层结构，彻底规避循环依赖：

• 基础核心模块：存放所有客户通用的组件、工具类、实体、通用业务接口等，不依赖任何定制模块
• 业务应用模块：依赖基础核心模块，负责组装通用业务逻辑、启动Spring Boot应用
• 定制模块：仅依赖基础核心模块，实现特定客户的定制功能（比如实现核心模块的接口、新增专属Bean）

二、Gradle条件化引入定制模块 #

1. 动态引入模块（settings.gradle） #

通过构建参数判断是否引入对应客户的定制模块：

// settings.gradle
def targetCustomer = findProperty('customer') ?: 'default'
if (targetCustomer != 'default') {
    include ":custom-${targetCustomer}"
    project(":custom-${targetCustomer}").projectDir = file("custom/${targetCustomer}")
}

2. 条件化依赖（业务应用模块的build.gradle） #

同样根据构建参数，让业务应用模块仅依赖指定的定制模块：

// app模块的build.gradle
def targetCustomer = findProperty('customer') ?: 'default'
dependencies {
    implementation project(':core')
    if (targetCustomer != 'default') {
        implementation project(":custom-${targetCustomer}")
    }
}

3. 构建命令示例 #

指定客户构建时，只会打包对应定制模块的代码：

./gradlew build -Pcustomer=clientA

三、让Spring Boot自动识别定制Bean #

1. 定制模块主动提供配置类 #

在定制模块中编写@Configuration类，负责扫描自身的Bean或手动注册：

// custom-clientA模块的配置类
@Configuration
@ComponentScan(basePackages = "com.yourcompany.custom.clientA")
public class ClientACustomConfig {
    // 手动注册定制Bean（可选，也可以靠@ComponentScan）
    @Bean
    public CustomBizService clientACustomBizService() {
        return new ClientACustomBizServiceImpl();
    }
}

因为业务应用模块依赖了定制模块，Spring Boot启动时会自动扫描到该配置类（只要配置类所在包在主项目的扫描范围内，或者主项目启动类用@ComponentScan包含定制包）。

2. 用Spring Boot自动配置简化 #

把定制模块做成轻量Starter，无需主项目修改任何配置：
在定制模块的src/main/resources/META-INF下创建spring.factories文件：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.yourcompany.custom.clientA.ClientACustomConfig

只要定制模块在类路径中，Spring Boot就会自动加载这个配置类，实现零侵入扩展。

四、额外优化建议 #

• 核心模块定义扩展接口：比如在核心模块定义CustomBizService接口，定制模块实现该接口，主项目通过@Autowired自动注入当前类路径下的实现类
• 避免硬编码包路径：可以在核心模块定义常量存储扩展包前缀，让定制模块遵循统一规范
• 测试隔离：通过Gradle参数切换定制模块，配合Spring的@ActiveProfiles实现不同客户场景的测试

内容的提问来源于stack exchange，提问作者DTS