[스프링 핵심 원리 - 기본편] 의존관계 자동 주입

본 게시글은 김영한님의 인프런(Inflean)강의 스프링 핵심원리 - 기본편 강의를 수강하고 공부한 내용을 정리한 글입니다.

1. 다양한 의존관계 주입 방법

의존관계 주입은 크게 4가지

생성자 주입
수정자 주입(setter 주입)
필드 주입
일반 메서드 주입

생성자 주입

생성자를 통해 의존관계를 주입받는 방법

특징
- 생성자 호출 시점에 딱 1번만 호출되는 것이 보장된다.
- 불변, 필수 의존 관계에 사용

private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;

@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

❗️생성자가 딱 1개 있으면 @Autowired를 생략 해도 자동 주입된다. -> 스프링 빈에만 해당

수정자 주입(setter 주입)

setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법
특징
- 선택, 변경 가능성이 있는 의존관계에 사용
- 자바 빈 프로퍼티 규약의 수정자 메서드(setter) 방식을 사용하는 방법
  - 참고: 자바 빈 프로퍼티 규약 = 필드의 값을 변경하지 않고, setAbc, getAbc 메서드를 통해 값을 수정하거나 읽는 규칙

private MemberRepository memberRepository;

@Autowired
public void setMemberRepository(MemberRepository memberRepository) {
	this.memberRepository = memberRepositoryl
}

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

필드 주입

필드에 바로 주입하는 방법
특징
- 코드가 간결하지만 외부에서 변경이 불가능해서 테스트하기 힘들고, DI 프레임워크가 없으면 아무것도 할 수 없기 때문에 사용하지 않는것이 좋음
- 순수한 자바 테스트 코드에는 @Autowired가 동작하지 않으며 @SpringBootTest처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능함
- 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

@Component
public class OrderServiceImpl implements OrderService {

    @Autowired
    private MemberRepository memberRepository;

    @Autowired
    private DiscountPolicy discountPolicy;
}

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

참고: 다음과 같이 @Bean에서 파라미터에 의존관계는 자동 주입된다. 수동 등록 시 자동 등록된 빈의 의존관계가 필요할 때 문제를 해결할 수 있다.

일반 메서드 주입

일반 메서드를 통해서 주입받을 수 있음
특징
- 한 번에 여러 필드를 주입받을 수 있다.
- 일반적으로 잘 사용하지 않음.

private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;

@Autowired
public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy){
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy
}

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

옵션 처리

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

그런데 @Autowired만 사용하면 required 옵션의 기본값이 True로 되어 있어서 자동 주입 대상이 없으면 오류가 발생한다.

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

@Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출안됨
org.springframework.lang.@Nullable: 자동 주입할 대상이 없으면 null이 입력됨
Optional <> : 자동 주입할 대상이 없으면 Optional.empty가 입력됨

@Autowired(required=false)
public void setBean1(Member member) {
	System.out.println("setNoBean1 = " + member);
}
//null 호출
@Autowired
public void setBean2(@Nullable Member member) {
	System.out.println("setNoBean2 = " + member);
}
//Optional.empty호출
@Autowired(required=false)
public void setNoBean3(Optional<Member> member) {
	System.out.println("setNoBean3 = " + member);
}

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

생성자 주입을 선택해야 되는 이유

과거에는 수정자 주입과 필드 주입을 많이 사용했으나, 최근 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다.

그 이유는 다음과 같다.

불변

대부분의 의존관계 주입은 한 번 일어나면 애플리케이션 종료 시점까지 의존관계를 변경할 일이 없다. 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안 됨(오히려 불변해야 함)
수정자 주입을 사용하면, setXXX 메서드를 public으로 열어두어야 함
누군가 실수로 변경할 수 도 있고, 변경하면 안 되는 메서드를 열어두는 것은 좋은 설계가 아님
생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 노출될 일은 없다. 따라서 불변하게 설계할 수 있다.

누락

