[스프링 기본] 컴포넌트 스캔

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

지금까지는 스프링 빈 등록할 때 @Bean이나 <bean'> 등을 통해서 등록했음

→ 등록할게 수십, 수백개가되면 등록하기 귀찮고 설정정보도 커지고 누락 발생

→ 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능 제공

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

package hello.core;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

@Configuration
@ComponentScan(
        // 설정 정보는 컴포넌트 스캔 대상에서 제외
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {

}

@ComponentScan을 설정정보에 붙여주면됨

• 기존 AppConfig와 다르게 @Bean으로 등록한 클래스가 하나도 없다

excludeFilters를 이용해서 @Configuration이 붙은 설정정보들을 제외해줌 → 일반적으로 잘 사용하진 않지만, 현재는 기존 코드를 최대한 유지하기 위해서 이렇게

MemoryMemberRepository, MemberServiceImpl, RateDiscountPolicy, OrderServiceImple 클래스에 @Component를 추가해줌

클래스 안의 생성자에는 @Autowired를 붙여줌으로서 빈에서 자동으로 맞는 객체를 찾아등록하도록해줌

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

멤버서비스 -> 멤버서비스impl(멤버리포지토리)
오더서비스 -> 오더서비스impl(멤버리포지토리, 할인정책)
할인 정책 -> Rate할인정책
멤버리포지토리 -> 메모리멤버리포지토리

이 관계에서 뒤에것들에만 @Component

public class AutoAppConfigTest {

    @Test
    void basicScan(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        Assertions.assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

위 테스트가 잘 동작하는 것을 알 수 있음

1. @ComponentScan

@ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈에 등록

이때 스프링 빈 이름은 클래스명을 사용하되 맨 앞글자만 소문자

이름을 지정하고 싶으면 @Component(”memberService2”)이런식으로 하면됨

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

생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링빈을 찾아서 주입

이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입

• getBean(MemberRepository.class)와 동일하다고 이해하면됨

탐색 위치와 기본 스캔 대상

탐색할 패키지의 시작 위치 지정

package hello.core;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

@Configuration
@ComponentScan(
        // member패키지 하위 패키지 탐색
        basePackages = "hello.core.member",
        // 설정 정보는 컴포넌트 스캔 대상에서 제외
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {

}

basePackages : 탐색할 패키지의 시작 위치를 지정. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다

• basePackages = {”hello.core”, “hello.service”}로 여러개 지정도 가능

디폴트는 @ComponentScan이 붙은 설정 정보 클래스(AppConfig.class)의 패키지가 시작위치가됨 → 현재 경우 hello.core 패키지가 디폴트

권장 방식

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

ex) 프로젝트 구조

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

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

스프링 부트 사용시 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. 그리고 이 설정 안에 @ComponentScan이 들어있다. → 따로 @ComponentScan이 필요 X

@SpringBootApplication
public class CoreApplication {

	public static void main(String[] args) {
		SpringApplication.run(CoreApplication.class, args);
	}

}

컴포넌트 스캔 기본 대상

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

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

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

해당 클래스의 소스코드를 보면 @Component를 포함하고 있는 것을 알 수 있음

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

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

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

+) useDefaultFilters 옵션은 기본으로켜저있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다.

필터

package hello.core.scan.filter;

import java.lang.annotation.*;

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

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

추가하지 않을 애노테이션도 동일하게하고 MyExcludeComponent 인터페이스로 만들어준다

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}

컴포넌트 스캔 대상에 추가할 클래스 → @MyIncludeComponent 적용

제외할 클래스 BeanB도 동일하게 만들고 → @MyExcludeComponent 적용

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
        BeanA beanA = ac.getBean("beanA", BeanA.class);
        Assertions.assertThat(beanA).isNotNull();

        //ac.getBean("beanB", BeanB.class);
        org.junit.jupiter.api.Assertions.assertThrows(
                NoSuchBeanDefinitionException.class,
                () -> ac.getBean("beanB", BeanB.class));
    }

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

    }
}

BeanA가 스프링 빈에 등록되고, BeanB는 등록안된 것 확인 가능

FilterType 옵션
FilterType은 5가지 옵션이 있다.

ANNOTATION: 기본값, 애노테이션을 인식해서 동작한다.

• ex) org.example.SomeAnnotation

ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.

• ex) org.example.SomeClass

  @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = BeanA.class)
     }

  이런식으로 A도 제외가능
  

ASPECTJ: AspectJ 패턴 사용

• ex) org.example..*Service+

REGEX: 정규 표현식

• ex) org\.example\.Default.*

CUSTOM: TypeFilter 이라는 인터페이스를 구현해서 처리

• ex) org.example.MyTypeFilter

크게 많이 사용하진 않는다

중복 등록과 충돌

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

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

   스프링에서 오류 발생시킴 → ConflictingBeanDefinitionException 예외 발생

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

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

   수동으로 등록한 빈

   이 경우 수동 빈 등록이 우선권을 가짐 → 수동 빈이 자동빈을 오버라이딩해버림

   개발자가 이런 결과를 의도했다면 수동이 우선권을 가지는 것이 좋지만 개발자가 의도하지 않은 경우가 대부분 → 이때 잡기 어려운 버그가 만들어짐!

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

   → @SpringBootApplication애노테이션이 있는 CoreApplication을 실행해보면 오류남

---

인프런 스프링 핵심 원리 기본편 - 김영한 강의를 듣고 정리한 내용입니다