<Spring> 컴포넌트 스캔

라모스·2022년 1월 23일
0

Spring☘️

목록 보기
6/18
post-thumbnail

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

이전까지 학습을 진행하며 작성한 코드들에선 스프링 빈을 등록하기 위해 자바코드의 @Bean이나 XML의 <bean> 등을 통해 설정 정보에 직접 등록할 스프링 빈을 나열했다. 예제에선 몇 개 안됐지만, 등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생할 것이다.

스프링에선 이런 문제를 해결하기 위해 컴포넌트 스캔(@ComponentScan)이라는 기능을 제공한다.

또한 의존관계도 자동으로 주입하는 @Autowired라는 기능도 제공한다.

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

}
  • 컴포넌트 스캔을 사용하려면 @ComponentScan을 설정 정보에 붙여준다.
  • 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다.
  • excludeFilters를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외 했다.
    (기존에 작업했던 AppConfig와 충돌이 생길 수 있기 때문)

컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.

내가 등록해야 하는 기존 코드에 @Component를 붙여주자.

@Component
public class MemoryMemberRepository implements MemberRepository {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class MemberServiceImpl implements MemberService {
    
    private final MemberRepository memberRepository;
    
    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
}

이전 AppConfig에선 @Bean으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했지만, 이젠 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다. @Autowired를 써준 이유가 바로 이것이다.

@ComponentScan


이 어노테이션은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.

스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

  • 빈 이름 기본 전략: MemberServiceImpl -> memberServiceImpl
  • 빈 이름 직접 지정: @Component("memberService2")와 같은 방식으로 이름을 부여하면 된다.

@Autowired


생성자(or 필드)에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다. 기본 조회 전략은 타입이 같은 빈을 찾아서 주입하는 방식이다. getBean(MemberRepository.class)와 동일하다 생각하면 된다.

📌 참고로 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입해줌

탐색 위치와 기본 스캔 대상

@ComponentScan을 통해 @Component 어노테이션이 부여된 클래스를 탐색하여 등록할 수 있다.
모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래걸리기 때문에 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수도 있다.

  1. 속성(basePackage)을 이용한 탐색위치 지정
    @ComponentScan(basePackage = "hello.core") 처럼 탐색할 패키지의 시작 위치를 지정할 수 있다. 이 경우, 이 패키지를 포함해서 하위 패키지 모두를 탐색한다.
    basePackageClasses 속성을 지정하면 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

  2. 기본 관례
    속성을 따로 지정하지 않으면, @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

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

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

컴포넌트 스캔 기본 대상

다음 어노테이션들의 소스 코드를 살펴보면 내부적으로 @Component를 포함하고 있다.

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

참고로, 애노테이션에는 상속관계라는 것이 없다. 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 Java 언어가 지원하는 기능이 아닌 Spring이 지원하는 기능이다.

필터

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

예제

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

import java.lang.annotation.*;

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


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

import java.lang.annotation.*;

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


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

@MyIncludeComponent
public class BeanA {}


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

@MyExcludeComponent
public class BeanB {}

Test code

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

    }
}

테스트 결과, includeFiltersMyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록되고, excludeFiltersMyExcludeComponent 애노테이션을 추가해서 BeanB가 스프링 빈에 등록되지 않았다.

FilterType 옵션

  • ANNOTATION: 기본값, 애노테이션을 인식해서 동작
  • ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작
  • ASPECTJ: AspectJ 패턴 사용
  • REGEX: 정규 표현식 사용
  • CUSTOM: TypeFilter 인터페이스를 구현해서 처리

참고로, @Component면 충분하기 때문에, includeFilter를 사용할 일은 거의 없고, excludeFilters는 여러가지 이유로 간혹 사용될 때가 있지만 많지는 않다고 한다.

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하는 상황에선 어떻게 처리해야 할까?

자동 빈 등록 vs 자동 빈 등록

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

📌 개인적인 경험 상, Controller 단에서 인자를 @Valid로 검증 처리 하면서 커스텀 예외처리를 하고자 할 때, 이런 예외가 발생했던 것 같다.

@RestController
@ControllerAdvice // 전역 설정을 위한 annotation
public class CustomizedResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {
    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        ExceptionResponse exceptionResponse =
                new ExceptionResponse(new Date(), "Validation Failed", ex.getBindingResult().toString());

        return new ResponseEntity(exceptionResponse, HttpStatus.BAD_REQUEST);
    }
}

수동 빈 등록 vs 자동 빈 등록

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

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

개발자가 의도적으로 이런 결과를 기대했다면, 자동보단 수동이 우선권을 가지는 것이 좋다. 하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보단 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이라고 한다.
정말 잡기 어려운 버그가 만들어지는데, 항상 잡기 어려운 버그는 애매한 버그다. 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다고 한다.

References

profile
Step by step goes a long way.

0개의 댓글