@Autowired

김대준·2022년 1월 18일

spring

목록 보기

22/25

다양한 의존관계 주입 방법

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

스프링 컨테이너는 2가지 라이프 사이클이 존재한다.
1. 스프링 빈 등록
2. 의존관계 주입

📌 생성자 주입

생성자를 통해서 의존 관계를 주입 받는 방법이다.
스프링 컨테이너 라이프 사이클에서 1, 2번이 동시에 진행된다.
빈을 등록하기 위해선 생성자를 호출해야하는데 생성자를 호출하면 의존관계가 주입 되기 때문이다.
즉, 생성자 주입은 스프링 빈에 등록되자마자 의존관계가 자동으로 주입된다.
가장 많이 쓰이는 방법이다.

순환참조 문제를 방지할 수 있다.

@Autowired(required = false)이 적용되지 않는다.

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

생성자 주입을 사용하면 필드에 final를 사용할 수 있다. 그래서 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에서 막아준다.
생성자 주입 방식을 제외한 나머지 주입 방식은 모두 생성자 이후에 호출되므로 필드에 final를 사용할 수 없다. 오직 생성자 주입 방식만 final를 사용할 수 있다.

불변, 필수 의존관계에서 사용한다.

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

생성자 주입 방식을 선택하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이다.
기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다.
항상 생성자 주입을 선택하고, 가끔 옵션이 필요하면 수정자 주입을 선택하는 것이 좋다.

최근에는 생성자를 딱 1개만 두고, @Autowired를 생략하는 방법을 주로 사용한다. 이 때 LomBok 라이브러리의 @RequiredArgsConstructor를 같이 사용하면 좋다.

package hello.core.order;

import hello.core.discount.DiscountPolicy;
import hello.core.member.Member;
import hello.core.member.MemberRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@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;
    }

    @Override
    public Order createOrder(Long memberId, String itemName, int itemPrice) {
        Member member = memberRepository.findById(memberId);
        int discountPrice = discountPolicy.discount(member, itemPrice);


        return new Order(memberId, itemName, itemPrice, discountPrice);
    }
}

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

🔍 `@Autowired(required=false)` 대안

@Component
public class TestBean {
	private final Member member;
	
	@Autowired(required = false)
	public TestBean(Member member) {
		this.member = member;
	}
	
}

생성자 주입 방식은 @Autowired(required = false)을 적용할 수 없다.
그래서 위의 코드는 적용되지 않는다.

✔ 대안 1

@Component
public class TestBean {

    private final Member member;

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

개별 필드에 값이 없을 때 개별 필드 값에 @Autowired(required = false) 적용하기

✔ 대안 2

@Component
public class TestBean {

    private final Member member;

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

@Nullable, Optional 사용하기

📌 수정자 주입 (setter 주입)

setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법이다.

선택, 변경 가능성이 있는 의존관계에 사용한다.
자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.
순환참조가 일어날 수 있다.

@Autowired(required = false) 옵션을 주면 해당 빈이 없으면 주입 받지 않는다.

@Component
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;
 
     }
}

📌 필드 주입

필드에 바로 주입하는 방식이다.

예전에는 많이 쓰였던 방식이나 이제는 안좋은 방법으로 꼽힌다.
안 쓰는 게 낫다.

순환 참조가 일어날 수 있다.
코드가 간결해서 좋아보이나, 외부에서 변경이 불가능해서 테스트 하기 힘들다는 치명적인 단점이 있다.
DI프레임워크가 없으면 아무것도 할 수가 없다.
스프링 설정을 목적으로하는 @Configuration 같은 곳에서만 특별항 용도로만 사용한다. (거의 안쓰인다.)

@SpringBootTest처럼 스프링 컨테이너를 테스트에 통합한 경우에는 쓸 수 있다.
애플리케이션의 실제 코드와 관계없는 테스트 코드에서만 가끔 쓰인다.

@Autowired(required=false) 옵션을 주면 해당 bean은 없으면 주입받지 않을 수도 있다

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

📌 일반 메서드 주입

일반 메서드를 통해서 주입 받을 수 있다.
일반적으로 잘 사용하지 않는다.

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

@Component
public class OrderServiceImpl implements OrderService {

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

옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때가 있다.
@Autowired는 required 옵션의 기본값이 true로 되어 있다. 그래서 자동 주입 대상이 없으면 오류가 발생한다.

자동 주입 대상을 옵션으로 처리하는 방법

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

package hello.core.autowired;

import hello.core.member.Member;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.lang.Nullable;

import java.util.Optional;

public class AutowiredTest {

