Spring gradle project 스프링 핵심 원리 기본편 | 컴포넌트 스캔 의존관계 자동 주입, @Autowired, @ComponentScan

---

본 포스팅은 인프런에 있는 인터넷 강좌인,

김영한 강사님의 스프링 핵심 원리 기본편을 공부하며,

개인적으로 공부하고, 정리하는 용도로 포스팅을 해보겠다.

 

Spring gradle project 환경설정 및 회원 가입 서비스 예제 만들기
Spring gradle project 주문/할인 도메인 설계

Spring gradle project 객체 지향 원리 적용

Spring gradle project AppConfig 리팩토링 OCP 위반 해결 및 중복 제거

Spring gradle project 좋은 객체 지향 설계 5가지 원칙 적용 및 스프링 전환

Spring gradle project 스프링 컨테이너와 스프링 빈

Spring gradle project BeanFactory, ApplicationContext 이해 및 차이

Spring gradle project XML 설정 사용, BeanDefinition, 스프링 빈 설정 메타 정보

Spring gradle project 웹 애플리케이션과 싱글톤, WebApplication and Singleton

Spring gradle project 싱글톤 컨테이너, @Configuration

 

컴포넌트 스캔

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

• 지금까지 스프링 빈을 등록할 때, 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.
• 이렇게 등록해야 할 스프링 빈이 수십, 수백 개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다.
• 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
• 의존관계도 자동으로 주입하는 @Autowired라는 기능도 제공한다.
  

SpringBootAutoAppConfig.java

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import static org.springframework.context.annotation.ComponentScan.*;

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

}

• @ComponentScan 어노테이션은 Spring이 어노테이션이 붙은 클래스를 스캔하고 빈으로 등록할 패키지를 지정한다.
• excludeFilters 속성은 스캔 대상에서 특정 유형의 컴포넌트를 제외한다.
• 여기서는 @Filter 어노테이션을 사용하여 type을 FilterType.ANNOTATION으로 설정하고, classes를 Configuration.class로 설정해서, @Configuration 어노테이션이 붙은 클래스는 컴포넌트 스캔 과정에서 제외된다.
  
• 컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다.
• 그래서 excludeFilters를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다.
  

MemoryMemberRepository @Component 추가

@Component
public class MemoryMemberRepository implements MemberRepository {}

RateDiscountPolicy @Component 추가

 @Component
 public class RateDiscountPolicy implements DiscountPolicy {}

 

MemberServiceImpl @Component, @Autowired 추가

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

}

• 이전에 AppConfig에서는 @Bean으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다.
• 이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.
• @Autowired는 의존관계를 자동으로 주입해 준다
• @Autowired를 사용하면, 아래와 같이 생성자에서 여러 의존관계도 한 번에 주입받을 수 있다.

OrderServiceImpl @Component, @Autowired 추가

@Component
public class OrderServiceImpl implements OrderService {

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

AutoAppConfigTest.java

import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.assertj.core.api.Assertions.*;

public class AutoAppConfigTest {

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

• AnnotationConfigApplicationContext를 사용하는 것은 기존과 동일하다.
• 설정 정보로 AutoAppConfig 클래스를 넘겨준다

위의 코드를 실행하면, 로그를 통해 컴포넌트 스캔이 잘 동작하는지 확인할 수 있다.

그렇다면 이제 컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 그림으로 알아보자.

 

@ComponentScan

• 위에서 설명했듯, @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
  빈 이름 기본 전략 : MemberServiceImpl 클래스 → memberServiceImpl
  빈 이름 직접 지정 : 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런 식으로 이름을 부여하면 된다.

@Autowired 의존관계 자동 주입

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

• 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.

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

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

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

• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
  위 코드와 같이 여러 시작 위치를 지정할 수 있다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다
• 권장하는 방법으로는 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.

예를 들어서 프로젝트가 다음과 같이 구조가 되어 있다고 가정하자.

• com.hello
• com.hello.serivce
• com.hello.repository

com.hello → 프로젝트 시작 루트, 여기에 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 어노테이션을 붙이고, basePackages 지정은 생략한다.

• 이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.
• 그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다 생각한다.

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

 

컴포넌트 스캔 기본 대상

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

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

사실 어노테이션에는 상속관계라는 것이 없다.

그래서 이렇게 어노테이션이 특정 어노테이션을 들고 있는 것을 인식할 수 있는 것은

자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.

컴포넌트 스캔의 용도뿐만 아니라 다음 어노테이션이 있으면 스프링은 부가 기능을 수행한다.

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

또한 필터를 이용하여 컴포넌트 스캔대상을 추가/제외 지정할 수 있다.

• includeFilters : 컴포넌트 스캔에서 추가 대상 지정
• excludeFilters : 컴포넌트 스캔에서 제외 대상 지정

컴포넌트 스캔 대상에 추가할 어노테이션

import java.lang.annotation.*;

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

컴포넌트 스캔 대상에 제외할 어노테이션

import java.lang.annotation.*;

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

 

컴포넌트 스캔 대상에 추가할 클래스

@MyIncludeComponent
public class BeanA {
}

컴포넌트 스캔 대상에 제외할 클래스

@MyExcludeComponent
public class BeanB {
}

설정 정보와 전체 테스트 코드

import org.junit.jupiter.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.assertThat;
import static org.springframework.context.annotation.ComponentScan.Filter;

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
        BeanA beanA = ac.getBean("beanA", BeanA.class);
        assertThat(beanA).isNotNull();
        Assertions.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 {
    }
    
}

• includeFilters에 MyIncludeComponent 어노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
• excludeFilter에 MyExcludeComponent 어노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다.

FilterType 옵션

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

최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데,

개인적으로는 옵션을 변경하면서 사용하기보다,

스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다.

 

말 그대로 사용하기 좋게 만든 프레임워크이기 때문에

스프링 개발자의 의도를 따라 기본 설정에 맞춰 사용하는 것이,

가장 안전하고 유지 보수에도 좋을 것이다.

 

아무튼 오늘은 이렇게 ComponentScan에 대해서 알아봤다.

 

끝.