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

컴포넌트 스캔

지금까지 학습을 진행하며 작성한 코드들에서는 스프링 빈을 등록하기 위해 @Bean 어노테이션을 붙여주거나 <bean>이라는 XML 태그를 붙혀서 직접 설정 정보에 스프링 빈을 나열했다.
이전까지는 간단하게 추가할 수 있었지만, 앞으로 만들어야 할 스프링 빈이 수 백개, 많으면 어떻게 할 것인가?
직접 @Bean 어노테이션을 붙여주고 의존관계 주입을 직접해주는게 맞는 것일까? (너무 많다.🌪)
스프링에서는 이런 문제를 해결하기 위해 컴포넌트 스캔이라는 기능을 제공한다.
@ComponentScan이라는 어노테이션을 통해서 해당 기능을 사용한다.
또한 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다.

 

기존 AppConfig.java는 과거 코드와 테스트를 유지하기 위해 남겨두고, 새로운 AutoAppConfig를 만들자.

main/../hello.core/AutoAppConfig

package hello.core;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

// 컴포넌트 스캔을 사용하면 `@Configuration` 이 붙은 설정 정보도 자동으로 등록되기 때문에, `AppConfig`, `TestConfig` 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 그래서 `excluderFilters`를 이용해서 설정 정보는 컴포넌트 스캔 대상에서 제외했다.
// 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해 이 방법을 사용했다.


// `@Configuration`이 컴포넌트 스캔의 대상이 된 이유도 `@Configuration` 소스코드를 열어보면 `@Component` 애노테이션이 붙어있기 때문이다.

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
    
}

• 해당 @ComponentScan 은 @Component 어노테이션이 붙은 클래스를 스캔해 스프링 빈으로 등록한다.
• 그렇기에, 등록해야 하는 스프링 빈 클래스들에 @Component 를 붙혀주자.

 

main/../hello.core/member/MemberServiceImpl.java

@Component
public class MemberServiceImpl implements MemberService{

    // 가입을 하고 회원을 찾으려면 앞서 만든 MemberRepository 인터페이스가 필요하다.
    // private final MemberRepository memberRepository = new MemoryMemberRepository();
    private final MemberRepository memberRepository;

    @Autowired // ac.getBean(MemberRepository.class)
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
	
	...
	}
}

main/../hello.core/order/OrderServiceImpl.java

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

main/../hello.core/discount/RateDiscountPolicy.java

@Component
public class RateDiscountPolicy implements DiscountPolicy {

    private int discountPercent = 10; //10% 할인
	...
	}
}

main/../hello.core/member/MemoryMemberRepository

@Component
public class MemoryMemberRepository implements MemberRepository {

    private static Map<Long, Member> store = new HashMap<>();
	
 ...
}

 

코드를 잘보면 @Autowired라는 어노테이션도 추가된 것을 확인할 수 있다.
의존관계 주입을 명시적으로 하지 않고 있기에 클래스 내부에서 해결해야한다.
@Autowired 어노테이션을 사용하면 생성자에서 여러 의존관계를 한 번에 주입받을 수 있다. (의존 관계를 자동으로 주입받을 수도 있다.)
이후에 @Autowired 에 대해서 자세히 공부한다.

 

테스트 케이스 작성 및 확인

package hello.core.scan;

import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
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);
    }

}

실행 결과

로그를 잘 살펴보면 컴포넌트 스캔, 컴포넌트 어노테이션이 붙은 스프링 빈을 잘 캐치해서 등록한 것을 확인할 수 있다.

 

(1) @ComponentScan

@ComponentScan은 @Component 어노테이션이 붙은 모든 클래스를 스프링 빈으로 등록한다.
이때, 스프링 빈의 이름을 설정하는 기본 설정은 클래스명에서 앞글자를 소문자로 바꿔 사용하거나 직접 이름을 부여해서 등록할 수 있다.

• 빈 이름 기본 전략 : 만약 MemberServiceImpl이라는 클래스라면 memberServiceImpl이라는 빈 이름으로 등록된다.
• 빈 이름 직접 지정 : 만약 해당 클래스에 @Component("memberService2")처럼 속성이 설정되면 memberService2라는 빈이름으로 등록된다.

(2) AutoWired 의존관계 자동 주입

• 생성자(혹은 필드)에 @Autowired 어노테이션을 지정하면 스프링 컨테이너에서는 자동으로 해당 스프링 빈을 찾아서 등록해준다.
• 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
• ac.getBean(beanName, beanClass)와 동일하다.
• 설정정보에서 직접 필요한 의존관계 주입을 수동으로 해주던 것을 자동으로 할 수 있게 된다.(자세한 내용은 뒤에서 공부하게 된다.)

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

 

📚 2. 탐색 위치와 기본 스캔 대상

탐색할 패키지의 시작 위치 지정
@ComponentScan을 통해 @Component 어노테이션이 부여된 클래스를 탐색하여 등록할 수 있다.
다만, 어디서부터 탐색할지에 대해 알아야 하는데, 기본 관례와 사용자 정의방법에 대해 모두 알아보자❗️

(1) 속성(basePackages)을 이용한 탐색위치 지정
@ComponentScan(basePackages ="hello.core")
패키지 경로를 지정해 탐색할 패키지의 시작 경로를 지정할 수 있는데, 이 패키지를 포함해 하위 패키지를 모두 탐색한다.
또한, @ComponentScan(basePackages = {"hello.core", "hello.service"}) 이런식으로 시작 위치를 여러군데 둘 수도 있다.

• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 포함한다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

ex)

테스트 결과

 

(2) 기본 관례
속성을 따로 지정하지 않으면 @ComponentScan 어노테이션이 존재하는 현재 패키지가 시작 위치가 된다.

 

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

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

• 이렇게 할시, com.hello 를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.
• 그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.

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

 

컴포넌트 스캔 기본 대상

다음 어노테이션도 트레이싱해서 살펴보면 기본적으로 @Component 어노테이션이 부여되어 있다.

• @Component : 컴포넌트 스캔 대상
• @Controller : 스프링 MVC 컨트롤러에서 사용
  ➡️ 해당 어노테이션을 붙히면 스프링 MVC 컨트롤러에서 사용
• @Service : 스프링 비즈니스 로직에서 사용
  ➡️ 특별한 처리는 하지 않고 그저 이 어노테이션이 부여된 클래스가 핵심 비즈니스 로직이 들어있다고 비즈니스 계층을 인식하는데 도움을 주는 역할
• @Repository : 스프링 데이터 접근 계층에서 사용
  ➡️ 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
• @Configuration : 스프링 설정 정보에서 사용
  ➡️ 스프링 설정 정보로 인식하고 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

⬆️ 위 컴포넌트 스캔 기본 대상 애노테이션들은 스캔용도 뿐만 아니라 각각의 목적에 맞는 부가 기능(➡️)을 수행한다.

 

📚 3. 필터

필터에 대한 학습은 이제 하지만, 사실 우리는 이미 필터를 사용해봤다.

@Configuration
@ComponentScan(excludeFilters = @Filter(type = FilterType.ANNOTATION, 
				classes = Configuration.class))
public class AutoAppConfig {
}

AutoAppConfig 클래스를 작성하며 어노테이션에서 기존에 작성한 AppConfig를 탐색하지 않기위해 속성을 지정한 적이 있는데, 이를 필터라한다.
이처럼 컴포넌트 스캔 대상을 추가 및 제외할 수 있다.

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

 

간단한 사용자정의 어노테이션을 직접 만들어서 해당 필터에 등록해서 컴포넌트 스캔 대상에서 추가, 제외를 해보자.

 

컴포넌트 스캔 대상에 추가할 애노테이션
test/../hello.core/scan/filter/MyIncludeComponent

package hello.core.scan.filter;

import java.lang.annotation.*;

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

}

컴포넌트 스캔 대상에서 제외할 애노테이션
test/../hello.core/scan/filter/MyExcludeComponent

package hello.core.scan.filter;

import java.lang.annotation.*;

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

}

컴포넌트 스캔 대상에 추가할 클래스
test/../hello.core/scan/filter/BeanA

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}

컴포넌트 스캔 대상에서 제외할 클래스
test/../hello.core/scan/filter/BeanB

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}

설정 정보와 전체 테스트 코드
test/../hello.core/scan/filter/ComponentFilterAppConfigTest

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.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.util.Assert;

import static org.junit.jupiter.api.Assertions.*;

public class ComponentFilterAppConfigTest {

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

        assertThrows(
                NoSuchBeanDefinitionException.class,
                () -> ac.getBean("beanB", BeanB.class)
        );
    }

    @Configuration
    @ComponentScan(
            includeFilters = @Filter(classes = MyIncludeComponent.class),
            excludeFilters = @Filter(classes = MyExcludeComponent.class)
    )


    static class ComponentFilterAppConfig {
    }
}

 

테스트를 통해

• includeFilters 에 등록된 어노테이션(MyIncludeComponent) 이 부여된 BeanA는 스프링 빈으로 등록되었다.
• excludeFilters 에 등록된 어노테이션(MyExcludeComponent) 이 부여된 BeanB 는 스프링 빈으로 등록되지 않는다.

 

FilterType 옵션

include혹은 excludeFilters에서 추가할 필터의 타입을 지정해줄 수 있는데, 5가지 옵션을 제공한다.

• 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

 

참고 : 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 옵션을 변경하면서 사용하기보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하며 선호하는 편이다.

 

📚 4. 중복 등록과 충돌

예전 @Bean 애노테이션을 등록할 때와 마찬가지로 컴포넌트 스캔을 할 때, 빈 이름이 중복되는 상황이 생길 수 있다.
빈 등록시 빈 이름은 관례에 따른 자동 빈 등록과 수동으로 이름을 지정한 수동 빈 등록이 있다.

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

(2) 수동 빈 등록 vs 자동 빈 등록

이 경우 수동 빈 등록이 우선권을 가진다.
(수동 빈이 자동 빈을 오버라이딩 해버린다.)

자동보다는 수동이 우선권을 가지는 것이 좋지만, 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다.
어려운 버그가 만들어진다.(애매한 버그)
최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

스프링 부트인 CoreApplication을 실행해보면 오류를 볼 수 있다.

Application.properties에서 이 옵션을 끄고 오버라이딩을 허용하면 에러가 발생하지 않지만, 끄지 않고 에러를 발생시키도록하는게 좋다.

 

---

참고

• https://catsbi.oopy.io/c760561d-50fd-4874-aa01-17feb45fe980