Spring Boot：如何配置参数化多个同类型第三方API客户端Bean？

问题背景 #

我需要调用一个按资源划分主机URL的第三方API，URL模板为：

https://<high-level-resource-id-foo>.example.com/<path-to-lower-resource-bar>

原来的客户端是单实例，通过构造函数传入主机URL，Bean定义和使用如下：

// Bean定义
@Bean
public FooExampleClient fooExampleClient(@Value("${foo-client.host}") String host) {
    return new FooExampleClient(host);
}

// 业务代码中使用
public void elsewhere(int barId) {
    this.fooExampleClient.doWork(barId);
}

对应的配置是：

foo-client.host=https://123.example.com

现在要操作多个高层级资源，希望通过配置动态定义多个客户端，不用硬编码，期望配置格式：

foo-client.foo-a.url=https://foo-a.example.com
foo-client.foo-b.url=https://foo-b.example.com
// ...
foo-client.foo-zzz.url=https://foo-zzz.example.com

需要实现：

• 不用硬编码就能动态查找foo-a、foo-b这类客户端
• 支持通过配置增删客户端，还能动态遍历所有客户端

实现方案 #

1. 绑定多客户端配置属性 #

首先用Spring的@ConfigurationProperties写一个配置类，批量承接所有客户端的配置：

// 适配你期望的foo-client.foo-a.url格式的配置类
@ConfigurationProperties(prefix = "foo-client")
public class FooClientProperties {
    // key是客户端标识（foo-a/foo-b），value是包含url的配置项
    private Map<String, ClientConfig> clients = new HashMap<>();

    public static class ClientConfig {
        private String url;
        // 标准getter/setter
        public String getUrl() { return url; }
        public void setUrl(String url) { this.url = url; }
    }

    public Map<String, ClientConfig> getClients() { return clients; }
    public void setClients(Map<String, ClientConfig> clients) { this.clients = clients; }
}

这样就能完美匹配你要的配置格式：

foo-client.foo-a.url=https://foo-a.example.com
foo-client.foo-b.url=https://foo-b.example.com
foo-client.foo-zzz.url=https://foo-zzz.example.com

2. 动态注册客户端Bean #

接下来用BeanDefinitionRegistryPostProcessor动态生成每个客户端的Bean，彻底告别硬编码：

@Configuration
@EnableConfigurationProperties(FooClientProperties.class)
public class FooClientAutoConfiguration implements BeanDefinitionRegistryPostProcessor {

    private final FooClientProperties properties;

    // 构造注入配置属性
    public FooClientAutoConfiguration(FooClientProperties properties) {
        this.properties = properties;
    }

    @Override
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        // 遍历所有配置的客户端，逐个注册Bean
        properties.getClients().forEach((clientId, config) -> {
            BeanDefinition beanDef = BeanDefinitionBuilder
                    .genericBeanDefinition(FooExampleClient.class)
                    .addConstructorArgValue(config.getUrl()) // 传入URL构造客户端实例
                    .getBeanDefinition();
            // 用客户端标识+固定后缀作为Bean名称，方便后续查找
            registry.registerBeanDefinition(clientId + "FooClient", beanDef);
        });
    }

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        // 无需额外操作，空实现即可
    }
}

3. 动态查找与遍历客户端 #

查找指定客户端

Spring会自动把同类型的Bean注入到Map中，直接用@Autowired注入一个Map<String, FooExampleClient>就能拿到所有客户端，Key是Bean名称：

@Service
public class BusinessService {
    @Autowired
    private Map<String, FooExampleClient> fooClientMap;

    // 根据客户端标识获取实例
    public FooExampleClient getClient(String clientId) {
        return fooClientMap.get(clientId + "FooClient");
    }

    // 业务中使用示例
    public void handleBar(String clientId, int barId) {
        FooExampleClient client = getClient(clientId);
        if (client != null) {
            client.doWork(barId);
        }
    }
}

遍历所有客户端

直接遍历Map的values就行，完全不用管有多少个客户端：

public void processAllBars(int barId) {
    fooClientMap.values().forEach(client -> client.doWork(barId));
}

4. 配置驱动增删 #

只要修改配置文件，添加/删除对应的foo-client.xxx.url项，重启应用后就会自动新增/移除对应的客户端Bean。如果需要不重启动态刷新，可以结合Spring Cloud Config和Actuator的refresh端点：

• 引入Spring Cloud Config依赖
• 开启management.endpoints.web.exposure.include=refresh配置
• 修改远程配置后，发送POST请求到/actuator/refresh触发配置刷新和Bean重新注册

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