如何在一个 Spring Boot java config 类（@Configuration）中创建多个 bean（相同类型）？

Question

在我的 yaml 文件中，我的配置值如下：

    myapp:
      rest-clients:
        rest-templates:
        - id: myService1
          username: chris
          password: li
          base-url: http://localhost:3000/service1
          read-timeout: 2s
          connect-timeout: 1s
        - id: myService2
          username: chris
          password: li
          base-url: http://localhost:3000/service1
          read-timeout: 2s
          connect-timeout: 1s

我希望 Spring Boot 2 应用为每个配置项注册一个 RestTemplate。

我的配置是bean如下：

@Configuration
@AllArgsConstructor
public class MyAppRestClientsConfiguration {

    private MyAppRestClientsProperties properties;

    private GenericApplicationContext applicationContext;

    private RestTemplateBuilder restTemplateBuilder;

    @PostConstruct
    public void init() {
        properties.getRestTemplates().forEach(this::registerRestTemplate);
    }

    private void registerRestTemplate(MyAppRestTemplateConfig config) {
       // do some work
       applicationContext.registerBean(config.getId(), RestTemplate.class, () -> restTemplate) 
    }
}

问题是当我通过@Autowire 注入我注册的RestTemplate 时，这个配置bean 还没有完成初始化。所以没有可以注入 RestTemplate bean。

    @Autowired
    @Qualifier("myService1")
    private RestTemplate client1;

The injection point has the following annotations:
    - @org.springframework.beans.factory.annotation.Autowired(required=true)
    - @org.springframework.beans.factory.annotation.Qualifier(value=myService1)

有没有正确的方法来实现这个要求？

Answer 1

在@PostConstruct 注释方法中注册新bean 的问题是Spring 已经过了Spring 生命周期中的那个特定点（more info on the Spring life cycle）。有时，@DependsOn（已经提到）、@Order 或 @Lazy 等注释可能会有所帮助。但是，正如您提到的，您不希望在使用您的库的项目上强制执行（spring）实现细节，我编写了一个BeanFactoryPostProcessor，它注册了一个RestTemplate bean：

@Component
public class DemoBeanFactoryPostProcessor implements BeanFactoryPostProcessor {

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) {
        GenericBeanDefinition genericBeanDefinition = new GenericBeanDefinition();
        genericBeanDefinition.setBeanClass(RestTemplate.class);

        HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
        factory.setReadTimeout(Integer.valueOf(configurableListableBeanFactory.resolveEmbeddedValue("${rest-templates[0].read-timeout}")));
        factory.setConnectTimeout(Integer.valueOf(configurableListableBeanFactory.resolveEmbeddedValue("${rest-templates[0].connect-timeout}")));
        // etc

        ConstructorArgumentValues constructorArgumentValues = new ConstructorArgumentValues();
        constructorArgumentValues.addGenericArgumentValue(factory);

        genericBeanDefinition.setConstructorArgumentValues(constructorArgumentValues);

        String beanId = configurableListableBeanFactory.resolveEmbeddedValue("${rest-templates[0].id}");
        ((DefaultListableBeanFactory) configurableListableBeanFactory).registerBeanDefinition(beanId, genericBeanDefinition);
    }
}

application.yml:

rest-templates:
  - id: myService1
    username: chris
    password: li
    base-url: http://localhost:3000/service1
    read-timeout: 2000
    connect-timeout: 1000
  - id: myService2
    username: chris
    password: li
    base-url: http://localhost:3000/service1
    read-timeout: 2000
    connect-timeout: 1000

伴随测试：

@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {

    @Autowired
    @Qualifier("myService1")
    private RestTemplate restTemplate;

    @Test
    public void demoBeanFactoryPostProcessor_shouldRegisterBean() {
        String stackOverflow =
                restTemplate.getForObject("https://stackoverflow.com/questions/57122343/how-to-create-multiple-beans-same-type-in-one-spring-boot-java-config-class", String.class);

        Assertions.assertThat(stackOverflow).contains("How to create multiple beans (same type) in one Spring Boot java config class (@Configuration)?");
    }

}

由于在完全设置应用程序上下文之前调用了BeanFactoryPostProcessor，因此我必须找到一种不同的方法来检索应用程序属性。我使用方法ConfigurableListableBeanFactory#resolveEmbeddedValue 来检索占位符值，而不是通过@Value 注释或environment#getProperty 注入它们。此外，我将属性值 2s 重写为 2000，因为 HttpComponentsClientHttpRequestFactory 需要一个 int 值。