Spring 강의/springMVC

springMVC 기본 - (6) 컴포넌트 스캔

lxexjx 2022. 3. 11. 23:32

[컴포넌트 스캔] 

스프링 빈을 자동으로 끌어올려, @Component어노테이션 붙은 클래스를 다 찾아서 자동으로 스프링 빈 등록

자바 코드의 @Bean이나 XML의 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열.

등록해야 할 스프링 빈이 수십, 수백개가 되면 귀찮.

스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공, 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공

 

 

 

<AutoAppConfig>(AppConfig랑 똑같은 건데 그냥 공부용으로 남겨놔)

@Configuration
@ComponentScan(
        excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class))	
        //자동 등록중 뺄거-Configuration이 어노테이션 붙은 애는 뺄거야
        //(AppConfig.java이거-왜냐면 수동으로 등록한거니까)
public class AutoAppConfig {

}

 

 

<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;
    }
}

각 클래스가 컴포넌트 스캔 대상이 되도록 어노테이션 추가

copmponent스탠은 bean이 자동으로 등록되는데 의존관계 설정할 수 있는 방법이 없어서 @Autowired 자동의존관계주입을 사용함

 

Autowired : 자동의존관계 주입

AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시

@Autowired
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy
            discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
}

생성자에 붙여주면 MemberRepository에 맞는 스프링빈을 찾아와서의존 관계주입을 자동으로 연결해줘

(약간 ac.getBean(MemberRepository.class)같은 느낌)

@Component는 자동으로 매핑은 되는데 의존관계를 설정할수 있는 방법이 없어.수동으로

 

 

<AutoAppConfigTest> - 설정 정보로 AutoAppConfig 클래스를 넘겨줌.

public class AutoAppConfigTest {
    @Test
    void basicScan() {
    
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
       
        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

 

 

 

1.@ComponentScan이 붙어있으면 스프링 컨테이너가 클래스 다 뒤져서 @Component 붙은 애를 스프링 빈으로 자동으로 등록함.  스프링 빈의 이름은 클래스명 사용.

 

2.생성자에 @Autowired가 있으면 생성자를 생성하면서 스프링이 컨테이너에 있는 MemberRepository와 같은 타입이 있는 지 뒤져서 memeporyRepository를 주입.

 

 


 

[탐색 위치와 기본 스캔 대상]

 

basePackages : 컴포넌트 스캔의 대상. 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색.  지정하지 않으면 @ComponentScan을 붙은 설정정보클레스의 패키지 모두 클래스부터(core~)다 뒤져

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

@SpringBootApplication : 스프링 부트를 사용하면 스프링 부트 시작 정보인 @SpringBootApplication 를 넣어줌. 

"해당 프로젝트부터 스프링 부트를 사용하겠다"

 

컴포넌트 스캔의 대상&부가 기능
@Component : 컴포넌트 스캔에서 사용
@Controlller : 스프링 MVC 컨트롤러에서 사용 & 스프링 MVC 컨트롤러로 인식
@Service : 스프링 비즈니스 로직에서 사용
@Repository : 스프링 데이터 접근 계층에서 사용 & 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환
@Configuration : 스프링 설정 정보에서 사용 & 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리

 

 


 

[필터]

 

컴포넌트 스캔에 추가할 것

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

 

컴포넌트 스캔에 제외할 것

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

 

컴포넌트 스캔 대상에 추가&제외할 클래스(스프링 빈에 등록 or x)

@MyIncludeComponent
public class BeanA {
}


@MyExcludeComponent
public class BeanB {
}

 

 

<ComponentFilterAppConfigTest>

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

 

필터 옵션

ANNOTATION : 기본값, 애노테이션을 인식해서 동작. 생략가능

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

ASPECTJ: AspectJ 패턴 사용 

REGEX : 정규 표현식 

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

 

 


 

[중복 등록 & 충돌]

컴포넌트 스캔에서 같은 빈 이름을 등록하면?

1. 자동 빈 등록 vs 자동 빈 등록 : 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킴

2. 수동 빈 등록 vs 자동 빈 등록-> 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버려)