[Spring] 스프링 컴포넌트 스캔(Component Scan)

지금까지 스프링 빈 설정을 하는 과정을 살펴보면 AppConfig 클래스에 @Configuration 어노테이션을 설정한 후 @Bean을 통해서 직접 등록할 스프링 빈을 설정했다. 

 

앞서 보인 예제는 몇 개 되지 않아 일일이 입력하였지만, 빈 객체가 많아지는 경우 일일이 선언해주기 어렵다(귀찮다)

또 실수로 빈 설정을 누락하는 경우 스프링 컨테이너에 빈 객체가 등록되지 않을 수도 있다.

 

그러므로 스프링은 설정 정보 없이 자동으로 스프링 빈을 등록하는 컴포넌트 스캔(@Component Scan)을 제공한다.

또한 의존관계를 자동으로 주입하는 @Autowired라는 기능도 제공한다

 

---

@ComponentScan, @Autowired 사용하기

우선 컴포넌트 스캔을 사용하려면 @ComponentScan을 설정 정보에 붙여준다.

앞에서 보였던 AppConfig와는 다르게 @Bean으로 선언한 클래스가 없다.

@Configuration
@ComponentScan
public class AutoAppConfig {

}

컴포넌트 스캔의 역할은 '컴포넌트 스캔' 말 그대로 @Component가 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.

@Configuration도 소스코드를 열어보면 @Component가 붙어있기 때문에 @Configuration도 자동으로 스캔한다.

 

코드 하나를 예시로 들어보자

@Component
public class MemberServiceImpl implements MemberService{

    private MemberRepository memberRepository;

    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    @Override
    public void join(Member member) {
        memberRepository.save(member);
    }

    @Override
    public Member findMember(Long memberID) {
        return memberRepository.findById(memberID);
    }
}

사용자가 스프링 빈 객체로 등록하고 싶은 클래스에 @Component를 선언하면 컴포넌트 스캔이 자동으로 스캔하여 스프링 빈 객체로 등록한다. @Bean을 사용할 때와 마찬가지로 객체의 싱글톤 패턴을 보장해준다.

컴포넌트 스캔은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다. 컴포넌트 스캔의 대상은 @Component, @Controller, @Service, @Repository, @Configuration이 있다.

 

이 때 빈 이름을 직접 지정하지 않으면 자동으로 클래스명을 사용하되, 가장 앞 글자만 소문자를 사용한다. 예를 들어 위 코드의 경우 memberServiceImPl이 빈 이름으로 설정될 것이다! 빈 이름을 직접 지정하고 싶으면 @Component("What you want")로 선언하면 된다.

 

AutoAppConfig 클래스의 코드를 보면 AppConfig와는 다르게 내부에서 의존관계를 주입하는 코드가 없다. 즉, 의존관계도 어노테이션을 이용해 자동으로 주입할 수 있다는 것이다 !

 

MemberServiceImpl의 생성자를 보면 @Autowired 어노테이션을 볼 수 있다. 오토와이어를 사용하면 생성자에서 여러 의존관계도 한 번에 주입받을 수 있다. 이 때 기본 동작 원리는 타입이 같은 빈을 찾아서 주입하는 것이다. 빈을 조회하는 코드인 getBean(object.class)와 동일하다고 이해하면 된다.

 

---

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까?

다음 두 상황이 있다.

 

1. 자동 빈 등록 vs 자동 빈 등록

2. 수동 빈 등록 vs 자동 빈 등록

 

컴포넌트 스캔에 의해 자동으로 등록된 빈은, 이름이 같은 경우 스프링이 오류를 발생시킨다.

ConflictingBeanDefinitionException 예외가 발생한다.

 

만약 수동으로 등록된 빈과 자동으로 등록된 빈 이름이 충돌하게 된다면

수동으로 등록된 빈이 우선권을 가진다. 즉, 수동 빈이 자동 빈을 오버라이딩 한다고 생각하면 된다.

 

그러나 수동 빈과 자동 빈이 충돌하게 되는 경우는 개발자가 의도적으로 설정한 것이 아닌 여러 설정들이 꼬여서 이런 결과가 만들어지는 것이 대부분이다. 따라서 이런 충돌이 발생하면 정말 잡기 어려운 버그가 만들어지고 치명적인 오류가 발생했지만 오류의 원인을 찾기 힘든 상황이 발생한다. 그래서 최근 스프링부트는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값(세팅)을 바꾸고 있다.

 

"Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true" 라는 오류 메세지를 스프링 부트가 반환한다.

 

테스트 코드에 수동 빈과 자동 빈을 같은 이름으로 설정한 후 스프링 부트인 CoreApplicaiton을 실행해보면 오류를 볼 수 있다.