A bean with that name has already been defined in XXX defined in @EnableElasticsearchRepositories declared on ElasticsearchConfig and overriding is disabled.

date

Jun 2, 2024

slug

elasticsearch-bean-already-defined

author

status

Public

문제상황

Spring Boot 환경에서 spring-data-elasticsearch 연동을 하던 중 아래와 같은 에러가 발생했다.

해석하자면 elasticSuggestionRepository 빈이 이미 등록되어 있기 때문에 오버라이딩하여 등록할 수 없다는 것이었다.


Description:

The bean 'elasticSuggestionRepository', defined in com.dreamypatisiel.devdevdev.elastic.domain.repository.ElasticSuggestionRepository defined in @EnableJpaRepositories declared on DevdevdevApplication, could not be registered. A bean with that name has already been defined in com.dreamypatisiel.devdevdev.elastic.domain.repository.ElasticSuggestionRepository defined in @EnableElasticsearchRepositories declared on ElasticsearchConfig and overriding is disabled.

해당 빈이 어디서 등록되고 있는지 추적하기 위하여 우선 패키지 구조를 정리하고 관련 클래스를 살펴보았다.


// 패키지 구조
elastic
   ㄴconfig
      ㄴElasticsearchConfig.java
   ㄴdomain
      ㄴdocument
         ㄴElasticSuggestion.java
      ㄴrepository
         ㄴElasticSuggestionRepository.java

xxxApplication.java


@SpringBootApplication
public class DevdevdevApplication {

    public static void main(String[] args) {
        SpringApplication.run(DevdevdevApplication.class, args);
    }
}

ElasticsearchConfig.java


@Configuration
@EnableElasticsearchRepositories(basePackages = {"com.dreamypatisiel.devdevdev.elastic.domain.repository"})
public class ElasticsearchConfig extends AbstractElasticsearchConfiguration {

    @Value("${elasticsearch.host}")
    private String host;
    @Value("${elasticsearch.port}")
    private String port;

    @Override
    public @NonNull RestHighLevelClient elasticsearchClient() {
        ClientConfiguration clientConfiguration = ClientConfiguration.builder()
                .connectedTo(host + ":" + port)
                .build();
        return RestClients.create(clientConfiguration).rest();
    }

    @Bean
    public ElasticsearchOperations elasticsearchOperations(RestHighLevelClient client) {
        return new ElasticsearchRestTemplate(client);
    }
}

위 config파일의 @EnableElasticsearchRepositories 로 인해 빈이 중복 등록되고 있는 것으로 보였다.

SpringBoot 에서는 자동으로 @EnableJpaRepositories가 설정되는데, 이때 등록된 빈이 @EnableElasticsearchRepositories에 의해 또 스캔되고 등록될 때 발생하는 문제가 아닐까 싶었다.

두 annotation을 살펴보면 다음과 같이 xxxRepositoriesRegistrar를 import하고 있고, 각 클래스는 모두 공통으로 ReposistoryBeanDefinitionRegistrarSupport 를 상속받고 있다.

JpaRepositoriesRegistrar.class

ElasticsearchRepositoruesRegistrar.class

즉, @EnableElasticsearchRepositories → ReposistoryBeanDefinitionRegistrarSupport 에 의해 등록된 빈이 @EnableJpaRepositories → ReposistoryBeanDefinitionRegistrarSupport 에 의해 또 등록되기 때문에 중복 문제가 발생했던 것으로 보인다.

해결

빈이 두 번 등록되어 에러가 발생했던 것이므로, 빈 등록이 한 번만 되도록 변경하여 해결했다!


@EnableJpaRepositories(excludeFilters = @ComponentScan.Filter(
		type = FilterType.ASSIGNABLE_TYPE,
		classes = ElasticSuggestionRepository.class))
@ConfigurationPropertiesScan
@EnableJpaAuditing
@SpringBootApplication
public class DevdevdevApplication {}


@Configuration
@EnableElasticsearchRepositories(basePackages = {"com.dreamypatisiel.devdevdev.elastic.domain.repository"})
public class ElasticsearchConfig extends AbstractElasticsearchConfiguration {}