[20230101] 컴포넌트 스캔

[otakijae]

Component Scan

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

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

  • 빈 이름 기본 전략: MemberServiceImpl 클래스 memberServiceImpl
  • 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름을 부여하면 된다.

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

  • 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
  • getBean(MemberRepository.class) 와 동일하다고 이해하면 된다.
  • 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.

  @Component
  public class MemberServiceImpl implements MemberService {
  
  // private final MemberRepository memberRepository = new MemoryMemberRepository();
  private final MemberRepository memberRepository;
  
  //자동으로 의존관계 주입하는 방법
  //MemberRepository 타입에 맞는 것을 찾아와서 의존관계 주입을 자동으로 해줌
  //ac.getBean(MemberRepository.class)와 같은 코드가 자동으로 들어간다고 보면 된다
  @Autowired
  public MemberServiceImpl(MemberRepository memberRepository) {
      this.memberRepository = memberRepository;
  }
  ...
  }

• AutoAppConfig.class 확인

  • AnnotationConfigApplicationContext 를 사용하는 것은 기존과 동일하다.
  • 설정 정보로 AutoAppConfig 클래스를 넘겨준다.
  • 실행해보면 기존과 같이 잘 동작하는 것을 확인할 수 있다.

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

탐색 위치와 기본 스캔 대상

• 탐색할 패키지의 시작 위치 지정

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

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

• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

• 만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

  @Configuration
  @ComponentScan(
  basePackages = "wm.core.member", //이쪽 위치에서 부터 하위 패키지를 찾아들어감
  basePackageClasses = AutoAppConfig.class, //이쪽 패키지의 위치에서부터 찾아들어감
  excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
  )
  public class AutoAppConfig {}

• 컴포넌트 스캔 기본 대상:

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

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

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

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

• useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다.

Component Scan Filter

• includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
• excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.
• includeFilters 에 MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
• excludeFilters 에 MyExcludeComponent 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다.
• 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
• @Component 면 충분하기 때문에, includeFilters 를 사용할 일은 거의 없다. excludeFilters 는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다. 특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다.

[LeeeeDain]

컴포넌트 스캔

@ComponentScan

• 설정 정보가 없어도 자동으로 스프링 빈을 등록
• @Component가 붙은 클래스를 자동 스캔
• includeFilters: 컴포넌트 스캔 대상을 추가로 지정한다.
• excludeFilters: 컴포넌트 스캔에서 제외할 대상을 지정한다.

  • @ComponentScan(
    excludeFilters = @ComponentScan.Filter(type= FilterType.ANNOTATION, classes = Configuration.class)
    )

• basePackages: 탐색할 패키지의 시작 위치를 지정한다.

  • @ComponentScan(
    basePackages = {"hello.core.member", "hello.service"}
    )

  • FilterType 옵션
  • ANNOTATION: 기본값, 어노테이션을 인식해서 동작한다.
  • ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
  • ASPECTJ: AspectJ 패턴 사용
  • REGEX: 정규 표현식
  • CUSTOM: TypeFilter 라는 인터페이스를 구현해서 처리
• basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• base를 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치로 지정됨
• 권장하는 방법
  • 패캐지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것
  • 스프링부트 프로젝트면 @SpringBootApplication 를 프로젝트 시작 루트 위치에 두는 것이 관례이고, 이 어노테이션 안에 @CompnentScan이 들어있다.

컴포넌트 스캔 기본 대상

• @Component: 컴포넌트 스캔에서 사용
• @Controller: 스프링 MVC 컨트롤러에서 사용, 스프링 MVC 컨트롤러로 인식하는 기능 지원
• @Service: 스프링 비즈니스 로직에 사용
• @Repository: 스프링 데이터 접근 계층에서 사용, 데이터 접근 계층으로 인식하여 데이터 계층의 예외를 스프링 예외로 변환해주는 기능 지원
• @Configuration: 스프링 설정 정보에서 사용, 스프링 설정 정보로 인식하고 스프링 빈이 싱글톤을 유지하도록 처리 지원
• 위 어노테이션 안에 @Component가 붙어있음

@Autowired

• 의존관계 자동 주입해줌
• 기본 조회 전략은 타입이 같은 빈을 찾아서 주입

• as-is

  • @Configuration
    public class AppConfig {
    
    @Bean
    public MemberService memberService() {
      return new MemberServiceImpl(memberRepository());
    }
    }

• to-be (위 AppConfig 없어도 됨)

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

@Autowired vs @Resource

• Resource: 이름 -> 타입 순으로 찾아서 빈 주입
• Autowired: 타입 -> 이름 순으로 찾아서 빈 주입
• 참고
  • https://velog.io/@sungmo738/Resource-Autowired-Inject-%EC%B0%A8%EC%9D%B4
  • https://devmg.tistory.com/143

