[Spring] Component Scan, @Autowired

DEINGVELOP·2023년 4월 16일
0

1. @ComponentScan

  • 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.

  • Bean 이름 : 기본설정) 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

  • 단, 이름을 직접 설정하고 싶으면@Component("memberService2") 처럼 애너테이션에다 입력하여 설정


1-1. 탐색할 패키지 지정

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

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

    @Configuration      // Component Scan 사용하기 위해 붙이는 Annotation
    @ComponentScan(
            basePackages = "hello.core.member",
            excludeFilters = @ComponentScan.Filter(type= FilterType.ANNOTATION, classes = Configuration.class)
    )
    public class AutoAppConfig {
    }
  • basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

  • 지정 X : @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

권장하는 방법
패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치프로젝트 최상단에 두는 것이다.

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


1-2. Filter

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

FilterType 옵션

  • ANNOTATION - 기본값, 애노테이션을 인식해서 동작한다. (org.example.SomeAnnotation)
  • ASSIGNABLE_TYPE - 지정한 타입과 자식 타입을 인식해서 동작한다. (org.example.SomeClass)
  • ASPECTJ - AspectJ 패턴 사용 (org.example..*Service+)
  • REGEX - 정규 표현식 (org\.example\.Default.*)
  • CUSTOM - TypeFilter 이라는 인터페이스를 구현해서 처리(org.example.MyTypeFilter)

💬 참고

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

1-3. Component Scan 기본 대상

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

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


1-4. 위의 Annotation들의 스프링 부가 기능

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

💬 참고
useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다. (그냥 알고만 넘어가기)


1-5. 중복 등록과 충돌

Case 1 : 자동 빈 등록 vs 자동 빈 등록

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

Case 2 : 수동 빈 등록 vs 자동 빈 등록

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

  • 의도했다면 모르겠지만, 보통은 여러 설정들이 꼬여서 이런 결과가 만들어진다. 그러면 정말 잡기 어려운 버그가 만들어진다.

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

    Consider renaming one of the beans or enabling overriding by setting 
    spring.main.allow-bean-definition-overriding=true
    • 오버라이딩하도록 하고 싶다면 spring.main.allow-bean-definition-overriding=true 설정하면 됨

개발을 하다 보면 중요한 교훈
명확하지 않은 것은 피하라.

  • 어설픈 추상화나, 어설픈 우선 순위는 나중에 정말 잡기 힘든 버그를 만든다.

2. @Autowired

  • 스프링은 의존관계를 자동으로 주입하는 @Autowired라는 기능도 제공한다.
  • 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
  • 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.

0개의 댓글