Spring Boot 中多 Elasticsearch 数据源配置：为什么需要 @Qualifier 和构造函数注入？-阿噜噜小栈

在 Spring Boot 项目中，使用多个 Elasticsearch 数据源时，通常会遇到如何正确注入 ElasticsearchRestTemplate 的问题。直接使用 @Autowired 可能会导致 Bean 冲突，而结合 @Qualifier 和构造函数注入可以很好地解决这个问题。本文将详细解释为什么需要这样做，并提供最佳实践。

1. 多数据源配置的背景

在实际项目中，我们可能需要连接多个 Elasticsearch 集群或实例。例如：

一个用于生产环境，另一个用于测试环境。
一个用于读写操作，另一个用于只读操作。

在 Spring Boot 中，我们可以通过配置多个 RestHighLevelClient 和 ElasticsearchRestTemplate 来实现多数据源的支持。

2. 直接使用 `@Autowired` 的问题

在 Spring 中，@Autowired 默认是按类型（byType）进行依赖注入的。如果 Spring 容器中存在多个相同类型的 Bean（例如两个 ElasticsearchRestTemplate），Spring 会抛出 NoUniqueBeanDefinitionException 异常。

@Bean(name = "firstTemplate")
public ElasticsearchRestTemplate firstTemplate() {
    return new ElasticsearchRestTemplate(firstClient());
}

@Bean(name = "secondTemplate")
public ElasticsearchRestTemplate secondTemplate() {
    return new ElasticsearchRestTemplate(secondClient());
}

如果直接使用 @Autowired：

@Autowired
private ElasticsearchRestTemplate template; // 这里会报错，因为 Spring 不知道注入哪个 Bean

Spring 无法确定应该注入 firstTemplate 还是 secondTemplate，从而导致异常。

3. 使用 `@Qualifier` 解决 Bean 冲突

@Qualifier 注解的作用是指定要注入的 Bean 的名称（byName），从而解决多 Bean 冲突的问题。例如：

@Autowired
@Qualifier("firstTemplate")
private ElasticsearchRestTemplate firstTemplate;

@Autowired
@Qualifier("secondTemplate")
private ElasticsearchRestTemplate secondTemplate;

通过 @Qualifier，你可以明确告诉 Spring 应该注入哪个 Bean。

4. 构造函数注入的优势

在 Spring 中，构造函数注入是一种推荐的方式，尤其是在多数据源场景下。例如：

@Autowired
public MyService(@Qualifier("firstTemplate") ElasticsearchRestTemplate firstTemplate,
                 @Qualifier("secondTemplate") ElasticsearchRestTemplate secondTemplate) {
    this.firstTemplate = firstTemplate;
    this.secondTemplate = secondTemplate;
}

构造函数注入的优点：

不可变性：通过构造函数注入的字段可以被声明为 final，确保它们在对象创建后不会被修改。
易于测试：构造函数注入使得依赖关系更加明确，便于在单元测试中通过构造函数传入模拟对象。
避免空指针异常：Spring 在创建 Bean 时会确保所有依赖都通过构造函数注入，避免了字段注入时可能出现的空指针异常。

5. 替代方案：字段注入和 Setter 注入

如果你不想使用构造函数注入，也可以使用字段注入或 Setter 注入，但仍然需要结合 @Qualifier 来指定具体的 Bean。

字段注入

@Autowired
@Qualifier("firstTemplate")
private ElasticsearchRestTemplate firstTemplate;

@Autowired
@Qualifier("secondTemplate")
private ElasticsearchRestTemplate secondTemplate;

Setter 注入

private ElasticsearchRestTemplate firstTemplate;
private ElasticsearchRestTemplate secondTemplate;

@Autowired
@Qualifier("firstTemplate")
public void setFirstTemplate(ElasticsearchRestTemplate firstTemplate) {
    this.firstTemplate = firstTemplate;
}

@Autowired
@Qualifier("secondTemplate")
public void setSecondTemplate(ElasticsearchRestTemplate secondTemplate) {
    this.secondTemplate = secondTemplate;
}

6. 最佳实践

在多数据源场景下，推荐使用以下方式：

使用 @Qualifier：明确指定要注入的 Bean。
优先使用构造函数注入：确保依赖关系的不可变性和可测试性。
合理配置多数据源：在 application.yml 中为每个数据源配置独立的连接信息。

7. 示例代码

以下是一个完整的示例代码：

`application.yml`

elasticsearch:
  first:
    rest:
      uris: 10.1.0.1:9200,10.1.0.2:9200,10.1.0.3:9200
      username: elastic
      password: your_password_1
  second:
    rest:
      uris: 10.1.0.4:9200,10.1.0.5:9200,10.1.0.6:9200
      username: elastic
      password: your_password_2

配置类

@Configuration
public class ElasticsearchConfig {

    @Bean
    @Primary
    @ConfigurationProperties(prefix = "elasticsearch.first.rest")
    public ElasticsearchProperties firstElasticsearchProperties() {
        return new ElasticsearchProperties();
    }

    @Bean
    @ConfigurationProperties(prefix = "elasticsearch.second.rest")
    public ElasticsearchProperties secondElasticsearchProperties() {
        return new ElasticsearchProperties();
    }

    @Bean(name = "firstClient")
    @Primary
    public RestHighLevelClient firstClient(ElasticsearchProperties firstElasticsearchProperties) {
        return createRestHighLevelClient(firstElasticsearchProperties);
    }

    @Bean(name = "secondClient")
    public RestHighLevelClient secondClient(ElasticsearchProperties secondElasticsearchProperties) {
        return createRestHighLevelClient(secondElasticsearchProperties);
    }

    private RestHighLevelClient createRestHighLevelClient(ElasticsearchProperties properties) {
        List<String> uris = properties.getUris();
        HttpHost[] httpHosts = uris.stream()
                .map(uri -> {
                    String[] hostAndPort = uri.split(":");
                    return new HttpHost(hostAndPort[0], Integer.parseInt(hostAndPort[1]), "http");
                })
                .toArray(HttpHost[]::new);

        RestClientBuilder builder = RestClient.builder(httpHosts);
        return new RestHighLevelClient(builder);
    }

    public static class ElasticsearchProperties {
        private List<String> uris;
        private String username;
        private String password;

        // Getters and Setters
    }
}

服务类

@Service
public class MyService {

    private final ElasticsearchRestTemplate firstTemplate;
    private final ElasticsearchRestTemplate secondTemplate;

    @Autowired
    public MyService(@Qualifier("firstTemplate") ElasticsearchRestTemplate firstTemplate,
                     @Qualifier("secondTemplate") ElasticsearchRestTemplate secondTemplate) {
        this.firstTemplate = firstTemplate;
        this.secondTemplate = secondTemplate;
    }

    public void useFirstTemplate() {
        // 使用第一个 ElasticsearchRestTemplate 进行操作
    }

    public void useSecondTemplate() {
        // 使用第二个 ElasticsearchRestTemplate 进行操作
    }
}