컴포넌트 스캔

이성준·2022년 8월 17일
0

Spring

목록 보기
5/11
post-thumbnail

스프링 빈을 등록할때 자바 코드의 @Bean이나 xml을 이용해서 설정정보에 직접 스프링 빈을 등록했다. 하지만 이게 수십 수백개가 되면? 매우 귀찮아진다.
그래서 스프링은 빈으로 사용될 클래스에 특별한 애노테이션을 부여해주면 이런 클래스들을 자동으로 찾아서 빈으로 등록해주게 할 수 있다.
이런 특정 애노테이션을 붙은 클래스들을 자동으로 찾아서 빈으로 등록해주는 방식을 Bean Scanning, 이런 스캐닝 작업을 담당하는 오브젝트를 Bean Scanner라고 한다.

StereoType Annotation

위에서 말한 이 특정애노테이션이 바로 StereoType Annotation 이다.

  • @Component : 이 어노테이션이 붙은 클래스는 스프링 컴포넌트이다. 빈스캐너에 담긴 디폴트 필터는 이 애노테이션을 가지고있거나 이 애노테이션을 메타 애노테이션을 가진 애노테이션이 부여된 클래스를 선택한다.
  • @Repository - 데이터 접근 계층을 나타내는 스프링 빈 데이터 예외를 스프링 예외로 변환 시킨다.
  • @Service - 비즈니스 계층, 비즈니스 로직이 있는 빈
  • @Controller - 컨트롤러 계층이고 사용자 요청을 처리하고 적절한 응답을 반환할 책임이 있음을 나타낸다.

Bean Scanner

스프링에서 @ComponentScan이라는 애노테이션을 통해 @Component가 붙은 빈들을 자동으로 스캔한다. 기본 탐색 위치는 이 애노테이션이 붙은 클래스의 패키지가 시작 위치가 되어 그 하위 패키지들을 쭉 훑는다.
그리고 입맛에 맞게 탐색위치나 필터를 걸어서 쓸 수 있다.

@ComponentScan(
        basePackages = "hello.core",
        basePackageClasses = AutoAppConfig.class,
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes =
                Configuration.class))
  • basePackages : 이 패키지부터 쭉 훑는다.
  • basePackagesClasses : 이 클래스가 있는 패키지부터 쭉 훑는다.
  • excludeFilter : 예외로 할 빈들 지정

여기까지 해서 @ComponentScan이 @Component를 찾는다는거는 알겠는데 우리는 빈 스캐닝할때 @ComponentScan만 붙였지 따로 의존 관계 명시는 해주지않았다 근데 어떻게 스프링은 의존관계 주입을 해결해줄까?

@AutoWired

스프링을 통한 자동 의존관계 설정에는 @Autowired가 있는데 XML의 타입에 의한 자동와이어링 방식을 생성자, 필드, 수정자, 메소드의 네 가지로 확장한 것이다.

  • 생성자를 통해서 의존관계 주입
@Component
public class OrderServiceImpl implements OrderService {
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository,  @MainDiscountPolicy DiscountPolicy
            rateDiscountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = rateDiscountPolicy;
    }
}

여러 개의 생성자에 @Autowired가 붙으면 어느 생성자를 이용해서 DI해야 할지 스프링이 모르니까 단 하나의 생성자에만 사용할 수 있다는 제한이 있다. -> 생성자가 한개면 생략가능
필드에서 final 키워드를 써 컴파일시점에서 에러를 내준다. 나머지는 생성자 이후에 호출해서 final 키워드를 쓸수가 없음
불변, 필수 의존관계에 사용

  • 생성자 주입
@Component
public class OrderServiceImpl implements OrderService {
    
        @Autowired
        public void setMemberRepository(MemberRepository memberRepository) {
            this.memberRepository = memberRepository;
        }
        @Autowired
        public void setDiscountPolicy(DiscountPolicy discountPolicy) {
            this.discountPolicy = discountPolicy;
        }
}

선택, 변경 가능성이 있는 의존관계에 사용하고 메소드 파라미터에 있는 타입에 대입이 가능한 빈을 찾아서 넣어준다.

  • 필드 주입
@Component
public class OrderServiceImpl implements OrderService {
     @Autowired
     private MemberRepository memberRepository;
     @Autowired
     private DiscountPolicy discountPolicy;
}

필드인젝션은 @Configuration 이나 테스트에서만 쓰자
외부에서 변경이 불가능하다. -> 테스트 하기 힘들다.

  • 메소드 주입
   @Autowired
   public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
            this.memberRepository = memberRepository;
            this.discountPolicy = discountPolicy;
        }

한번에 여러 필드를 주입받을수 있고, 테스트를 고려한다면 public으로 열어두는게 좋다.

찾고자하는 Bean이 없을때

di할 빈이 없어도 동작해야 할때가 있는데 di할 대상을 옵션으로 처리할려면
@Autowired(required=false) 옵션을 주면 수정자 메서드 자체가 호출이 안된다.

동일한 타입의 Bean이 2개 이상일때

@Autowired
  private DiscountPolicy discountPolicy
@Component
  public class FixDiscountPolicy implements DiscountPolicy {}
@Component
  public class RateDiscountPolicy implements DiscountPolicy {}  

스프링은 discountPolicy에 뭘 넣어야될지 몰라서 nouniqueBeanDefinitionException을 뱉는다. 그렇다고

@Autowired
private FixDiscountPolicy fixDiscountPolicy

이렇게 하위타입으로 지정하면 dip를 위배하고 유연성이 떨어진다.

타입매칭

@Autowired는 먼저 타입 매칭을 시도하고, 이때 여러Bean이 있으면 필드이름, 파라미터이름으로 Bean 이름을 추가 매칭한다.

컬랙션이나 맵으로 받기

Collection<DiscountPolicy> discountPolicys;

배열로 받을수도 있고

Map<String,DiscountPolicy> discountPolicys;

Map으로 받을수도 있는데 빈의 이름이 Key로 받아진다
충돌을 피하려는 목적으로 사용하면 안되고, 의도적으로 타입이 같은 여러 빈을 등록하고 이를 모두 참조하거나 그중에서 선별적으로 필요한 빈을 찾을때 사용하자.

@Qualifier

@Qualifier는 빈이름과는 별도로 추가적인 메타정보를 설정해주는것이다.

@Component
@Qualifier("mainDiscountPolicy")
  public class RateDiscountPolicy implements DiscountPolicy {}  

빈등록시 추가로 @Qualifier를 붙여주고 찾을때

  @Autowired
  public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy")
  DiscountPolicy discountPolicy) {
      this.discountPolicy = discountPolicy;
  }

이런식으로 찾을수 있다. 근데 못찾으면 mainDiscountPolicy라는 이름의 Bean을 추가로 탐색한다.

@Primary

@Component
@Primary
  public class RateDiscountPolicy implements DiscountPolicy {}  
  @Autowired
  public DiscountPolicy setDiscountPolicy(DiscountPolicy discountPolicy) {
      this.discountPolicy = discountPolicy;
  }

@Primary를 Bean 등록 시에 붙여주면 우선순위가 생겨서 스프링이 DI할때 여러빈이 매칭되면 @Primary가 붙은 Bean이 우선권을 갖는다.

0개의 댓글