[스프링 핵심 원리 - 기본편] 컴포넌트 스캔

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

• 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열
• 이렇게 등록할 스프링 빈이 많아지면 일일이 등록하기 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다. 
• 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공
• 또 의존 관계도 자동으로 주입하는 @Autowired라는 기능도 제공한다.

AutoAppConfig.java

@Configuration
@CompenentScan(
	excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}

• 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 된다.
• 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 없음!

참고 : 컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 그래서  excludeFilters를 사용해서 설정 정보는 컴포넌트 스캔 대상에서 제외했다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해 이 방법을 사용

컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록. @Component를 붙여주자.

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

이제 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여주자

@Component
public class MemberServiceImpl implements MemberService{
    private final MemberRepository memberRepository;

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

• 이전에 AppConfig에서는 @Bean으로 직접 설정 정보를 작성했고, 의존 관계도 직접 명시했다. 이제는 이런 설정 정보 자체가 없기 때문에, 의논 관계 주입도 이 클래스 안에서 해결해야 한다.
• @Autowired는 의존관계를 자동으로 주입해준다.
• @Autowired를 사용하면 생성자에서 여러 의존 관계도 한 번에 주입받을 수 있다.

컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 그림으로 알아보자

1. @ComponentScan

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록
• 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용
  • 빈 이름 기본 전략 : MemberServiceImpl 클래스 -> memberServiceImpl
  • 빈 이름 직접 지정 : 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런 식으로 이름을 부여하면 된다.

2. @Autowired 의존관계 자동 주입

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

 

 

 

탐색 위치와 기본 스캔 대상

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

@ComponentScan(
	basePackages = "hello.core"
)

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

권장하는 방법

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

 

예를 들어 프로젝트가 다음과 같이 구조가 되어 있으면

• com.hello
• com.hello.service
• com.hello.repository

com.hello -> 프로젝트 시작 루츠, 여기에  AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략한다.

 

이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다. 그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다

스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication을 이 프로젝트 시작 루트 위치에 두는 것이 관례 (그리고 이 설정 안에 바로 @ComponentScan이 들어있다.)

 

컴포넌트 스캔 기본 대상

컴포넌트 스캔은 @Component뿐만 아니라 다음과 내용도 추가로 대상에 포함한다.

• @Component : 컴포넌트 스캔에서 사용
• @Controller : 스프링 MVC 컨트롤러에서 사용
• @Service : 스프링 비즈니스 로직에서 사용
• @Repository : 스프링 데이터 접근 계층에서 사용
• @Configuration : 스프링 설정 정보에서 사용

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

컴포넌트 스캔의 용도뿐만 아니라 다음 애노테이션이 있으면 스프링은 부가 기능을 수행한다.

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

참고 : useDefaultFilters옵션은 기본으로 켜져 있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외됨.

 

 

 

필터

• includeFilters : 컴포넌트 스캔 대상을 추가로 지정
• excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정

컴포넌트 스캔 대상에 추가할 애노테이션

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent{
}

컴포넌트 스캔 대상에서 제외할 애노테이션

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent{
}

컴포넌트 스캔 대상에 추가할 클래스

@MyIncludeComponent
public class BeanA{
}

• @MyIncludeComponent 적용

컴포넌트 스캔 대상에서 제외할 클래스

@MyExcludeComponent
public class BeanB{
}

• @MyExcludeComponent 적용

테스트해보기

@ComponentScan(
    includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
    excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)

• includeFilters에 MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
• excludeFilters에 MyExcludeComponent 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다.

FilterType 옵션

FilterType은 5가지 옵션이 있다.

• ANNOTATION : 기본값, 애노테이션을 인식해서 동작한다.
  • ex ) org.example.SomeAnnotation
• ASSIGNAB:E_TYPE : 지정한 타입과 자식 타입을 인식해서 동작
  • ex ) org.example.SomeClass
• ASPECTJ :AspectJ 패턴 사용
  • ex ) org.example..*Service+
• REGEX : 정규 표현식
  • ex ) org\.example\.Default.*
• CUSTOM : TypeFilter이라는 인터페이스를 구현해서 처리
  • ex) org.example.MyTypeFilter

참고 : @Commponent면 충분하기 때문에 @includeFilters를 사용할 일은 거의 없다. @excludeFilters는 여러 가지 이유로 간혹 사용할 때가 있지만 많지 않다.

 

 

 

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까? -> 다음 두 가지 상황이 있다.

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

 

자동 빈 등록 vs 자동 빈 등록

• 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록됨. 그 이름이 같을 경우 스프링은 오류를 발생시킴
  • ConflictBeanDefinitionException 예외 발생

 

수동 빈 등록 vs 자동 빈 등록

만약 수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 어떻게 될까?

-> 이 경우 수동 빈 등록이 우선권을 가진다.(수동 빈이 자동 빈을 오버라이딩 해버림)

 

최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌 나면 오류가 발생하도록 기본 값을 바꾸었다.

 

 

 

참고 강의 : https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

스프링 핵심 원리 - 기본편 - 인프런 | 강의