Spring 컴포넌트 스캔, 의존관계 자동주입

 

이전 블로그 포스팅

https://wonuk.tistory.com/146

Spring 싱글톤 컨테이너

---

컴포넌트 스캔

지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나

XML의 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.

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

설정 정보도 커지고, 누락하는 문제도 발생한다.

 

역시 개발자는 반복을 싫어한다.

그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는

컴포넌트 스캔이라는 기능을 제공한다.

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

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

새로운 AutoAppConfig.java를 만들자.

 

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

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

 

이전에 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고,

의존관계도 직접 명시했다. 이제는 이런 설정 정보 자체가 없기 때문에,

의존관계 주입도 이 클래스 안에서 해결해야 한다.

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

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

 

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

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

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

 

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

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

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

 

@Autowired 의존관계 자동 주입

생성자에 @Autowired 를 지정하면,

스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.

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

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

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

 

탐색 위치와 기본 스캔 대상

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

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다.

그래서 꼭 필요한 위치부터 탐색하도록 시작해야한다.

@ComponentScan(
	basePackages = "hello.core",
}

basePackages : 탐색할 패키지의 시작 위치를 지정한다.

이 패키지를 포함해서 하위 패키지를 모두 탐색한다.

 

basePackages = {"hello.core", "hello.service"}

이렇게 여러 시작 위치를 지정할 수도 있다.

 

basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

 

만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

권장하는 방법

패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를

프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.

 

예를 들어서 프로젝트가 다음과 같이 구조가 되어 있으면

com.hello

com.hello.serivce

com.hello.repository

프로젝트 시작 루트(com.hello), 여기에 AppConfig 같은 메인 설정 정보를 두고,

@ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략한다.

 

이렇게 하면 com.hello 를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.

참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인

@SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다.

(그리고 이 설정안에 바로 @ComponentScan 이 들어있다!)

 

 

컴포넌트 스캔 기본 대상

컴포넌트 스캔은 @Component 뿐만 아니라

다음과 내용도 추가로 대상에 포함한다.

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

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

@Component
public @interface Controller {
}

@Component
public @interface Service {
}

@Component
public @interface Configuration {
}

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

 

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

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

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

 

필터

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

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

 

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

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

 

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

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

MyIncludeComponent 애노테이션을 추가한 클래스는 스프링 빈에 등록된다.

MyExcludeComponent 애노테이션을 추가한 클래스는 스프링 빈에 등록되지 않는다.

 

FilterType 옵션

1. ANNOTATION : 기본값, 애노테이션을 인식해서 동작한다.

2. ASSIGNABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작한다.

3. ASPECTJ : AspectJ 패턴 사용

4. REGEX : 정규 표현식

5. CUSTOM : TypeFilter 이라는 인터페이스를 구현해서 처리

 

참고
@Component 면 충분하기 때문에, includeFilters 를 사용할 일은 거의 없다.
excludeFilters 는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.
최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공한다.

 

중복 등록과 충돌

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

 

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

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

 

자동 빈 등록 vs 자동 빈 등록

컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데,

그 이름이 같은 경우 스프링은 오류를 발생시킨다.

ConflictingBeanDefinitionException 예외 발생

 

 

수동 빈 등록 vs 자동 빈 등록

수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버린다.)

 

수동 빈 등록시 남는 로그

Overriding bean definition for bean 'memoryMemberRepository' with a different 
definition: replacing

개발자가 의도적으로 이런 결과를 기대했다면,

자동 보다는 수동이 우선권을 가지는 것이 좋다.

 

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

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

 

그러면 정말 잡기 어려운 버그가 만들어진다.

항상 잡기 어려운 버그는 애매한 버그다.

그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면

오류가 발생하도록 기본 값을 바꾸었다.

 

수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러

Consider renaming one of the beans or enabling overriding by setting 
spring.main.allow-bean-definition-overriding=true

---

의존관계 자동주입

의존관계 주입은 크게 4가지 방법이 있다.

1. 생성자 주입
2. 수정자 주입(setter 주입)
3. 필드 주입
4. 일반 메서드 주입

 

생성자 주입

이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법이다.

지금까지 진행했던 방법이 바로 생성자 주입이다.

 

특징

생성자 호출시점에 딱 1번만 호출되는 것이 보장된다.

불변, 필수 의존관계에 사용

 

중요! 생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입 된다.

물론 스프링 빈에만 해당한다.

 

수정자 주입(setter 주입)

setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서

의존관계를 주입하는 방법이다.

 

특징

선택, 변경 가능성이 있는 의존관계에 사용한다.

자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.

자바빈 프로퍼티
자바에서는 과거부터 필드의 값을 직접 변경하지 않고,
setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는
규칙을 만들었는데, 그것이 자바빈 프로퍼티 규약이다.

참고
@Autowired 의 기본 동작은 주입할 대상이 없으면 오류가 발생한다.
주입할 대상이 없어도 동작하게 하려면
@Autowired(required = false) 로 지정하면 된다.

 

필드 주입

이름 그대로 필드에 바로 주입하는 방법이다.

특징 코드가 간결해서 많은 개발자들을 유혹하지만

외부에서 변경이 불가능해서 테스트 하기 힘들다는 치명적인 단점이 있다.

DI 프레임워크가 없으면 아무것도 할 수 없다.

사용하지 말자!

 

애플리케이션의 실제 코드와 관계 없는 테스트 코드

스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

참고
순수한 자바 테스트 코드에는 당연히 @Autowired가 동작하지 않는다.
@SpringBootTest 처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능하다.

 

