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

지금까지 스프링 빈을 등록할 때는 설정 정보에 직접 등록할 스프링 빈을 나열했다. 하지만, 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고 누락하는 문제도 발생한다.

그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다. AppConfig가 없는데 어떻게 등록한다는 거지…? 또, 의존관계도 자동으로 주입하는 @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 {
	// @Bean으로 등록된게 아무것도 없고 텅텅 비었다...
}

컴포넌트 스캔을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 된다. 이러면 @Component 애노테이션이 붙은 클래스들을 찾아서 자동으로 스프링 빈으로 등록해준다. 그리고 @ComponentScan을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에 excludeFilters 속성을 사용해서 있는데 위의 코드에서만 기존 AppConfig 코드와의 충돌을 피하도록 처리했다.

 

아래 코드들에 @Component 하나만 붙여주면 끝이다. @Bean 등록할 필요가 없는 것이다.

// MemoryMemberRepository.java
package hello.core.member;

import org.springframework.stereotype.Component;

import java.util.HashMap;
import java.util.Map;

@Component
public class MemoryMemberRepository implements MemberRepository {

    private static Map<Long, Member> store = new ConcurrentHashMap<>();

    @Override
    public void save(Member member) {
        store.put(member.getId(), member);
    }

    @Override
    public Member findById(Long memberId) {
        return store.get(memberId);
    }
}

// RateDiscountPolicy.java
package hello.core.discount;

import hello.core.member.Grade;
import hello.core.member.Member;
import org.springframework.stereotype.Component;

@Component
public class RateDiscountPolicy implements DiscountPolicy {

    private int discountPercent = 10;

    @Override
    public int discount(Member member, int price) {
        if (member.getGrade() == Grade.VIP) {
            return price * discountPercent / 100;
        } else {
            return 0;
        }
    }
}

 

하지만, MemberServiceImpl에서는 @Component 애노테이션뿐만 아니라 한 가지를 더 해줘야 한다. 생각해보면, 내가 스프링 빈으로 등록하는게 아닌, 자동으로 스프링 빈으로 등록되는 것이다. 그럼 의존관계 주입은 어떻게 하지?

기존의 AppConfig에서 memberService는 memberRepository로 의존관계 주입한다고 명시할 수라도 있었지, 지금 AutoAppConfig는 아무 것도 없는데?

그래서 자동 의존관계 주입이 필요한 것이다. 의존관계를 자동으로 주입해주는 @Autowired라는 기능을 생성자에 붙여주면 스프링이 MemberRepository 타입에 맞는 애를 찾아와서 자동으로 주입해준다. 컴포넌트 스캔과 @Autowired는 세트로 움직인다.

 

다시 한번 정리하자. 컴포넌트 스캔을 쓰게 되면 내 스프링 빈이 자동으로 등록되는데 의존관계를 수동으로 설정할 방법이 없네? 이를 위해 @Autowired를 쓰면 스프링이 생성자의 타입에 맞는 스프링 빈을 주입해준다는 것이다.

// MemberServiceImpl.java에 @Component, @Autowired 추가
package hello.core.member;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component  // 자동으로 MemberServiceImpl 클래스를 스프링 빈 등록
public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository;

	// 의존관계 자동 주입
    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

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

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

    // 테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

위의 코드처럼 생성자 위에 @Autowired를 붙여주면 스프링이 MemberServiceImpl을 생성할 때 생성자로 넘어오는 인자의 타입을 보고, 스프링 컨테이너를 뒤져서 빈으로 등록되어 있는 MemoryMemberRepository를 주입해 준다. 이처럼 @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 클래스를 넘겨서 주도록 하자. 실행해보면 기존과 같이 잘 동작하는 것을 확인할 수 있다.

 

컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 그림으로 살펴보자.

1. @ComponentScan

@ComponentScan은 @Component가 붙은 모든 클래스를 뒤져서 스프링 빈으로 등록한다.

 

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

생성자에 @Autowired를 지정하면, MemberServiceImpl을 생성하면서 스프링이 스프링 컨테이너에 있는 MemberRepository 타입과 같은 것이 있는지 뒤진다. 그래서 memoryMemberRepository를 찾아서 주입한다. 근데 같은 타입이 여러 개면 우째 되는거지…?

• getBean(MemberRepository.class)와 동일하다고 이해하면 된다.
• 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.

---

🕵🏻‍♂️ 탐색 위치와 기본 스캔 대상

모든 자바 클래스를 전부 컴포넌트 스캔하면 시간이 오래 걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.

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

...

• basePackages: 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다. (여러 시작 위치를 지정할 수도 있음)
• basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 위로 지정한다.
• 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

👍 권장하는 방법

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

예를 들어, 프로젝트가 아래와 같은 구조로 되어 있다고 해보자.

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

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

이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다. 그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다. 참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. (그리고 이 설정 안에 바로 @ComponentScan이 들어 있다)

 

🔍 컴포넌트 스캔 대상

: 컴포넌트 스캔은 @Component 뿐만 아니라 아래와 같은 애노테이션이 붙은 클래스들도 그 대상이 된다. 그리고 아래 애노테이션은 부가적인 기능을 제공한다.

• @Controller: 스프링 MVC 컨트롤러로 인식
• @Service: 스프링 비즈니스 로직에서 사용된다. 별다른 처리는 없지만 개발자들이 핵심 비즈니스 로직이 해당 애노테이션이 붙은 클래스에 존재할 것이라고 인식하는데 도움이 된다.
• @Repository: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
• @Configuration: 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

---

😀 필터

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

package hello.core.scan.filter;

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

package hello.core.scan.filter;

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

 

이제 테스트를 작성해보자.

// ComponentFilterAppConfigTest.java
package hello.core.scan.filter;

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

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

        org.junit.jupiter.api.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 {}
}

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

 

<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

 

<참고>

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

---

💥 중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까?

 

1. 자동 빈 등록 vs 자동 빈 등록 (발생하지 않는다고 보면 됨)

컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 ConflictingBeanDefinitionException 예외를 터뜨린다.

 

2. 수동 빈 등록 vs 자동 빈 등록

만약 수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 어떻게 될까?

// MemoryMemberRepository.java

@Component
public class MemoryMemberRepository implements MemberRepository {}

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

@Configuration
@ComponentScan(
        basePackages = "hello.core.member", 
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {

	// 이름을 memoryMemberRepository로 똑같이 지정해서 스프링 빈으로 등록해보자.
    @Bean(name="memoryMemberRepository")
    MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
}

 

테스트 코드를 돌려보면…

// AutoAppConfigTest.java

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

응? 지금 이름이 memoryMemberRepository로 같은 빈이 2개가 있는데 왜 통과되는거지?

이 경우 "수동 빈 등록이 우선권을 가진다." 다시 말해, 수동 빈이 자동 빈을 오버라이딩 해버리는 것이다.

물론 개발자가 의도적으로 이런 결과를 기대했다면, 자동보다는 수동이 우선권을 가지는 것이 좋다. 하지만 현실은 여러 설정들이 꼬여서 이런 결과가 발생하는 경우가 대부분이다. 그러면 정말 해결하기 어려운 버그가 만들어진다... 그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌이 나면 오류가 발생시키고 튕겨 버리도록 바꼈다.