[Spring] @Autowired

 

 

 

@Autowired

@Autowired란 이름 그대로 자동으로 의존 관계를 연결(주입) 시켜주는 어노테이션입니다.

 

@ComponentScan을 사용하는 경우, 의존관계에 대한 설정을 해주기 위해 사용합니다.

 

필요한 객체의 "타입"에 해당하는 빈을 찾아서 자동으로 주입시켜줍니다.

 

 

 

 

 

 

 

의존관계 자동 주입

의존관계를 주입하는 방법에는 다음과 같은 3가지 방법이 있습니다.

• 생성자 주입
• 수정자 주입 (Setter 주입)
• 필드 주입

 

 

 

 

 

 

 

 

 

 

생성자 주입

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

 

 

특징

• 생성자 호출시점에 단 1회만 호출되는 것이 보장됩니다.
• 불변, 필수 의존관계에 사용합니다.

 

 

 

@Component
public class OrderServiceImpl implements OrderService {

	private final MemberRepository memberRepository;
    
    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository) {
    	this.memberRepository = memberRepository;
    }
}

 

 

 

 

장점

• 생성자가 하나인 경우에는 @Autowired를 사용하지 않아도 자동으로 적용됩니다. 
• 의존성 주입 대상의 필드를 final로 설정하여, 불변 객체를 선언할 수 있습니다.
• 또한 final로 설정한 경우 롬복에서 제공하는 @Requiredargsconstructor 어노테이션을 통해 간편하게 설정할 수 있습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

수정자 주입

setter를 통해 의존관계를 주입하는 방법입니다.

 

 

특징

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

@Component
public class OrderServiceImpl implements OrderService {

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

 

 

 

 

 

 

 

 

 

 

필드 주입

필드에 바로 주입하는 방법입니다.

 

 

특징

• 코드가 간결합니다. 그러나 외부에서 변경이 불가능하기에 테스트하기 힘들어집니다.
• DI 프레임워크가 없으면 아무것도 할 수 없습니다.
• 애플리케이션의 실제 코드와 관계 없는 테스트 코드 등에서만 사용하는 것을 권장합니다.

@Component
public class OrderServiceImpl implements OrderService {

	@Autowired
	private final MemberRepository memberRepository;
    
}

 

 

 

 

 

 

 

 

 

 

옵션 처리

@Autowired를 사용할 때 주입할 스프링 빈이 없어도 동작해야 한다면 어떻게 해야 할까요?

기본적으로 @Autowired는 주입할 대상이 없으면 오류가 발생합니다.

 

 

 

 

자동 주입 대상을 옵션으로 처리하는 방법은 아래와 같습니다.

• @Autowired(required = false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출이 안됩니다. (생성자에는 적용되지 않습니다.)
• @Nullable : 자동 주입할 대상이 없으면 null 이 입력됩니다.
• Optional : 자동 주입할 대상이 없으면 Optional.empty가 입력됩니다.

@Autowired(required = false)
public void setNoBean1(Member member) {
	System.out.println("noBean1 = " + member);	
}

@Autowired
public void setNoBean2(@Nullable Member member) {
	System.out.println("noBean2 = " + member);	
}

@Autowired
public void setNoBean3(Optional<Member> member) {
	System.out.println("noBean3 = " + member);	
}

 

 

 

참고

생성자 주입 시 Null 을 허용하려면 어떻게 해야 할까요?

@Component
public class TestBean {

    private final Member member;

    @Autowired
    public TestBean(@Autowired(required = false) Member member) {
        System.out.println("member = " + member);
        this.member = member;
    }
}

 

 

 

혹은 @Nullable이나 Optional을 사용할 수 있습니다

package com.example.constructautowired;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;

@Component
public class TestBean {

    private final Member member;

    @Autowired
    public TestBean(@Nullable Member member) {
        System.out.println("member = " + member);
        this.member = member;
    }
}

 

 

 

 

 

 

 

 

 

 

무슨 방법이 좋나요?

생성자 주입을 추천합니다.

 

 

스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장하는데, 그 이유를 알아보겠습니다.

 

 

 

 

불변

• 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없습니다. 오히려 대부분은 종료 전까지 변하면 안됩니다.
• 수정자 주입을 사용한다면 setter 를 public 으로 외부에 노출시켜야합니다.
• 즉 누군가 실수로 수정할 가능성이 생기게 되는 것입니다.

 

누락

• 수정자 주입을 사용하는 경우 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생합니다.
• 그러나 테스트 코드를 작성하여 실행하는 경우, 프레임워크가 없이 실행하게 되는데, 이때 누락을 하면 NPE가 발생합니다.
• 생성자 주입을 사용하면 데이터를 누락했을 때  컴파일 오류가 발생합니다.

 

 

final 키워드

• 생성자 주입을 사용하면 필드에 final 키워드를 사용하여 생성자에 값이 설정되지 않았을 경우, 이를 컴파일 단계에서 막아줍니다.
• 또한 롬복을 사용하면 주입을 굉장히 간편하게 사용할 수 있습니다. 아래는 그 예시입니다.

@Component
public class OrderServiceImpl implements OrderService {
	private final MemberRepository memberRepository;
 	private final DiscountPolicy discountPolicy;
    
	@Autowired
	public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy
discountPolicy) {
 	this.memberRepository = memberRepository;
 	this.discountPolicy = discountPolicy;
 	}
}

 

 

 

 

 

위와같은 코드를 롬복을 사용하면 다음과 같이 줄일 수 있습니다.

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

 

 

 

 

 

 

 

 

 

 

 

 

조회된 빈이 2개 이상일 경우

@Autowired는 타입으로 빈을 조회합니다.

 

그런데 같은 타입으로 조회된 빈이 2개 이상일 경우, 무엇을 주입해야 할 지 모르기 때문에 오류를 발생시킵니다.

 

 

이를 해결하기 위한 여러 방법을 제공합니다.

• @Autowired 필드 명 매칭
• @Qualifier-> @Qualifier끼리 매칭 -> 빈 이름 매칭
• @Primary 사용

 

 

 

 

 

 

 

@Autowired 필드 명 매칭

@Autowired는 타입 매칭을 시도한 이후, 조회된 빈이 여러개라면 필드 이름(생성자 주입등의 경우 파라미터 이름)을 사용하여 추가 매칭을 진행합니다.

 

DiscountPolicy 타입이 RateDiscountPolicy와, FixDiscountPolicy가 있다고 가정하고, 이를 해결해보겠습니다.

@Autowired
private DiscountPolicy discountPolicy;//RateDiscountPolicy와, FixDiscountPolicy가 존재하여 오류

 

 

위의 코드를 다음과 같이 변경합니다.

@Autowired
private DiscountPolicy rateDiscountPolicy;

 

 

 

 

 

 

 

 

 

@Qualifier, @Primary 사용

https://ttl-blog.tistory.com/9

[Spring] @Qualifier, @Primary - 빈 우선순위 지정

 

 

 

 

 

 

 

 

 

 

 

 

 

 

📔 Reference

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

 

생성자 주입의 경우엔 @Autowired(required=false)를 쓸 수 없는건가요? - 인프런 | 질문 & 답변