如何无需复制初始化代码替换Spring Boot Starter中的Bean？

我的Spring Boot应用依赖某个Starter，该Starter中定义了如下Bean：

@Bean
@ConditionalOnMissingBean(SomeBean.class)
public SomeBean someBean() {
    var someBean = new SomeBean();
    someBean.doSomething();
    someBean.doSomething2();
    someBean.doSomething3();
    someBean.doSomething4();
    return someBean;
}

我原本可以通过自定义同类型Bean来替换它，代码如下：

@Configuration
public class MyConfiguration {

    @Bean
    public SomeBean someBean() {
        var someBean = new SomeBean();
        someBean.doSomething();
        someBean.doSomething2();
        someBean.doSomething3();
        someBean.doSomething4();

        someBean.doSomethingCustom();    
        return someBean;
    }
}

但这种方式需要复制Starter中的Bean初始化代码，维护成本高。我尝试过以下方式，希望复用Starter初始化好的Bean并做自定义处理：

@Configuration
public class MyConfiguration {

    @Bean
    public SomeBean someBean(SomeBean starterBean) {    
        starterBean.doSomethingCustom();    
        return starterBean;
    }
}

但运行时会触发循环依赖错误：

The dependencies of some of the beans in the application context form a cycle

请问能否在不复制Starter中Bean初始化代码的前提下，替换或增强该Starter定义的Bean？

可以通过以下两种方式实现，无需复制Starter的初始化代码：

1. 使用BeanPostProcessor增强Bean #

BeanPostProcessor是Spring提供的扩展点，可以在Bean初始化完成后（即Starter的Bean初始化逻辑执行完毕后）对Bean进行自定义修改。这种方式不需要替换原Bean，而是直接增强它：

@Component
public class SomeBeanPostProcessor implements BeanPostProcessor {

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        if (bean instanceof SomeBean) {
            SomeBean someBean = (SomeBean) bean;
            someBean.doSomethingCustom();
        }
        return bean;
    }
}

这种方式完全复用Starter的Bean初始化逻辑，只添加自定义逻辑，且不会触发循环依赖。

2. 直接调用Starter的Bean初始化方法（适用于可访问Starter配置类的场景） #

如果Starter的配置类是公开的（可在你的应用中导入），可以直接调用其Bean初始化方法来获取已初始化的实例，再添加自定义逻辑：

@Configuration
public class MyConfiguration {

    @Bean
    public SomeBean someBean() {
        // 假设Starter的配置类是StarterConfig，且someBean方法是public的
        SomeBean starterBean = new StarterConfig().someBean();
        starterBean.doSomethingCustom();
        return starterBean;
    }
}

由于你的自定义Bean会触发Starter中@ConditionalOnMissingBean条件，Starter不会再创建自己的SomeBean实例，因此不会出现冲突或循环依赖。

注意事项 #

• 若为第三方Starter，优先使用BeanPostProcessor方式，因为你可能无法访问其内部配置类的方法。
• 禁止使用注入原Bean再返回的方式，这必然会导致循环依赖：Spring创建你的Bean时会依赖原Bean，而原Bean的创建又被你的Bean触发的@ConditionalOnMissingBean阻止，形成闭环。

内容的提问来源于stack exchange，提问作者Dónal