의존관계 자동 주입
다양한 의존관계 주입 방법
- 생성자 주입
- 수정자 주입(setter 주입)
- 필드 주입
- 일반 메서드 주입
생성자 주입
생성자에 @Autowired
- 스프링 빈을 생성할 때 생성자의 @Autowired를 보고 스프링 컨테이너에서 의존 관계를 주입해준다.
- 생성자 호출시점에 딱 1번만 호출되는 것이 보장된다.
- "불변, 필수" 의존관계에 사용 (보통 생성자에는 null이 아닌 값을 넣어야 하는 암묵적 룰)
컴포넌트의 생성자가 딱 1개 있으면 @Autowired 생략 가능
수정자 주입(setter 주입)
자바빈 프로퍼티 규약의 수정자 setter(setXxx)에 @Autowired
- 스프링 빈을 모두 등록한 후, 의존 관계를 주입할 때 @Autowired를 보고 스프링 컨테이너에서 스프링 빈을 주입해준다.
- "선택, 변경" 가능성이 있는 의존관계에 사용 (의존관계가 있는 스프링 빈이 등록되지 않더라도 사용 가능)
참고: @Autowired 의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false) 로 지정
필드 주입
필드에 @Autowired
- 코드가 간결하긴 하지만, 외부에서 변경이 불가능해서 테스트 하기 힘들다는 치명적인 단점이 있다.
- DI 프레임워크가 없으면(스프링 없는 순수한 테스트) 아무것도 할 수 없다.
- 스프링 포함 테스트 코드, 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용할 것
참고: 순수한 자바 테스트 코드에는 당연히 @Autowired가 동작하지 않는다. @SpringBootTest 처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능하다.
참고: @Bean 에서 파라미터에 의존관계는 자동 주입된다. 수동 등록시 자동 등록된 빈의 의존관계가 필요할 때 문제를 해결할 수 있다
일반 메서드 주입
일반 메서드(보통 초기화 용도의 메서드)에 @Autowired
- 한번에 여러 필드를 주입 받을 수 있다.
- 일반적으로 잘 사용하지 않는다.
참고: 의존관계 자동 주입(@Autowired)은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다.
옵션 처리
@Autowired 만 사용하면 required 옵션의 기본값이 true 로 되어 있어서 자동 주입 대상이 없으면 오류가 발생한다.
자동 주입 대상을 옵션으로 처리하는 방법
- @Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨
- org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력됨
- Optional<> : 자동 주입할 대상이 없으면 Optional.empty 가 입력
참고: @Nullable, Optional은 스프링 전반에 걸쳐서 지원된다. 예를 들어서 생성자 자동 주입에서 특정 파라미터에만 사용해도 된다.
생성자 주입을 선택하라
불변
대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다.
오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다.
수정자 주입을 사용하면, setter를 public으로 열어두어야 한다. 누군가 실수로 변경할 수 도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.
생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 또 호출되는 일이 없다.
누락
의존관계 주입의 누락 방지
@Autowired 가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만, 프레임워크 없이 순수한 자바 코드로만 단위 테스트를 수행할 때
- 수정자 주입을 사용하면 의존관계 주입이 안된 빈이 실제로 사용될 때 런타임 오류(Null Point Exception)가 발생한다.
- 생성자 주입을 사용하면 주입 데이터를 누락했을 때 컴파일 오류가 발생한다.
final 키워드
생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다.
누락시 컴파일 오류가 발생하여 IDE 상에서 어떤 값을 필수로 주입해야 하는지 알 수 있다.
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
}
//...
}
java: variable discountPolicy might not have been initialized
컴파일 오류는 세상에서 가장 빠르고, 좋은 오류
정리
생성자 주입 방식을 선택하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이기도 하다.
기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하자. 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.
롬복과 최신 트랜드
생성자 주입은 비교적 코드가 많다. ( 생성자에 의존 관계를 주입받을 파라미터 명시)
생성자 주입을 필드 주입처럼 편리하게 사용하는 방법?
롬복 세팅
plugins {
id 'org.springframework.boot' version '2.6.7'
id 'io.spring.dependency-management' version '1.0.11.RELEASE'
id 'java'
}
group = 'hello'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'
//lombok 설정 추가 시작
configurations {
compileOnly {
extendsFrom annotationProcessor
}
}
//lombok 설정 추가 끝
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
//lombok 라이브러리 추가 시작
compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
testCompileOnly 'org.projectlombok:lombok'
testAnnotationProcessor 'org.projectlombok:lombok'
//lombok 라이브러리 추가 끝
}
tasks.named('test') {
useJUnitPlatform()
}
1. File-Settings > plugin lombok 검색 > 설치 실행 (재시작)
2. File-Settings > Annotation Processors 검색 > Enable annotation processing 체크 (재시작)
3. 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인
롬복 적용 코드
@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
}
- 생성자가 딱 1개만 있으면 @Autowired 를 생략할 수 있다.
- 롬복 라이브러리가 제공하는 @RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다. (코드에는 보이지 않지만 실제 호출 가능하다.)
- 롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해준다.
정리
최근에는 생성자를 딱 1개 두고, @Autowired 를 생략하는 방법을 주로 사용한다. 여기에 Lombok 라이브러리의 @RequiredArgsConstructor 함께 사용하면 기능은 다 제공하면서, 코드는 깔끔하게 사용할 수 있다.
조회 빈이 2개 이상 - 문제
@Autowired는 타입으로 빈을 조회한다.
의존관계 객체를 인터페이스 타입으로 받으면, 하위 타입의 구현체 여러 개가 스프링 빈으로 등록됐을 시 조회된 빈이 2개 이상일 수 있다. -> NoUniqueBeanDefinitionException
1. 하위 타입으로 지정 -> DIP를 위배, 유연성 저하.
이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안된다.
2. 스프링 빈을 수동 등록해서 문제를 해결
3. 의존 관계 자동 주입에서 해결하는 방법
@Autowired 필드 명 매칭
1. 타입 매칭 시도
2. 타입 매칭의 결과가 2개 이상일 때 필드 명, 파라미터 명으로 빈 이름 매칭
필드나 파라미트 명을 주입하고자 하는 빈의 이름(메서드 명)으로 변경
@Autowired
private DiscountPolicy rateDiscountPolicy@Qualifier 사용
빈 등록시 @Qualifier(구분자) 붙인다.
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}
생성자 자동 주입 예시
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
수정자 자동 주입 예시
@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
return discountPolicy;
}
1. @Qualifier끼리 매칭
2. 1번에서 못 찾으면 빈 이름으로 매칭
3. 2번에서 못 찾으면 NoSuchBeanDefinitionException 예외 발생
단점은 주입 받을 때 다음과 같이 모든 코드에 @Qualifier 를 붙여주어야 하는 점
@Primary 사용
@Primary 는 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면 @Primary 가 우선권을 가진다.
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}
@Component
public class FixDiscountPolicy implements DiscountPolicy {}
@Autowired로 DiscountPolicy 를 의존 관계 주입 받으면 @Primary 가 붙은 RateDiscountPolicy 가 주입된다.
@Primary와 @Qualifier 활용
코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자.
메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary 를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier 를 지정해서 명시적으로 획득하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다. 물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 @Qualifier 를 지정해주는 것은 상관없다.
우선순위
스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다.
따라서 @Qualifier 가 우선권이 높다.
애노테이션 직접 만들기
@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안된다.
-> 애노테이션을 정의해서 사용
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}
- @Qualifier처럼 쓸 수 있는 애노테이션을 만드려면, @interface Qualifier에 포함된 애노테이션을 받아서 새로 정의해야 한다.
- 애노테이션에는 상속이라는 개념이 없다. 이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다.
조회한 빈이 모두 필요할 때, List, Map
서비스 개발시 동적으로 빈을 선택할 필요가 있을 때, List 또는 Map으로 받는다.
Map<빈 이름, 빈 객체>, List<빈 객체>
해당하는 타입의 스프링 빈이 없으면 빈 컬렉션이나 Map을 주입한다.
예) 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있는 상황
private final Map<String, DiscountPolicy> policyMap;
private final List<DiscountPolicy> policies;
//생성자 주입
public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies) {
this.policyMap = policyMap;
this.policies = policies;
}자동, 수동의 올바른 실무 운영 기준
1. 편리한 자동 기능을 기본으로 사용하자
결론부터 이야기하면, 스프링이 나오고 시간이 갈수록 점점 자동을 선호하는 추세다.
설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만, 개발자 입장에서 스프링 빈을 하나 등록할 때의 과정이 상당히 번거롭다.
또 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 된다.
결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.
2. 그러면 수동 빈 등록은 언제 사용하면 좋을까?
애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.
- 업무 로직 빈: 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
- 기술 지원 빈: 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.
업무 로직은 숫자도 매우 많고, 한 번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.
기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다. 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 들어나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.
비즈니스 로직 중에서 다형성을 적극 활용할 때
의존관계 자동 주입 - 조회한 빈이 모두 필요할 때, 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일지 코드만 보고 한번에 쉽게 파악하기 어렵다. 자동 등록을 사용하고 있기 때문에 파악하려면 여러 코드를 찾아봐야 한다.
이런 경우 수동 빈으로 등록하거나, 자동이라면 특정 패키지에 같이 묶어두는게 좋다.
핵심은 딱 보고 이해가 되어야 한다!
ex) 조회되는 여러 개의 빈(다형성)을 List, Map으로 받을 때
어떤 빈들이 주입될지 알기 어렵다. 이 경우, 이 빈들만을 수동 등록하는 별도의 설정 파일을 만들자.
@Configuration
public class DiscountPolicyConfig {
@Bean
public DiscountPolicy rateDiscountPolicy() {
return new RateDiscountPolicy();
}
@Bean
public DiscountPolicy fixDiscountPolicy() {
return new FixDiscountPolicy();
}
}
참고: 스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들의 경우, 스프링 자체를 잘 이해하고 스프링의 의도대로 잘 사용하는게 중요하다. 스프링 부트의 경우 DataSource 같은 데이터베이스 연결에 사용하는 기술 지원 로직까지 내부에서 자동으로 등록하는데, 이런 부분은 메뉴얼을 잘 참고해서 스프링 부트의 의도대로 편리하게 사용하면 된다. 반면에 스프링 부트가 아니라 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 드러내는 것이 좋다.
정리
- 편리한 자동 기능을 기본으로 사용하자
- 직접 등록하는 기술 지원 객체는 수동 등록
- 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해보자
*테스트 코드로 이동: ctrl+shift+T
*해당 클래스 파일 or 객체 사용하는 곳으로 이동: ctrl+B
