[스프링 핵심 원리] 컴포넌트 스캔

컴포넌트 스캔과 의존관계 자동 주입 시작하기

• 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 등을 통해서 설정 정보(AppConfig.class)에 직접 등록할 스프링 빈을 나열했다.
• 예제에서는 몇개가 안되었지만, 이렇게 등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다.
• 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
• 또 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다.

 

@Component

• @Component가 붙은 클래스는 @ComponentScan에 의해 스캔되어 자동으로 스프링 빈으로 등록된다.

 

@ComponentScan

• @ComponentScan으로 스캔된 @Component가 붙은 클래스의 스프링 빈 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
• 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService1") 이런식으로 이름을 부여하면 된다.

@Configuration 이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스코드를 열어보면 @Component 애노테이션이 붙어있기 때문이다

 

@Autowired

• 생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다. 매개변수의 타입을 보고 알아서 찾아준다.
• 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.
• 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
  • getBean(MemberRepository.class) 와 동일하다고 이해하면 된다.

 

 

개인적 참고사항

스프링은 컴포넌트 스캔시 기본으로 싱글톤으로 빈을 등록합니다. 그리고 @Configuration 없이 @Bean만 사용해서 스프링 빈을 등록해도 싱글톤으로 등록됩니다.

싱글톤이 안되고, 문제가 되는 부분은 AppConfig같은 클래스에서 @Bean으로 수동 등록할 때, 내부의 의존관계를 직접 메서드 호출로 주입할 때만 발생하고, 이때 문제를 해결해주는 것이 @Configuration 애노테이션입니다.

 

탐색 위치와 기본 스캔 대상

탐색할 패키지의 시작 위치 지정 모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.

@ComponentScan(
 	basePackages = "hello.core",
}

• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
  • basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• 만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

권장하는 방법

개인적으로 즐겨 사용하는 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.

 

컴포넌트 스캔 기본 대상

• @Component : 컴포넌트 스캔에서 사용한다.
• @Controlller : 스프링 MVC 컨트롤러에서 사용한다. => 스프링 MVC 컨트롤러로 인식한다.
• @Service : 스프링 비즈니스 로직에서 사용한다 => 사실 @Service 는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.
• @Repository : 스프링 데이터 접근 계층에서 사용한다. => 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
• @Configuration : 스프링 설정 정보에서 사용한다. => 스프링 설정정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

참고: 사실 애노테이션에는 상속관계라는 것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.

 

 

중복 등록과 충돌

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

 

자동 빈 등록 vs 자동 빈 등록

• 컴포넌트 스캔에 의해 자동으로 빈이 만들어지는 경우, 그 이름이 같을 때 스프링은 ConflictingBeanDefinitionException 예외를 발생시킨다.

 

수동 빈 등록 vs 자동 빈 등록

//수동 빈 등록, AutoAppConfig.java
@Configuration
@ComponentScan
        basePackages = "hello.core"
)
public class AutoAppConfig {
    @Bean(name="memoryMemberRepository")
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
}

-----------------------------------------------------
//자동 빈 등록, MemoryMemberRepository.java
@Component
public class MemoryMemberRepository implements MemberRepository{

}

• 컴포넌트 스캔에 의해 자동으로 빈이 만들어지는 경우와 AppConfig클래스를 만들어 수동으로 빈을 등록하는 경우 이름이 같을 때 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버린다.)
• 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 아래와 같은 오류가 발생하도록 기본 값을 바꾸었다. 
  • "Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true"
  • 스프링 부트인 CoreApplication 을 실행해보면 오류를 볼 수 있다.