프레임 워크 없이 순수한 자바 코드를 유닛 테스트 할 때 아래 수정관계인 경우, NullPointException이 발생함(의존관계 주입 누락)

public class OrderServiceImpl implements OrderService {

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

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

    @Autowired
    public void setDiscountPolicy(DiscountPolicy discountPolicy) {
    	this.discountPolicy = discountPolicy;
    }
    //...
}

@Test
void createOrder() {
    OrderServiceImpl orderService = new OrderServiceImpl();
    orderService.createOrder(1L, "itemA", 10000);
}

생성자 주입을 사용하면 주입 데이터를 누락했을 때 컴파일 오류가 발생함
- IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있음

final 키워드

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

생성자에서 혹시라도 값이 설정되어 있는 오류를 컴파일 시점에서 막아줌

private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;

@Autowired
puvlic OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
	this.memberRepository = memberRepository;
}

해당 코드를 보면 discountPolicy에 값을 설정해야 하는데, 이 부분이 누락되었다. 자바는 컴파일 시점에 다음 오류를 발생시킴
java: variable discountPolicy might not have been initailized
컴파일 오류는 세상에서 가장 빠르고, 좋은 오류다

롬복과 최신 트렌드

롬복 라이브러리 적용 방법

build.gradle에 라이브러리 및 환경 추가

configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}

dependencies {
	compileOnly 'org.projectlombok:lombok'
	annotationProcessor 'org.projectlombok:lombok'
	testAnnotationProcessor('org.projectlombok:lombok')
}

[File → Settings] → plugin → lombok 검색 설치 실행 (재시작)
1. Spring Initializr에서 Dependency에 Lombok 추가
[File → Settings] → Annotation Processors 검색 → Enable annotation processing 체크 (재시작)

롬복

getter, setter, toString 등의 메서드 작성 코드를 줄여주는 라이브러리로, 긴 코드를 짧게 줄일 수 있음 (기능은 동일)

아래 5개의 어노테이션을 @Data 하나만 붙여 나타낼 수도 있음
이외에도 여러 어노테이션을 제공하며, 이를 기반으로 코드를 컴파일 과정에서 생성하는 주는 방식으로 동작함
- 코딩 과정에서는 어노테이션만 보이지만, 실제로 컴파일된 결과물(.class)에는 코드가 생성돼 있음

@Getter
@Setter
@ToString
@NoArgsConstructor
@AllArgsConstructorpublic
class CategoryModel {
      private String id;
      private String parentId;
      private String name;
      private Long depthLevel;
      private Long seq;
      private String userYn;      
}

장점과 주의사항
- 복잡하고 반복되는 코드를 줄여 가독성과 생산성을 높일 수 있음
- 이해하지 않고 사용하면 무한 재귀 호출 또는 순환 참조의 문제 등이 발생할 수 있음

@RequiredArgsConstructor

final 키워드가 붙은 필드를 모아 생성자를 자동으로 만들어 줌

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
}

생성자를 딱 1개를 두고, @Autowired를 생략하는 방법을 주로 사용함
- 여기에 @RequiredArgsConstructor를 사용하면 코드를 더 깔끔하게 작성할 수 있음

조회 빈이 2개 이상일 때

문제

@Autowired는 ac.getBean(Abc.class)와 유사하게 동작함 = 타입으로 조회

'스프링 빈 조회'에서 학습했듯이 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생함

NoUniqueBeanDefinitionException: No qualifying bean of type
...
expected single matching bean but found 2
...

조회 대상 빈이 2개 이상일 때 해결 방법

하위 타입으로 지정 > DIP 위반 및 유연성 저하 & 이름만 다르고 타입이 똑같은 빈이 있으면 해결 불가
스프링 빈 수동 등록
의존관계 자동 주입에서 해결하는 방법
- @Autowired 필드 명 매칭
- @Qualifier > @Qualifier 끼리 매칭 > 빈 이름 매칭
- @Primary 사용

DevBridge