스프링 빈(Bean)과 컴포넌트 스캔

스프링 빈이란?

Spring 컨테이너가 관리하는 자바 객체를 빈(Bean)이라는 용어로 부른다. 우리가 new 연산자로 어떤 객체를 생성했을 때 그 객체는 빈이 아니다. ApplicationContext.getBean()으로 얻어질 수 있는 객체가 빈이다.

즉, Spring에서의 빈은 ApplicationContext가 알고있는 객체, 즉 ApplicationContext가 만들어서 그 안에 담고있는 객체를 의미한다.

Spring 컨테이너에 빈 등록

Spring 에서 빈을 만드는 방법은 다양하지만 기본적으로 크게 두가지 방법이 있다. 

1. 빈 설정파일에 직접 빈을 등록
2. Component Scan

1. 빈 설정파일에 직접 빈을 등록하는 방법

 빈 설정파일에 직접 빈으로 등록할 수 있다. 빈 설정파일은 XML과 자바 설정파일로 작성할 수 있는데 최근 추세는 자바 설정파일을 좀 더 많이 사용한다.

 

 자바 설정파일은 자바 클래스를 생성해서 작성할 수 있으며 일반적으로 XxxConfiguration와 같이 명명한다.

그리고 클래스에 @Configuration 애노테이션을 붙인다. 그 안에 @Bean 애노테이션을 사용해 직접 빈을 정의한다.

@Configuration
public class SampleConfiguration {
    @Bean
    public SampleController sampleController() {
        return new SampleController;
    }
}

sampleController()에서 리턴되는 객체가 컨테이너 안에 빈으로 등록된다.

 

물론 이렇게 빈을 직접 정의해서 등록하면 @Component 애노테이션을 붙이지 않아도 된다.

 

@Configuration 애노테이션을 보면 이 애노테이션도 @Component를 사용하기 때문에 @ComponentScan의 스캔 대상이 되고 그에 따라 빈 설정파일이 읽힐때 그 안에 정의한 빈들이 컨테이너에 등록되는 것이다.

 

2. ComponentScan

@ComponentScan 과 @Component 을 사용해서 빈을 등록하도록 하는 방법이다.

간단히 말하면 @ComponentScan 애노테이션은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록하고 @Component 는 각 클래스가 컴포넌트 스캔의 대상이 되는 역할은 한다.

 

Spring 컨테이너를 만들고 그 안에 빈을 등록할때 사용하는 인터페이스들을 생명주기 콜백이라고 부른다.

생명주기 콜백 중에는 @Component 애노테이션을 찾아서 이 애노테이션이 붙어있는 모든 클래스의 인스턴스를 생성해 빈으로 등록하는 작업을 수행하는 어노테이션 프로세서가 등록되어있다.

 

Spring Boot 프로젝트에서 @ComonentScan 애노테이션이 붙어있는 클래스가 이에 해당한다.

 

코드로 Component Scan을 알아보자.

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

컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 그래서 excludeFilters 를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다.

@Component
public class MemoryMemberRepository implements MemberRepository {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

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

이전에 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다. @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;
   }
}

@Autowired 를 사용하면 생성자에서 여러 의존관계도 한번에 주입받을 수 있다.

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 가 붙은 모든 클래스를 스프링 빈으로 등록한다. 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름을 부여하면 된다.

컴포넌트 스캔 기본 대상

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

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

해당 클래스의 소스 코드를 보면 @Component 를 포함하고 있는 것을 알 수 있다.

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

 

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

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

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

 

 

References

인프런 - 김영한님의 스프링 핵심 원리 - 기본편을 수강하며 정리한 포스팅입니다.