[Spring] 기본편 #6 - 컴포넌트 스캔

📌컴포넌트 스캔과 의존관계 자동 주입

• 앞서 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean>을 이용해 설정 정보에 직접 여러 개의 스프링 빈들을 등록했다
• 그러나 등록해야 할 스프링 빈이 많이질수록 일일히 등록하기 힘들어진다
• 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다
• 의존관계를 자동으로 주입하는 @Autowired라는 기능도 제공한다

📝새로운 설정 정보(AutoAppConfig.java)

package Hello.core;


import Hello.core.member.MemberRepository;
import Hello.core.member.MemoryMemberRepository;
import org.springframework.context.annotation.Bean;
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(
        basePackages = "Hello.core.member",
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)

// @ComponentScan은 @Component가 붙은 것들을 모두 빈으로 자동 등록
// filter type을 애노테이션으로 지정, 제외할 애노테이션은 Configuration -> @Configuration에는 @Component가 내장돼있음,
// AppConfig와 TestConfig에도 @Configuration이 있기 때문에 수동으로 등록한 @Bean들이 등록되는 것을 피하기 위해 제외
public class AutoAppConfig {

    @Bean(name = "memoryMemberRepository")
    MemberRepository memberRepository(){
        return new MemoryMemberRepository();
    }
}

• 컴포넌트 스캔을 사용하려면 @ComponentScan을 설정 정보에 붙여준다
• @Bean으로 직접 빈들을 등록해줄 필요가 없다!

참고

@Configuration 소스 코드를 열어보면 @Component가 존재하기 때문에, 컴포넌트 스캔을 사용시 @Configuration이 붙은 설정 정보인 AppConfig도 자동으로 등록된다. 그래서 excludeFilters 옵션을 사용해 AppConfig를 스캔 대상에서 제외해줬다.

✅컴포넌트와 의존관계 등록

인터페이스가 아니고 구현체인 MemoryMemberRepository, RateDiscountPolicy, MemberServiceImpl, OrderServiceImpl의 상단에 @Component를 추가해 컴포넌트로 스캔될 수 있도록 해준다.
여기서 MemberServiceImpl, OrderServiceImpl의 생성자에는 의존관계 자동 주입을 위해 @Autowired도 추가해준다.

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

💻AutoAppConfig 테스트

package Hello.core.scan;

import Hello.core.AutoAppConfig;
import Hello.core.member.MemberService;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import static org.assertj.core.api.Assertions.*;

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

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


    }
}

• AnnotationConfigApplicationContext를 사용하는 것은 기존과 동일하다
• 설정 정보로 AutoAppConfig 클래스를 넘겨준다
• 로그를 보면 컴포넌트 스캔과 의존관계 주입이 잘 됐음을 확인할 수 있다

컴포넌트 스캔과 의존관계 주입의 동작 과정

1. @ComponentScan

• @ComponentScan은 @Component가 붙은 클래스를 스프링 빈으로 등록한다
• 빈 이름
  • 기본 설정 값: 클래스명을 사용하고, 맨 앞글자만 소문자를 사용한다,
    ex) : MemberServiceImpl -> memberServiceImpl
  • 직접 지정 : @Component("memberService2) 이런식으로 이름 부여

2. @Autowired

• 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다
• 이때 기본 조회 전략은 타입(인터페이스)이 같은 빈을 찾아서 주입한다
  • getBean(MemberRepository.class)와 동일하다
  • 더 자세한 내용은 뒤에서 설명할 것이다

• 생성자 파라미터가 많아도 다 찾아서 자동으로 주입한다

📌탐색 위치와 기본 스캔 대상

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

@ComponentScan(
        basePackages = "Hello.core",
)

• 컴포넌트 스캔 대상이 모든 자바 클래스가 되면 시간이 매우 오래 걸리기 때문에, 시작 위치를 지정할 수 있다
• basePackages를 이용하는데, basePackages = {"Hello.core", "Hello.Service"} 이렇게 여러 시작 위치를 지정할 수 있다
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다, 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다

권장하는 방법

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

예를 들어, 프로젝트가 다음과 같은 구조

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

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

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

컴포넌트 스캔 기본 대상

해당 애노테이션들의 소스코드를 보면 @Component가 포함돼있다

참고

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

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

• @Component : 컴포넌트 스캔에서 사용
• @Controller : 스프링 MVC 컨트롤러에서 사용, 스프링 MVC 컨트롤러로 인식
• @Service : 스프링 비즈니스 로직에서 사용, 핵심 비즈니스 로직이 여기 있음을 표시하는 용도
• @Repository : 스프링 데이터 접근 계층으로 인식, 데이터 계층의 예외를 스프링 예외로 변환
• @Configuration : 스프링이 설정 정보로 인식, 스프링 빈이 싱글톤을 유지하도록 추가 처리

📌필터

• 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 {

}

💻설정 정보와 전체 테스트 코드

package Hello.core.scan.filter;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;
import static org.springframework.context.annotation.ComponentScan.*;

public class ComponentFilterAppConfigTest {

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

        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{

    }
}

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

FilterType 옵션

• 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

✅예제

예를 들어 BeanA도 빼고 싶으면 다음과 같이 추가하면 된다

@ComponentScan(
	includeFilters = {
		@Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
 },
	excludeFilters = {
		@Filter(type = FilterType.ANNOTATION, classes =
MyExcludeComponent.class),
		@Filter(type = FilterType.ASSIGNABLE_TYPE, classes = BeanA.class) // 여기 주목!
 }
)

beanA가 등록되지 않아 예상했듯이 에러가 뜬다

참고

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

📌중복 등록과 충돌

자동 빈 등록 vs 자동 빈 등록

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

수동 빈 등록 vs 자동 빈 등록

public class MemoryMemberRepository implements MemberRepository {}

@Configuration
@ComponentScan(
//        basePackages = "Hello.core",
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)

// @ComponentScan은 @Component가 붙은 것들을 모두 빈으로 자동 등록
// filter type을 애노테이션으로 지정, 제외할 애노테이션은 Configuration -> @Configuration에는 @Component가 내장돼있음,
// AppConfig와 TestConfig에도 @Configuration이 있기 때문에 수동으로 등록한 @Bean들이 등록되는 것을 피하기 위해 제외
public class AutoAppConfig {

    @Bean(name = "memoryMemberRepository")
    MemberRepository memberRepository(){
        return new MemoryMemberRepository();
    }
}

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

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


    }
}

• 수동 빈이 우선권을 가져 수동 빈이 자동 빈을 오버라이딩한다
• 개발자가 의도적으로 이런 결과를 기대했다면, 이 설정이 좋겠지만 대부분은 의도했다기보다는 여러 설정이 꼬여서 이런 결과가 만들어진다
• 그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 바꾸었다

수동 빈과 자동 빈 등록 충돌시 스프링 부트 에러

package Hello.core;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class CoreApplication {

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

}

• CoreApplication을 실행하면 다음과 같이 수동 빈과 자동 빈의 충돌로 오류가 뜨고, 오버라이딩을 허용하려면 spring.main.allow-bean-definition-overriding=true과 같이 옵션을 세팅하라는 로그가 뜬다
• 옵션 세팅은 main.resource.application.properties에서 설정한다

spring.main.allow-bean-definition-overriding=true로 설정해주면 다음과 같이 잘 실행이 된다