다음 코드와 같이 @Bean 에서 파라미터에 의존관계는 자동 주입된다.

수동 등록시 자동 등록된 빈의 의존관계가 필요할 때 문제를 해결할 수 있다.

@Bean
OrderService orderService(MemberRepository memberRepoisitory, DiscountPolicy 
discountPolicy) {
	new OrderServiceImpl(memberRepository, discountPolicy)
}

 

일반 메서드 주입

일반 메서드를 통해서 주입 받을 수 있다.

 

특징

한번에 여러 필드를 주입 받을 수 있다.

일반적으로 잘 사용하지 않는다.

 

참고
어쩌면 당연한 이야기이지만 의존관계 자동 주입은
스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다.
스프링 빈이 아닌 Member 같은 클래스에서
@Autowired 코드를 적용해도 아무 기능도 동작하지 않는다.

 

옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때가 있다.

그런데 @Autowired 만 사용하면 required 옵션의 기본값이 true 로 되어 있어서

자동 주입 대상이 없으면 오류가 발생한다.

 

자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.

 

@Autowired(required=false) :

자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨

 

org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력된다.

 

Optional<> : 자동 주입할 대상이 없으면 Optional.empty 가 입력된다.

참고
@Nullable, Optional은 스프링 전반에 걸쳐서 지원된다.
예를 들어서 생성자 자동 주입에서 특정 필드에만 사용해도 된다.

 

결론 : 생성자 주입을 선택해라!

과거에는 수정자 주입과 필드 주입을 많이 사용했지만,

최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다.

 

불변

대부분의 의존관계 주입은 한번 일어나면

애플리케이션 종료시점까지 의존관계를 변경할 일이 없다.

대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다.(불변해야 한다.)

 

수정자 주입을 사용하면, setXxx 메서드를 public으로 열어두어야 한다.

누군가 실수로 변경할 수 도 있고, 변경하면 안되는 메서드를 열어두는 것은

좋은 설계 방법이 아니다.

 

생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로

이후에 호출되는 일이 없다. 따라서 불변하게 설계할 수 있다.

 

누락

생성자 주입을 사용하면 다음처럼 주입 데이터를 누락 했을 때 컴파일 오류가 발생한다.

그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.

 

 

final 키워드

생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다.

그래서 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다.

기억하자! 컴파일 오류는 세상에서 가장 빠르고, 좋은 오류다!

 

참고
수정자 주입을 포함한 나머지 주입 방식은
모두 생성자 이후에 호출되므로,
필드에 final 키워드를 사용할 수 없다.
오직 생성자 주입 방식만 final 키워드를 사용할 수 있다.

 

정리

생성자 주입 방식을 선택하는 이유는 여러가지가 있지만,

프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이기도 하다.

 

기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을

옵션으로 부여하면 된다. 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.

 

항상 생성자 주입을 선택해라! 그리고 가끔 옵션이 필요하면 수정자 주입을 선택해라.

필드 주입은 사용하지 않는게 좋다.

 

---

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

 

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

 

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

어떤 경우에 설정 정보를 통해서 수동으로 빈을 등록하고,

의존관계도 수동으로 주입해야 할까?

 

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

스프링은 @Component 뿐만 아니라 @Controller , @Service , @Repository 처럼

계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다.

 

거기에 더해서 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고,

스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.

 

설정 정보를 기반으로 애플리케이션을 구성하는 부분과

실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만,

개발자 입장에서 스프링 빈을 하나 등록할 때 @Component 만 넣어주면 끝나는 일을

@Configuration 설정 정보에 가서 @Bean 을 적고, 객체를 생성하고, 주입할 대상을

일일이 적어주는 과정은 상당히 번거롭다.

또 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 된다.

그리고 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

 

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

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

 

업무 로직 빈

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

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

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

 

업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼

어느정도 유사한 패턴이 있다.

이런 경우 자동 기능을 적극 사용하는 것이 좋다.

보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.

 

1. 기술 지원 빈

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

데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을

지원하기 위한 하부 기술이나 공통 기술들이다.

 

기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고,

보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다.

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

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

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

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

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

 

 

2. 비즈니스 로직 중에서 다형성을 적극 활용할 때

의존관계 자동 주입 - 조회한 빈이 모두 필요할 때, List, Map

DiscountService 가 의존관계 자동 주입으로 Map 에 주입을 받는 상황을 생각해보자.

 

여기에 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일지 코드만 보고

한번에 쉽게 파악할 수 있을까? 내가 개발했으니 크게 관계가 없지만,

만약 이 코드를 다른 개발자가 개발해서 나에게 준 것이라면 어떨까?

 

자동 등록을 사용하고 있기 때문에 파악하려면 여러 코드를 찾아봐야 한다.

이런 경우 수동 빈으로 등록하거나 또는 자동으로하면

특정 패키지에 같이 묶어두는게 좋다! 핵심은 딱 보고 이해가 되어야 한다!

 

 

참고로 스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 예외다.

이런 부분들은 스프링 자체를 잘 이해하고 스프링의 의도대로 잘 사용하는게 중요하다.

 

스프링 부트의 경우 DataSource 같은 데이터베이스 연결에 사용하는 기술 지원 로직까지

내부에서 자동으로 등록하는데, 이런 부분은 메뉴얼을 잘 참고해서

스프링 부트가 의도한 대로 편리하게 사용하면 된다.

 

반면에 스프링 부트가 아니라 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면

수동으로 등록해서 명확하게 들어내는 것이 좋다.

 

정리

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

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

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

---

출처

인프런 - 김영한 - 스프링 핵심원리 - 기본편

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