자동 빈 등록 vs 자동 빈 등록 충돌

• 컴포넌트 스캔 시 컴포넌트 이름이 같은 경우 ex) @Componet("Service") 를 붙인 클래스가 2개인 경우
• ConflictingBeanDefinitionException 예외 발생

수동 빈 등록 vs 자동 빈 등록 충돌

• 수동 빈 등록이 우선권을 가져서 오버라이딩 해버린다.
• 현실은 이 경우가 설정이 꼬여서 발생할 가능성이 높기 때문에 최근 스프링 부트에서는 이 경우 오류가 나도록 기본 값을 바꿈
• 오류가 안나도록 하고 싶으면 application.properties에 아래와 같이 설정

  • spring.main.allow-bean-definition-overriding=true

[jin-ryu]

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

• 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
• 또 의존관계도 자동으로 주입하는 @Autowired라는 기능도 제공한다.
  • 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
  • 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입힌다.
• 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 된다.
  • @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
  • 이때 스프링 빈의 기본 이름을 클래스명을 사용하되, 맨 앞 글자만 소문자를 사용한다.
  • @Configuration에도 @Component가 붙어서 컴포넌트 스캔의 대상이 된다.
• 참고: https://jess-m.tistory.com/14

탐색 위치와 기본 스캔 대상

• basePackages: 이 패키지를 포함해서 하위 패키지를 모두 탐색
• basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• default: @ComponenetScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
  • 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장한다.
  • 스프링 부트에서는 @SpringBootApplication이 프로젝트의 최상단에 위치하고, 여기에는 @ComponentScan이 들어가 있다
• @ComponenetScan 기본 대상
  • @Component, @Controller, @Service, @Repository, @Configuration
• 참고: 애노테이션에는 상속관계라는 것이 없다. 그래서 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바가 아닌 스프링이 지원하는 기능이다.

필터

@ComponentScan(
  includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
  excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)

• FilterType Option

  • ANNOTATION: 애노테이션 인식 (default)
  • ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식
  • ASPECTJ: AspectJ 패턴 사용
  • REGEX: 정규 표현식
  • CUSTOM: TypeFilter이라는 인터페이스를 구현해서 처리

• 참고: Spring AOP와 AspectJ 비교하기

• 참고: 스프링(Spring) AOP : AspectJ Pointcut 표현식

중복 등록과 충돌

• 자동 빈 등록 vs. 자동 빈 등록
  • ConflictingBeanDefinitionException 발생
• 자동 빈 등록 vs. 수동 빈 등록
  • 수동 등록 빈이 우선권을 가진다. (수동 등록 빈이 자동 등록 빈을 오버라이딩 한다.)
  • 최근에 "스프링 부트"에서는 충돌 발생 시 에러 발생하도록 수정
  • spring.main.allow-bean-definition-overriding=true << 에러 발생하지 않고 오버라이딩하도록 설정
• 참고: https://java.ihoney.pe.kr/530
  • 스프링 프레임워크 5.1.0부터 exception 처리

[qazyj]

문제점

• 지금까지 @Bean을 통해 스프링 빈에 등록했다. 하지만, 등록해야 할 스프링 빈이 많은 경우 일일이 @Bean을 등록해야하는 번거로움이 있다.
• 등록해야하는 스프링 빈이 많아지면 일일이 등록하는 것이 물론 귀찮지만, 누락하는 문제가 발생할 수 있다.

해결책

• 컴포넌트 스캔
  • 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 기능
• @Autowired
  • 의존관계 자동 주입

컴포넌트 스캔

@ComponentScan은 이름 그대로 '@Component' 붙은 클래스를 스캔해서 스프링 빈으로 등록

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

• @Bean으로 등록한 클래스가 하나도 없는 것을 볼 수 있다.

@Autowired

스프링에서 의존관계를 자동으로 주입해주는 기능

컴포넌트 스캔을 사용하면 의존관계를 수동으로 주입해줄 수 없기때문에, 컴포넌트 스캔 사용 시 @Autowired는 필수로 사용된다.

컴포넌트 탐색 위치

• basePackages = "hello.core"
  • "hello.core" 하위의 모든 @Component로 설정된 객체를 스프링 빈에 등록
• basePackageClasses = AutoAppConfig.class
  • AutoAppConfig 클래스 패키지 하위의 모든 @Component로 설정된 객체를 스프링 빈에 등록

basePackages, basePackageClasses 모두 디폴트는 @ComponentScan을 설정한 패키지의 모든 하위패키지, 그렇기 때문에 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이 편리하다. (추가설정 필요 없게)

컴포넌트 스캔 기본 대상

• @Component
• @Controller
• @Service
• @Repository
• @Configuration

