[스프링 핵심 원리 - 기본편] - 17. 컴포넌트 스캔과 의존관계 자동 주입 / 자동, 수동의 올바른 실무 운영 기준

 

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

 

@Configuration
public class AppConfig {

    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }

    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

 

지금까지 스프링 빈을 등록할 때는

 

자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.

 

이렇게 등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀찮다

 

 

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

또 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다.

 

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

}

 

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

 

컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.

 

기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다!

 

 

필터

 

참고: 컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에,

 

AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다.

 

그래서 excludeFilters 를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다.

 

보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이 방법을 선택했다.

 

 

@Configuration
@ComponentScan(
        includeFilters = @Filter(type = FilterType.ANNOTATION, classes =
                MyIncludeComponent.class),
        excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
                MyExcludeComponent.class)

 

includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.

 

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

 

 

 

참고: @Component 면 충분하기 때문에, includeFilters 를 사용할 일은 거의 없다.

 

excludeFilters 는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.

 

>  특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기 보다는

 

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

 

 

 

 

@Component
public class MemberServiceImpl implements MemberService {

 

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

 

 

 

@Bean
public MemberService memberService() {
    return new MemberServiceImpl(memberRepository());
}

 

전에 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다.

 

 

 

@Autowired
public MemberServiceImpl(MemberRepository memberRepository) {
    this.memberRepository = memberRepository;
}

 

이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.

 

@Autowired 는 의존관계를 자동으로 주입해준다. 

 

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

 

 

 

테스트 해보기

 

public class AutoAppConfigTest {

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

        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

 

AppConfig 가 아닌 

 

AutoAppConfig 설정정보를 구성정보로 사용하는 컨테이너 생성 

 

실행해보면 기존과 같이 잘 동작하는 것을 확인할 수 있다.

 

로그를 잘 보면 컴포넌트 스캔이 잘 동작하는 것을 확인할 수 있다.

 

 

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

 

1. @ComponentScan

 

 

@ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.

 

 

이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

 

빈 이름 기본 전략: MemberServiceImpl 클래스 memberServiceImpl

 

 

빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면

 

@Component("memberService2") 이런식으로 이름을 부여하면 된다.

 

 

 

2. @Autowired 의존관계 자동 주입

 

 

생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.

 

이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.

 

getBean(MemberRepository.class) 와 동일하다고 이해하면 된다. 

 

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

 

 

 

중복 등록과 충돌

 

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까?

 

다음 두가지 상황이 있다.

 

1. 자동빈등록vs자동빈등록
2. 수동빈등록vs자동빈등록

 

 

자동 빈 등록 vs 자동 빈 등록

 

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

 

ConflictingBeanDefinitionException 예외 발생

 

 

 

@Component("service")
public class MemberServiceImpl implements MemberService {

@Component("service")
public class OrderServiceImpl implements OrderService {

이름이 같은 경우 

 

ConflictingBeanDefinitionException 예외 발생

 

 

 

수동 빈 등록 vs 자동 빈 등록

 

@Component
public class MemoryMemberRepository implements MemberRepository {

자동 빈 등록 

 

 

 

@Bean(name = "memberRepository")
public MemberRepository memberRepository() {
    return new MemoryMemberRepository();
}

수동 빈 등록 

 

 

이 경우 수동 빈 등록이 우선권을 가진다.

 

( 수동 빈이 자동 빈을 오버라이딩 해버린다 .)

 

 

물론 개발자가 의도적으로 이런 결과를 기대했다면, 자동 보다는 수동이 우선권을 가지는 것이 좋다.

 

하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는

 

여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다!

 

 

 

스프링 부트인 CoreApplication 을 실행해보면 오류를 볼 수 있다.

 

 

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

 

 

 

자동, 수동의 올바른 실무 운영 기준

 

어떤 경우에 컴포넌트 스캔과 자동 주입을 사용하고

 

어떤 경우에 설정 정보를 통해서 수동으로 빈을 등록하고, 의존관계도 수동으로 주입해야 할까?

 

결론부터 이야기하면, 스프링이 나오고 시간이 갈 수록 점점 자동을 선호하는 추세다.

 

수동 빈 등록은 언제 사용하면 좋을까?

 

 

애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.

업무 로직 빈: 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스,

 

데이터 계층의 로직을 처리하는 리포지토리등이 모두 업무 로직이다.

 

보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.

 

 

 

기술 지원 빈: 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다.

 

데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

 

 

 

업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있다.

 

이런 경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.

 

 

 

기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다.

 

그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 드러나지만,

 

기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다.

 

그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.

 

 

 

 

애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서

 

딱! 설정 정보에 바로 나타나게 하는 것이 유지보수 하기 좋다.

 

 

 

 

정리

편리한 자동 기능을 기본으로 사용하자

직접 등록하는 기술 지원 객체는 수동 등록

다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해보자

 

 

 

 

 

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/dashboard

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