8월 31일 목요일 TIL 회고록

스프링 핵심 원리 - 기본편

---

컴포넌트 스캔

스프링에서는 설정 정보(AppConfig.class) 없이 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 기능을 제공한다.

스프링 빈을 등록할 때는 의존관계를 자바 코드로 직접 등록하는 방법과 컴포넌트 스캔과 자동 의존관계를 설정해주는 @Autowired 애노테이션을 사용하는 방법이 있다.

 

@ComponentScan은 탐색 위치에 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.

 

MemberServiceImpl.class

@Component
public class MemberServiceImpl implements MemberService {
}

이떄 기본적으로 빈 이름은 맨 앞글자를 소문자로 바꿔 사용한다.

@Component("beanName")과 같이 빈 이름을 직접 설정해 줄 수도 있다.

 

탐색 위치(basePackages)

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

@Configuration
@ComponentScan(
    basePackages = "hello.core"
)
public class AutoAppConfig {
}

basePackages: 탐색할 패키지의 시작 위치를 설정하고, 해당 패키지부터 하위 패키지까지 모두 탐색한다.

basePackageClass : 클래스가 속한 패키지를 시작 위치로 지정할 수 있다.

basePackages 또는 basePackageClass를 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

따라서, 설정 정보 클래스의 위치를 프로젝트 최상단에 두고 패키지 위치는 지정하지 않는 방법이 속도면에서는 느릴 수 있으나 가장 편한 방법이기도 하다.

 

스프링 부트를 사용하면 일반적으로 @SpringBootApplication을 프로젝트 시작 루트 위치에 둔다.

@SpringBootApplication 애노테이션에는 @ComponentScan이 기본적으로 포함되어 있다.

 

기본 스캔 대상

• @ComponentScan은 @Component가 밭운 모든 클래스를 스프링 빈으로 등록한다.
• 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
  • 빈 이름 기본 전략 : MemberServiceImpl 클래스 -> memberServiceImpl
  • 빈 이름 직접 지정 : 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService") 이런식으로 이름을 부여할 수 있다.
• @Autowired 의존관계 자동 주입
  • 생성자에 @Autowired 애노테이션을 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
  • 이때 기본 조회 전략은 타임이 같은 빈을 찾아서 주입한다.
    • getBean(MemberRepository.class)와 동일하다고 이해하면 된다.
    • 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입해준다.

 

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

• @Component : 컴포넌트 스캔에서 사용
• @Controller (@RestController) : 스프링 MVC 및 Rest 전용 컨트롤러에서 사용
• @Service : 스프링 비즈니스 로직에서 사용, 특별한 처리는 하지 않고, 비즈니스 계층을 인식하는데 도움이 된다.
• @Repository : 스프링 데이터 접근 계층에서 사용, 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
• @Configuration : 스프링 설정 정보에서 사용, 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 해준다.

해당 클래스의 소스 코드를 보면 @Component 애노테이션을 포함하고 있는 것을 볼 수 있다.

  @Component
  public @interface Controller {
  }
  @Component
  public @interface Service {
  }
  @Component
  public @interface Configuration {
  }

사실 애노테이션에는 상속관계라는 것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.

 

필터

필터는 컴포넌트 스캔의 대상 범위를 지정하는데 사용한다.

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

컴포넌트 스캔 대상에 추가할 애노테이션을 만들었다. 모든 예제는 테스트 코드에 추가하였다.

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

}

 

컴포넌트 스캔 대상에서 제외할 애노테이션도 만들었다.

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

}

 

컴포넌트 스캔 대상에 추가할 클래스인 beanA 클래스를 만들었다. 위에서 만든 @MyIncludeComponent 어노테이션을 사용하였다.

 

beanA.class

@MyIncludeComponent
public class BeanA {

}

 

컴포넌트 스캔 대상애서 제외할 클래스인 beanB 클래스를 만들었다. 위에서 만든 @MyExcludeComponent 어노테이션을 사용하였다.

@MyExcludeComponent
public class BeanB {

}

 

ComponentFilterAppConfigTest 클래스를 만들어서 설정 정보와 테스트 코드를 만들었다.

 

설정 정보

  @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는 스프링 빈에 등록되지 않는다.

 

테스트 코드

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

 

실행 결과

 

 

FiltetType 옵션

FilterType은 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

 

컴포넌트 스캔의 중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하는 경우의 수는 두 가지가 있다.

1. 자동 빈 등록과 자동 빈 등록의 충돌
2. 수동 빈 등록과 자동 빈 등록의 충돌

자동 빈 등록과 자동 빈 등록의 충돌

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

 

수동 빈 등록과 자동 빈 등록의 충돌

수동 빈 등록과 자동 빈 등록의 경우 수동 빈 등록이 우선권을 가지게 되어 자동으로 등록된 빈을 오버라이딩 한다.

 

자동 빈 등록

@Component // 기본적으로 빈 이름이 memoryMemberRepository로 지정됨.
public class MemoryMemberRepository implements MemberRepository{
	...
}

 

수동 빈 등록

 @Configuration
  @ComponentScan(
          excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
  Configuration.class)
  )
  public class AutoAppConfig {
      @Bean(name = "memoryMemberRepository")
      public MemberRepository memberRepository() {
          return new MemoryMemberRepository();
      }
}

 

수동 빈 등록시 남는 로그

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

개발자가 의도적으로 이런 결과를 기대했다면, 자동보다는 수동이 우선권을 가지는 것이 좋다.

하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다. 그러면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그다.

그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

 

수동 빈 등록, 자동 빈 등록 오류 시 스프링 부트 에러

Description: The bean 'memoryMemberRepository', defined in class path resource [hello/core/AutoAppConfig.class], could not be registered. A bean with that name has already been defined in file [/core/out/production/classes/hello/core/member/MemoryMemberRepository.class] and overriding is disabled. Action: Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true

해석해보면 이런 뜻이다.

설명: 클래스 경로 리소스 [hello/core/AutoAppConfig.class]에 정의된 'memoryMemberRepository' 빈을 등록할 수 없습니다. 같은 이름의 빈이 [/core/out/production/classs/hello/core/memberMemberRepository.class] 파일에 이미 정의되어 있으며 재정의가 사용되지 않도록 설정되었습니다. 조치: 빈의 이름을 변경하거나 spring.main.allow-bean-definition-true=로 설정하여 재정의를 사용하도록 설정하십시오

application.properties 에서 spring.main.allow-bean-definition-overriding=true 을 적어준 후 실행하면 에러가 나지 않고 실행이 되는 것을 볼 수 있다.