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

[YuDeokRin]

컴포넌트 스캔

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

• 지금까지 해온 방식은 스프링 빈을 등록할 때 자바코드의 @bean이나 XML의 을 통해서 설정 정보에 직접(수동) 등록할 스프링 빈을 나열했다.

• 스프링 빈을 등록할 때 등록해야할 스프링 빈이 적으면 수동으로 할 수 있겠지만. 실무에가면 빈이 엄청 많기 때문에 일일이 등록하기 힘들고 귀찮다.

• 앞서 말한 방법의 대안으로 나온 것은 스프링 정보 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능이 생겼다. 그리고 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다.

➡️코드로 컴포넌트 스캔과 의존관계 자동주입에 대해서 알아보자.

• AutoAppConfig.java

package hello.core;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.FilterType;
 import static org.springframework.context.annotation.ComponentScan.*;
 
 
 @Configuration
 @ComponentScan(
         excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class))

 public class AutoAppConfig {
 
 }

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

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

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

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

➡️MemoryMemberRepository @component 추가

@Component
public class MemoryMemberRepository implements MemberRepository {}

➡️RateDiscountPolicy @component 추가

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

➡️MemberServiceImpl @component, @Autowired 추가

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

• 이전에 AppConfig에서는 @bean으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 이제는 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 함.

• @Autowired는 의존관계를 자동으로 주입해준다.

• AutoAppConfigTes.java

  • AnnotationConfigApplicationContext를 사용하는 것은 기존과 동일하다.
  • 설정 정보로 AutoAppConfig 클래스를 넘겨준다.
  • 실행해보면 기존과 같이 잘 동작하는 것을 확인할 수 있다.

package hello.core.scan;
 import hello.core.AutoAppConfig;
 import hello.core.member.MemberService;
 import org.junit.jupiter.api.Test;
 import org.springframework.context.ApplicationContext;
 import
 org.springframework.context.annotation.AnnotationConfigApplicationContext;
 import static org.assertj.core.api.Assertions.*;
 
 
public class AutoAppConfigTest {
     @Test
     void basicScan() {
         ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
		     MemberService memberService = ac.getBean(MemberService.class);
         assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

Tip. 로그를 잘 보면 컴포넌트 스캔이 잘 동작하는 것을 확인할 수 있다.

ClassPathBeanDefinitionScanner - Identified candidate component class:
 .. RateDiscountPolicy.class
 .. MemberServiceImpl.class
 .. MemoryMemberRepository.class
 .. OrderServiceImpl.class

✅컴포넌트 스캔과 자동 의존관계 그림으로 이해하기

1. @ComponentScan : 컴포넌트 스캔
   1. @componentscan은 @component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
   2. 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
      1. 빈 이름 기본 전략 : MemberServiceImpl 클래스 → memberServiceImpl
      2. 빈 이름 직접 지정 : 스프링 빈의 이름을 직접 지정하고 싶으면 @component(”memberService2”)이런식으로 이름을 부여하면 된다.

1. @Autowired 의존관계 자동 주입
   1. 생성자에 @Autowired를 지정하면 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
      1. 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
         1. getBean(MemberRepository.class)와 동일하다고 보면된다.

---

2️⃣ 탐색 위치와 기본 스캔 대상

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

@CompnentScan(
	basePackage = "hhello.core",

}

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

✅권장하는 방법

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

com.hello ``

com.hello.serivce

com.hello.repository`

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

➡️컴포넌트 스캔 기본 대상

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

• @component : 컴포넌트 스캔에서 사용

• @controller : 스프링 MVC 컨트롤러에서 사용

• @service : 스프링 비즈니스 로직에서 사용

• @repository : 스프링 데이터 접근 계층에서 사용

• @configuration : 스프링 설정 정보에서 사용

• 해당 클래스의 소스 코드를 보면 @component를 포함하고 있는 것을 알 수 있다.

 @Component
 public @interface Controller {
 
 }
 
 @Component
 public @interface Service {
 
 }
 
 @Component
 public @interface Configuration {

 }

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

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

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

---

3️⃣ 필터

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

package hello.core.scan.filter;
 import java.lang.annotation.*;
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 public @interface MyIncludeComponent {
 }

 package hello.core.scan.filter;
 import java.lang.annotation.*;
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 public @interface MyExcludeComponent {
 }

 package hello.core.scan.filter;
 @MyIncludeComponent
 public class BeanA {
}

package hello.core.scan.filter;
 @MyExcludeComponent
 public class BeanB {
}

public class ComponentFilterAppConfigTest {
     @Test
     void filterScan() {
         ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
         BeanA beanA = ac.getBean("beanA", BeanA.class);
         assertThat(beanA).isNotNull();
         Assertions.assertThrows(
                 NoSuchBeanDefinitionException.class,
                 () -> ac.getBean("beanB", BeanB.class));
			}
     
     @Configuration
     @ComponentScan (
          includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
          excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
    )
    
    
    static class ComponentFilterAppConfig {
    }
}

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

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

참고. @Component 면 충분하기 때문에, includeFilters 를 사용할 일은 거의 없다. excludeFilters 는
여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.
특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다.

---

4️⃣ 중복 등록과 충돌

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

다음 두가지 상황이 있다.

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

✅자동 빈 등록 vs 자동 빈 등록

• 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.
  • ConflictingBeanDefinitionException 예외 발생

✅ 수동 빈 등록 vs 자동 빈 등록

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

@Component
 public class MemoryMemberRepository implements MemberRepository {
 }

@Configuration
@ComponentScan(
         excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
 Configuration.class)
 )
 public class AutoAppConfig {
     
     @Bean(name = "memoryMemberRepository")
     public MemberRepository memberRepository() {
         return new MemoryMemberRepository();
     }
     
}

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