@Component
public @interface Service {

}

컴포넌트 필터

• includeFilters
  • 컴포넌트 스캔 대상을 추가 지정
• excludeFilters
  • 컴포넌트 스캔 대상 중 제외 지정

중복 등록과 충돌

1. 자동 빈 등록 vs 자동 빈 등록

   'ConflictingBeanDefinitionException' 예외 발생

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

   수동 빈 등록이 우선권을 가진다.ㅎ

2번의 경우 실제 스프링 부트로 실행하면 에러를 발생한다. 별도의 설정을 통해 오버라이딩하는 방식으로 해결할 수 있지만, 이러한 상황을 안만드는 것이 최선.

[myeongho2]

컴포넌트 스캔과 의존관계 자동 주입

• Component Scan 시 Component 등록
  • Exclude 조건으로 Configuration 제외 등록
  • 생성자에 @Autowired 어노테이션 사용하여 의존관계 자동 주입
    • 기본 조회 전략은 타입이 같은 빈을 찾아서 주입
• 권장 방법
  • 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것
• 에노테이션에는 상속관계가 없다. 특정 에노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.
  • @Controller : 스프링 MVC 컨트롤러로 인식
  • @Repository : 스프링 데이터 접근 계층으로 인식, 데이터 계층의 예외를 스프링 예외로 변환
  • @Configuration : 스프링 설정 정보로 인식, 스프링 빈이 싱글톤을 유지하도록 추가 처리
  • @Service : 특별한 처리 X, 개발자들이 비즈니스 계층으로 인식하는데 도움을 줌
• 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 이라는 인터페이스를 구현해서 처리

• 중복 등록과 충돌

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

  • 수동 빈 vs 자동 빈

    • 수동 빈 등록이 자동 빈을 오버라이딩 해버린다.
    • log

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

  • 이 경우 충돌 오류는 기본으로 발생하도록 설정되어 있음

[moeun2]

컴포넌트 스캔

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

@ComponentScan과 @Autowired

• @ComponentScan : 스프링 설정 정보가 없어도 자동으로 스프링 빈을 등록
  • @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.
  • @Configuration안에도 @Component가 있기에 컴포넌트 스캔 시, @Configuration이 붙은 설정 정보도 자동으로 등록이 됨.
• @Autowired : 의존관계 자동 주입.
  • 생성자에서 여러 의존관계도 한번에 주입받을 수 O 동작방법
    1. @ComponentScan은 @Component가 붙은 몯느 클래스를 스프링 빈으로 등록한다.
  • 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자 사용(빈 이름 직접 지정 가능)
    2. 생성자에 @Autowired를 지정하여 의존 관계를 자동 주입 시킨다.(스플이 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입)
  • 기본 조회 전략 : 타입이 같은 빈을 찾아서 조회 / getBean(MemberRepository.class)와 동일
  • 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.

탐색 위치와 기본 스캔 대상

탐색 위치 지정 방법

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

• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다. { } 를 이용하여 여러 시작 위치를 지정할 수 있다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• if 지정하지 않는다면 : @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
• recommend : 패키지 위치를 지정X, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것. (ex) 스프링 부트의 @SpringBootApplication이 붙여진 클래스를 프로젝트 시작 루트 위치에 두는 것이 관례(이 안에 @ComponentScan이 들어있음))

컴포넌트 스캔 기본 대상

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

애노테이션 별 스프링이 지원하는 부가 기능

• @Conroller : 스프링 MVC 컨트롤러로 인식
• @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
• @Configuration : 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
• @Service : 특별한 처리 X, 개발자들이 비즈니스 계층을 인식하는데 도움을 줌

참고 :

• 애노테이션에는 상속관계 X
• useDefaultFilters옵션은 기본으로 켜져 있음. 이 옵션을 끄면 기본 스캔 대상들이 제외됨.

필터

includedFilters / excludeFilters

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

FilterType 옵션

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

중복 등록과 충돌

1. 자동 빈 등록 + 자동 빈 등록 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이23333333 같은 경우 스프링은 오류를 발생시킨다(conflictingBeanDefinitionException)
2. 수동 빈 등록 + 자동 빈 등록 수동 빈 등록과 자동 빈 등록 시, 그 이름이 같은 경우 수동 빈 등록이 우선권을 가진다.(수동 빈이 자동 빈을 오버라이딩 해버린다.)
   • 테스트 코드에서 오류 나지 않는다(우선권을 갖기에)
   • 스프링 부트에서는 오류가 발생하도록 기본 값이 되어 있어 이를 true로 바꿔야지 오류가 해결된다. -> 잡기 어려운 버그가 만들어짐. -> 개발은 항상 명확하게 해야 함!

[otakijae]

스터디 개선방향 #12