[Spring] 컴포넌트 스캔, @ComponentScan

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

• 이전 포스팅까지는 스프링 빈을 등록할 때 자바 코드의 @Bean이나 XML의 <bean>등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.
• 등록할 빈의 수가 적다면 문제가 없겠지만 수십, 수백개가 되면 일일이 등록하기도 귀찮고 누락하는 문제가 발생한다.
• 그래서 스프링에는, 설정 정보 파일이 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
• 거기에 더해서 의존관계까지 자동으로 주입하는 @Autowired라는 기능도 제공한다!

 

---

 

- @ComponentScan, 새롭게 등장한 AutoAppConfig

• 기존 설정 정보 파일은 사용하지 않을것이니 새로운 설정 정보 파일 'AutoAppConfig' 을 생성하자.
  
  

// AutoAppConfig.java

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

• AutoAppConfig의 구성을 보자.
• 스프링 빈을 등록하는 부분이 존재하지 않는다.
• 대신 새로운 어노테이션인 @ComponentScan이 붙어있다. 무슨 역할일까?
• 기존의 설정 정보처럼, @Bean을 사용해 직접 스프링 빈을 등록하는 방식이 아니라 단순히 설정 정보에 @ComponentScan을 붙인 뒤, 스프링 빈으로 등록하고 싶은 대상에 @Component 어노테이션을 붙이면 스프링 빈 등록이 완료된다.
• 얼마나 간단한 일인가!
• 실제로 원하는 대상에 @Component를 붙여보자.

@Component
public class MemoryMemberRepository implements MemberRepository {}


@Component
public class RateDiscountPolicy implements DiscountPolicy {}



@Component
public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository;
    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
	this.memberRepository = memberRepository;
    }
}


@Component
public class OrderServiceImpl implements OrderService {
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy
            discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
}

컴포넌트 스캔을 통한 스프링 빈 등록

• 기존 AppConfig와 동일하게 모두 스프링 빈으로 등록했다. 
• 이 때 스프링 빈의 기본 이름은 클래스명을 사용하되, 맨 앞글자만 소문자를 사용한다.
• 예시로 MemberServiceImpl 클래스는 memberServiceImpl로 등록된다.
• 만약 스프링 빈의 이름을 직접 지정하고 싶으면, @Component("memberService2") 식으로 이름을 지어주면 된다.
• 여기서 의구심이 든다. AppConfig에서는 의존관계까지 설정해줬는데, 단순히 @Component를 붙이기만 하면 스프링 빈으로 등록만 하는것이다. 의존관계 주입은 어떻게 할까?

 

---

 

- 의존관계 자동 주입, @Autowired

• MemberServiceImpl, OrderServiceImpl을 보면, 모두 생성자에 @Autowired 어노테이션을 붙이고 있다. 
• 이는 생성자 호출 시 의존관계가 자동으로 주입된다는 것을 의미한다!

의존관계 자동주입

• 본 포스팅에서는 의존관계 자동 주입에 대해 깊이 있게 다루지는 않는다. 후술할 포스팅에 자세한 내용이 나올 것이다.
  지금은 @Autowired를 생성자에 붙여줌으로써 의존관계가 자동으로 주입된다는 점만 알고있으면 된다.

 

---

 

- 탐색 위치

• 모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다. 따라서 사용자의 판단에 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.

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

• basePackages를 지정해, 탐색을 시작할 최상위 패키지를 지정해주는 것이다. 해당 패키지 안에 있는 모든 요소를 탐색한다.
• basePackages = {"hello.core", "hello.service"} 처럼 여러 위치를 동시에 지정할 수 있다.
• 지정하지 않으면, @ComponentScan이 붙어있는 설정 정보 클래스의 패키지가 시작 위치가 된다.
• 권장하는 방법으로, basePackages를 따로 지정하지 않고 설정 정보 클래스를 프로젝트 최상단에 두는 방식이 있다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.
• 추가로 스프링 부트를 사용하면, 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 해당 프로젝트의 시작 루트 위치에 두는 것이 관례이다. (이 설정 안에 @ComponentScan이 들어있다)

 

---

 

- 기본 스캔 대상

• @Component : 컴포넌트 스캔에서 사용
• @Controller : 스프링 MVC 컨트롤러에서 사용
• @Service : 스프링 비지니스 로직에서 사용
• @Repository : 스프링 데이터 접근 계층에서 사용
• @Configuration : 스프링 설정 정보에서 사용
• 컨트롤러, 서비스 등의 애노테이션을 열어보면 모두 @Component를 포함하고 있다.
• 사실 애노테이션에는 상속관계라는 것이 없다. 애노테이션이 특정 애노테이션을 들고 있는 것을 인식하는 건, 자바에서 지원하는 기능은 아니고 스프링이 지원하는 기능이다.

 

---

 

- 필터

• includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
• excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.
• 아래는 활용 예제이다.

@Configuration
@ComponentScan(
            includeFilters = @Filter(type = FilterType.ANNOTATION, classes =
		MyIncludeComponent.class),
            excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
		MyExcludeComponent.class)
    )
static class ComponentFilterAppConfig {
}

• 참고로 @Component면 충분하기 때문에, includeFilters를 사용할 일은 거의 없다. 제외시키는 상황은 간혹 사용하지만 많지는 않다.
• 마찬가지로 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정을 최대한 맞추어 사용하는 것을 권장한다.
  
  

---

 

- 중복 빈 등록과 충돌

• 자동 빈 등록 vs 자동 빈 등록 : ConflictingBeanDefinitionException 예외 발생
• 수동 빈 등록 vs 자동 빈 등록 : 수동 빈이 자동 빈을 오버라이딩 해버리면서 우선권을 가진다. 이런 상황이 발생하면 오버라이딩 됐다고 친절하게 로그가 남는다.
• 사실 수동 빈의 오버라이딩한 등록을 의도해서 사용할 수 도 있겠지만, 보통은 여러 설정 정보가 꼬여서 이런 결과가 만들어지는 것이 대부분이다. 이런 경우 정말 잡기 어려운 버그가 만들어진다.
• 그래서 최근 스프링 부트는 수동 빈 등록과 자동 빈 등록의 충돌이 발생하면 오류가 발생하도록 기본 값을 바꿨다.

 

---

 

- 정리

• 기존 설정파일 AppConfig에서는 직접 의존관계를 명시하면서 빈을 등록해줬다.
• @ComponentScan과 @Component를 통해 스프링 빈을 자동으로 등록할 수 있었다.
• 의존관계를 자동으로 주입해주기 위해 생성자에 @Autowired를 붙여줬다.

 

 

 

출처 : 인프런, 김영한의 스프링 핵심 원리 - 기본편