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

JYC·2024년 1월 13일

[SPRING STUDY]

목록 보기

14/39

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

스프링은 컴포넌트 스캔이라는 자동으로 스프링 빈을 등록해주는 기능을 제공한다.

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

새로 AutoAppConfig 파일을 만들어준다.

@Configuration
@ComponentScan(
        //basePackages = "hello.core.member", //시작 위치 지정
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
        //다른 파일들과의 충돌 방지
)
public class AutoAppConfig {
}

이제 각각 MemoryMemberRepository / RateDiscountPolicy / MemberServiceImpl / OrderServiceImpl에 @Component를 붙이고, 의존 관계를 위한 @Autowired도 붙여준다.

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

테스트를 위한 테스트 코드도 작성해준다.

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

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

잘 되는 것을 확인할 수 있다.

강의에선 이를 그림으로 설명해준다.

@ComponentScan

@ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

예) MemberServiceImpl -> memberServiceImpl

탐색 위치와 기본 스캔 대상

@ComponentScan의 시작 위치를 지정해줄 수 있다.

@ComponentScan(
	basePackages = "원하는 파일위치",
    ...
}

만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

컴포넌트 스캔 기본 대상

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

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

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

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

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

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

필터

includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.

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

MyIncludeComponent 파일을 만들어주자. (자바 Annotation 파일)

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

테스트를 위한 클래스 파일도 만들어준다.

@MyIncludeComponent
public class BeanA {
}

테스트 코드를 추가해준다.

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

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

    }
}

잘 실행되는 것을 확인할 수 있다.
적힌 코드에선 includeFilters만 적었지만, excludeFilters도 테스트해보면 잘 돌아간다.

FilterType 옵션

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

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

ASPECTJ: AspectJ 패턴 사용.

REGEX: 정규 표현식.

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