(스프링 기본) 6. 컴포넌트 스캔

 

 

이 글은 김영한 님의 스프링 핵심 원리 - 기본편 강좌 수강 후 정리한 글입니다.

https://www.inflearn.com/course/스프링-핵심-원리-기본편/dashboard

스프링 핵심 원리 - 기본편 - 인프런 | 강의

 

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

지금까지는 자바 코드의 @Bean을 활용하여 설정 정보에 직접 등록할 빈을 나열하였다. 만약 빈의 개수가 매우 많아지면 이 작업은 너무 귀찮고, 누락의 위험성 또한 존재한다.

그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔을 제공한다. 또 의존 관계도 자동으로 주입해주는 @Autowired라는 기능도 제공한다.

 

● AutoAppConfig.java

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으로 등록한 클래스가 하나도 없다.

※ 컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 그래서 excludeFilters를 이용해서 설정 정보는 컴포넌트 스캔 대상에서 제외했다.

 

@ComponentScan은 이름 그대로 @Compnent가 붙은 클래스를 스캔해서 이를 스프링 빈으로 등록한다.

 

● 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는 의존관계를 자동으로 주입해준다.

 

● OrderServiceImpl @Component, @Autowired 추가

@Component
public class OrderServiceImpl implements OrderService {
	private final MemberRepository memberRepository;
	private final DiscountPolicy discountPolicy;
	@Autowired
	public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
		this.memberRepository = memberRepository;
		this.discountPolicy = discountPolicy;
	}
}

 

@Autowired를 사용하면 생성자에서 여러 의존 관계도 한 번에 주입받을 수 있다.

 

● AutoAppConfigTest.java

package hello.core.scan;

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

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

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

 

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

 

● @ComponentScan 

 

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

만약 직접 이름을 지정하고 싶다면, @Component("memberService2") 이런 식으로 이름을 부여하면 된다. 

 

● @Autowired 의존관계 자동 주입

 

생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다. getBean(MemberRepository.class)와 같은 방식으로 타입이 같은 빈을 찾아 주입한다고 이해하면 된다.

 

생성자에 파라미터가 여러 개 더라도 다 찾아서 자동으로 주입한다.

 

탐색 위치와 기본 스캔 대상

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

모든 자바 클래스를 다 컴포넌트 스캔하기엔 시간이 너무 오래 걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 한다.

@ComponentScan(
	basePackages = "hello.core",
}

 

1. basePackages : 탐색을 시작할 위치를 지정한다. 이 패키지를 포함하여 하위 패키지까지 모두 탐색한다.

basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도
있다.

2. basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다. 만약 지정하지 않으면 @Component가 붙은 설정 정보의 패키지가 시작 위치가 된다.

 

● 권장하는 방법

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

예를 들어서 프로젝트가 다음과 같이 구조가 되어 있으면

com.hello
com.hello.serivce
com.hello.repository

 

프로젝트의 시작 루트인 com.hello에 AppConfig와 같은 메인 설정 정보를 두고, @ComponentScan을 붙이고, basePackage 지정은 생략한다. 이렇게 하면 com.hello를 포함한 하위 패키지도 모두 자동으로 컴포넌트 대상이 된다. 참고로 스프링 부트를 사용할 때 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다.

 

● 컴포넌트 스캔 기본 대상

컴포넌트 스캔의 대상에는 @Component 뿐만 아니라, 다음의 대상들도 추가로 포함된다.

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

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

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

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

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

 

다음 애노테이션은 컴포넌트 스캔의 용도뿐만 아니라 부가 기능을 수행한다.
@Controller : 스프링 MVC 컨트롤러로 인식
@Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
@Configuration : 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가
처리를 한다.
@Service : 사실 @Service는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에
있겠구나라고 비즈니스 계층을 인식하는데 도움이 된다.

 

필터

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.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를 추가해서 BeanB는 스프링 빈에 등록되지 않는다.

 

● FilterType 옵션

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

중복 등록과 충돌

● 자동 빈 등록 vs 자동 빈 등록

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

 

● 수동 빈 등록 vs 자동 빈 등록

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;

@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();
    }
}

 

위와 같이 같은 이름인 memoryMemberRepository를 갖는 빈을 수동으로 등록하면 이 수동 빈이 자동 빈을 오버라이딩해버린다.

Overriding bean definition for bean 'memoryMemberRepository' with a different
definition: replacing

 

개발자가 의도적으로 이런 결과를 기대했다면, 자동보다는 수동이 우선권을 가지는 것이 좋다. 하지만 현실적으로 의도적으로 설정했다기보다는 여러 설정들이 꼬여서 이런 결과가 나오는 것이 대부분이다.

이렇게 되면 가장 잡기 어려운 버그인, 애매한 버그가 발생한다.

Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true

 

그래서 이런 애매한 버그가 발생하는 것을 막기 위해서 최근 스프링 부트는 수동 빈과 자동 빈 등록 충돌이 발생하면 위와 같이 오류가 발생하도록 기본값을 변경하였다.