    @Test
    void AutowiredOption() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);

    }

    static class TestBean {

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

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

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

    }

}

setNoBean2 = null
setNoBean3 = Optional.empty

여기서 Member는 스프링 빈이 아니다. 그래서 setNoBean1()가 호출 자체가 안됐다.
@Nullable, Optional은 스프링 전반에 걸쳐서 지원된다. 생성자 자동 주입에서 특정 필드에만 사용해도 된다.

빈(Bean) 조회

@Autowired는 타입(Type)으로 빈을 조회한다.
타입으로 조회하기 때문에 ac.getBean() 와 비슷하게 동작한다.
(실제로는 @Autowired가 더 많은 기능을 제공한다.)

@Autowired가 빈을 조회할 때, 같은 타입의 빈이 2개 이상일 때 NoUniqueBeanDefinitionException 예외가 발생한다.
이 때, 빈을 조회할 때 인터페이스로 안하고 하위 타입인 구현 클래스로 할 수 있다. 하지만 그럴경우 DIP를 위배하고 유연성이 떨어진다.

📌 해결방안

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

🔍 `@Autowired` 필드명 매칭

@Autowired는 타입 매칭을 시도한다.
이 때, 같은 타입의 빈이 여러 개일 경우, 필드 명 또는 파라미터 명으로 빈 이름을 추가 매칭한다.

@Autowired
private DiscountPolicy rateDiscountPolicy

① DiscountPolicy 인터페이스 타입으로 빈을 조회한다.
② 같은 타입의 빈이 2개 이상 있을 경우 필드명인 rateDiscountPolicy 와 같은 이름의 빈 타입이 있는지 조회를 한다.

🔍 `@Qualifier` 사용

@Qualifier는 추가 구분자를 붙여주는 방법이다.
주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것이 아니다.

@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}

이렇게 @Qualifier("이름")을 붙여주고 @Qualifier에 붙여진 이름과 같은 빈을 매칭한다.

💡 생성자 자동 주입 방식

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

@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy 을 통해서 DiscountPolicy 타입의 빈 중에서 @Qualifier("mainDiscountPolicy") 가 적힌 빈으로 자동 주입한다.

💡 수정자 자동 주입 방식

@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
    return discountPolicy;
}

수정자 자동 주입 방식도 생성자 자동 주입 방식과 같다.

👀 `@Qualifier` 동작 정리!!

@Qualifier 끼리 매칭
빈 이름 매칭
그래도 없으면 NoSuchBeanDefinitionException 예외 발생

🧷 @Qualifier 단점

@Qualifier("이름") 처럼 괄호안에 문자를 적을 경우 컴파일시 타입체크가 안된다.

🧷 @Qualifier 해결방안

@Qualifier("이름")를 포함하는 새로운 애노테이션을 만들면 된다.

Qualifier 인터페이스의 소스코드에서 @Target, @Retention, @Inherited 부분을 복사

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Qualifier {

	String value() default "";

}

새로운 애노테이션 인터페이스 파일을 만든 후 1번에서 복사한 부분을 붙여 넣는다.

@Qualifier("mainDiscountPolicy")에서 괄호안에 있는 문자 부분의 이름을 가지고 인터페이스 파일을 만든다.

그 후 1번에서 복사한 부분을 붙여 넣는다.

그리고 @Qualifier("mainDiscountPolicy")도 같이 붙여준다.

package hello.core.annotation;

import org.springframework.beans.factory.annotation.Qualifier;

import java.lang.annotation.*;

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}

@Qualifier 사용할 곳에 2번에 새로 만든 애노테이션 사용

@Qualifier 사용 대신 @MainDiscountPolicy 를 붙여서 오타나 그런 프로그래머의 실수 차원에서 발생할 수 있는 타입 에러를 컴파일에서 잡아주게 한다.

참고로 애노테이션에는 상속 개념이 없다. 이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다.

//생성자 자동 주입
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @MainDiscountPolicy DiscountPolicy discountPolicy) {
   this.memberRepository = memberRepository;
   this.discountPolicy = discountPolicy;
}


//수정자 자동 주입
@Autowired
public DiscountPolicy setDiscountPolicy(@MainDiscountPolicy DiscountPolicy discountPolicy) {
   return discountPolicy;
}

🔍 `@Primary` 사용

@Primary는 우선순위를 정하는 방법이다.
@Autowired가 같은 타입의 여러 빈을 매칭하면, @Primary가 붙은 빈이 주입이 된다.

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}