스프링 기본 17 - 컴포넌트 스캔

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

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

코드로 컴포넌트 스캔과 의존관계 자동 주입을 알아 보자

먼저 기존 AppConfig.java는 과거 코드와 테스트를 유지하기 위해 남겨두고, 새로운 AutoAppConfig.java를 만들자

 

 

package com.hello.core;

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

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

 

@ComponentScan 는  @Component 어노테이션이 붙은 클래스를 찾아서 자동으로 스프링 빈에 등록해준다. 괄호 안에 excludeFilters는 @Component 어노테이션이 붙은 클래스를 찾아서 자동으로 스프링 빈에 등록해 주는데, 그중에서 제외할 것을 지정해 주는 것이다.

 

@Configration이 붙은 AppConfig는 이미 수동으로 등록해준 빈 메서드들이 존재하므로 자동으로 컴포넌트를 스캔해서 스프링빈에 객체 인스턴스를 등록하면 충돌이 날 수 있기때문에 예외로 등록해준다.

 

• 컴포넌트스캔을 사용하려면 먼저 @CompomemtScan을 설정 정보에 붙여주면 된다.
• 기존 AppConfig와 다르게 @Bean으로 등록한 클래스가 하나도 없다.

➕참고
컴포턴트 스캔을 사용하면 @Configuration이 분은 설정 정보도 자동으로 등록되기 때문 AppConfig, TestConfig등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 그래서 excludeFilter를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해 이 방법이 선택되었다.

 

컴포넌트 스캔은 이름 그래로 @Component어노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다. @Component를 붙여주자.

 

➕참고
@Configuration이 컴포넌트 스캔의 대상이 된 이유도 @Configuration소스코드를 열어보면 @Component어노테이션이 붙어 있기 때문이다.

 

이제 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 어노테이션을 붙여주자

 

MemberServiceImpl @Component, @Autowired 어노테이션 추가

@Component
public class MemberServiceImpl implements  MemberService {
    //MemberService에 선언된 변수는 memberRepository는
    private MemberRepository memberRepository;

   	@Autowired // ac.getBean(MemberRepository.class)
    public MemberServiceImpl(MemberRepository memberRepository){
        this.memberRepository = memberRepository;
    }
}

 

@Autowired 어노테이션을 위와 같이 생성자 메서드 위에 붙여주면 스프링 컨테이너가 자동으로 스프링 컨테이너 안에 생성된 MemberRepository 타입의 객체 인스터스를 찾아와서  자동으로 의존 관계주입을 해준다.

 

즉 @Autowired 를 의존관계를 설정해주는 어노테이션이라고 생각하면된다.

 

• 이전에 AppConfig에서는 @Bean으로 설정 정보를 작성했고, 의존관계도 직접 명시했다. 이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 준입도 클래스 안에서 해결해야한다.
• @Autowired는 의존관계를 자동으로 주입해준다. 

 

AutoAppConfig를 사용한 객체 인스턴스 Test

package com.hello.core.scan;

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

public class AutoAppConfigTest {

    @Test
    void basicScan(){
        ApplicationContext ac =
                new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        Assertions.assertInstanceOf(MemberService.class,memberService);
    }
}

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

 

ClassPathBeanDefinitionScanner

 

BeanFactory

 

Autowiring

 

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

 

1. @ComponentScan

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

 

2. @Autowired 의존 관계 주입

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

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

 

[출처 - 스프링 핵심 원리 - 기본편]

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8

스프링 핵심 원리 - 기본편 - 인프런 | 강의