[스프링 핵심 원리 - 기본편] 컴포넌트 스캔, 의존관계 주입 방법

강신현·2022년 8월 18일

Spring

[인프런/김영한 로드맵 1] 스프링 완전 정복

목록 보기

14/31

✅ @ComponentScan ✅ @Bean ✅ @Component ✅ @Autowired

💡 컴포넌트 스캔

1. 수동 스프링 빈 등록

@Bean 으로 직접 설정 정보 작성, 의존관계도 직접 명시

AppConfig

@Configuration
public class AppConfig {

    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(
                memberRepository(),
                discountPolicy());
    }

    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }

    @Bean
    public DiscountPolicy discountPolicy() {
        return new RateDiscountPolicy();
    }
}

2. 자동 스프링 빈 등록 (컴포넌트 스캔)

@ComponentScan 을 설정 정보에 붙여주면 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.

AutoAppConfig

@Configuration
@ComponentScan(
        // 기존에 사용했던 AppConfig 제외
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {


}

👉 이제는 AppConfig 에서 처럼 설정 정보(@Bean) 자체가 없기 때문에
의존관계 주입도 클래스 안에서 자동으로 주입 하기위해 생성자에 @Autowired 을 붙여줘야 한다.

MemberServiceImpl

@Component
public class MemberServiceImpl implements MemberService{

    private final MemberRepository memberRepository;

    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    @Override
    public void join(Member member){
        memberRepository.save(member);
    }

    @Override
    public Member findMember(Long memberId){
        return memberRepository.findById(memberId);
    }
}

👉 @ComponentScan에 패키지 위치(basePackages)를 지정하여 특정 패키지의 하위 클래스들을 모두 스캔하는 방법도 있지만,
강사님은 설정 정보 클래스(AutoAppConfig)의 위치를 프로젝트 최상단에 두어 모두 스캔하는 방법을 추천하신다.
최근 스프링 부트도 이 방법을 기본으로 제공한다고 한다.

👉 참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례인데
@SpringBootApplication 안에 바로 @ComponentScan 이 들어있으므로 스프링 빈 등록을 해줄 필요가 없다.

💡 자동 vs 수동 빈 등록

애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.

1. 업무 로직 빈

웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리등이 모두 업무 로직이다.
보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있다.

👉 자동 빈 등록 을 적극 사용하는 것이 좋다
보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉬워짐

2. 기술 지원 빈

기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다.
데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.
업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다.
기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다.

👉 가급적 수동 빈 등록 을 사용해서 명확하게 드러내는 것이 좋다.

💡 동작 과정

1. @ComponentScan

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

빈 이름 기본 전략: 클래스명을 사용하되 맨 앞글자만 소문자를 사용 (MemberServiceImpl -> memberServiceImpl)
빈 이름 직접 지정: @Component("memberService2")

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

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

컴포넌트 스캔 기본 대상

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

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

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

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

💡 필터

스프링 부트는 컴포넌트 스캔을 기본으로 제공하기 때문에 굳이 쓸 필요는 없어 보이지만 이런게 있다는 것만 알아두자

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

}

@MyIncludeComponent
public class BeanA {
}

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

}

@MyExcludeComponent
public class BeanB {
}

Test

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 = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
            excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
    )
    static class ComponentFilterAppConfig {

    }
}