🎀 스프링 기본 5 - 의존관계 자동 주입

[ 다양한 의존관계 주입 방법 ]

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

 

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

    특징 : 생성자를 호출 시점에 딱 1번만 호출 되는 것리 보장 됨. "불변, 필수" 의존관계에 사용 (=공연 중간에 배우가 바뀌면 안 됨, final)

    중요 : 만약 생성자가 딱 1개만 있다면 @Autowired를 생략해도 된다 !! (생성자가 2개 이상이면 안 됨)

@Component
public class OrderServiceImple implements OrderService{

    private  final MemberRepository memberRepository; //final이 있으면 무조건 생성자 있어야 함
    private final DiscountPolicy discountPolicy; //구체에 의존하지 않고 Interface에만 의존

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

 

2) setter 주입(=수정자 주입) : setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법

    특징 : "선택,변경" 가능성이 있는 의존관계에 사용, 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법

@Component
public class OrderServiceImple implements OrderService{

    private MemberRepository memberRepository; //final이 있으면 무조건 생성자 있어야 함
    private DiscountPolicy discountPolicy; //구체에 의존하지 않고 Interface에만 의존
    
    @Autowired
    public void  setMemberRepository(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    
    @Autowired
    public void setDiscountPolicy(DiscountPolicy discountPolicy) {
        this.discountPolicy = discountPolicy;
    }

 

3) 필드 주입 : 이름 그대로 필드에 바로 주입하는 방법 

     특징 : 코드가 간경하지만 외부에서 변경이 불가능해서 테스트하기 힘들다는 치명적인 단점 존재 ! 사용하지 말자 !

@Component
public class OrderServiceImple implements OrderService{

    @Autowired private MemberRepository memberRepository; //final이 있으면 무조건 생성자 있어야 함
    @Autowired private DiscountPolicy discountPolicy; //구체에 의존하지 않고 Interface에만 의존

 

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

    특징 : 한번에 여러 필드를 주입 받을 수 있다. 일반적으로 잘 사용하지 않는다.

@Component
public class OrderServiceImple implements OrderService{

    private MemberRepository memberRepository; //final이 있으면 무조건 생성자 있어야 함
    private DiscountPolicy discountPolicy; //구체에 의존하지 않고 Interface에만 의존
    
    @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.annotation.AnnotationConfigApplicationContext;
import org.springframework.lang.Nullable;

import java.util.Optional;

public class AutowiredTest {

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

    }

    static class TestBean {

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


}

출력결과 : setNoBean2 = nu;;, setNoBean3 = Optional.empty

 

---

[ 생성자 주입 선택 ]

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

을 권장한다.

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

 

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

오직 생성자 주입 방식만 final 키워드를 사용할 수 있다. 
항상 생성자 주입을 선택해라! 그리고 가끔 옵션이 필요하면 수정자 주입을 선택해라. 필드 주입은 사용하지 않는 게 좋다.

 

---

[ 롬복과 최신 트렌드 ]

롬복 : @Getter & @Setter 같은 메서드 임의로 만들어줌 

          @RequiredArgsConstructor만 지정해주면 생성자 필요 없음 !!! final이 붙은 필드를 모아서 생성자 자동으로 만들어줌

              (=이런식으로 하면 나중에 필드 값 추가해줄떄 굉장히 편리)

그래서 최근에는 생성자를 딱 1개 두고, @Autowired를 생략하는 방법을 주로 사용한다.

여기에 Lombok 라이브러리의 @RequiredArgsConstructor함께 사용하면 기능은 다 제공하면서, 코드는 깔끔하게 사용할 수 있다.

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

 

package hello.core;

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

@Getter
@Setter
@ToString
public class HelloLombok {

    private String name;
    private int age;

    public static void main(String[] args) {
        HelloLombok helloLombok = new HelloLombok();
        helloLombok.setName("asd");
        
        System.out.println("name = " + name);
        System.out.println("helloLombok = " + helloLombok);
    }
}

 

---

[ @Autowired, @Quilifier, @Primary ]

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

   1. @Autowired 필드 명 매칭

   2. @Qualifier -> @Qualifier끼리 매칭 -> 빈 이름 매칭

   3. @Primary 사용

 

1. @Autowired 필드 명 매칭 : 타입 매칭을 시도하고, 타입 매칭 결과가 2개 이상일 때 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭

기존코드
@Autowired
private DiscountPolicy discountPolicy;

필드 명을 빈 이름으로 변경 
@Autowired
private DiscountPolicy rateDiscountPolicy;

 

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

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

[ 만약 여기서 -> @Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 못찾으면 ? ]
mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. 하지만 경험상 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는게 명확하고 좋다.

 

3. @Primary 사용 : 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면 @Primary가 우선권을 가진다. (=많이 사용)

     ( 메인데이터베이스와 보조데이터베이스 로직이 9:1 비율일때 메인에 @Primary를 걸어주는 용도로 많이 씀 )

 

@Qualifier의 단점은 주입 받을 때 다음과 같이 모든 코드에 @Qualifier를 붙여주어야 한다는 점이다.

반면에 @Primary를 사용하면 이렇게 @Qualifier를 붙일 필요가 없다.

 

▶▷ @Primary, @Qualifier 활용
코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자. 메인 데이터베이스의 커넥션을 획득하 는 스프링 빈은 `@Primary` 를 적용해서 조회하는 곳에서 `@Qualifier` 지정 없이 편리하게 조회하고, 서브 데이터베 이스 커넥션 빈을 획득할 때는 `@Qualifier` 를 지정해서 명시적으로 획득 하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다. 물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 `@Qualifier` 를 지정해주는 것은 상관없다.

▶▷ 우선순위

@Primary는 기본값 처럼 동작하는 것이고, @Qualifier는 매우 상세하게 동작한다. 이런 경우 어떤 것이 우선권을

가져갈까? 스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 여기서도 @Qualifier가 우선권이 높다.

 

---

[ 애노테이션 직접 만들기 ]

@Qualifier("mainDiscountPolicy") 이렇게 문자 적으면 컴파일시 타입 체크가 안된다. 애노테이션을 만들어서 문제를 해결할 수 있다.

package hello.core.annotataion;

 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)
 @Documented
 @Qualifier("mainDiscountPolicy")
 public @interface MainDiscountPolicy {
}

@Component
 @MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

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

 

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

     @Qualifier뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다. 단적으로 @Autowired도 재정의 할 수 있다.

     물론 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 더 혼란만 가중할 수 있다.

 

---

[ 조회한 빈이 모두 필요할 때 List Map ]

package hello.core.autowired;

import hello.core.AutoAppConfig;
import hello.core.discount.DiscountPolicy;
import hello.core.member.Grade;
import hello.core.member.Member;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import java.util.List;
import java.util.Map;
import static org.assertj.core.api.Assertions.assertThat;

public class AllBeanTest {

    @Test
    void findAllBean() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);

        DiscountService discountService = ac.getBean(DiscountService.class);
        Member member = new Member(1L, "userA", Grade.VIP);
        int discountPrice = discountService.discount(member, 10000, "fixDiscountPolicy");

        assertThat(discountService).isInstanceOf(DiscountService.class);
        assertThat(discountPrice).isEqualTo(1000);
        
        int rateDiscountPrice = discountService.discount(member, 20000, "rateDiscountPrice");
        assertThat(discountPrice).isEqualTo(2000);
    }

    static class DiscountService {
        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;
            System.out.println("policyMap = " + policyMap);
            System.out.println("policies = " + policies);
        }

        public int discount(Member member, int price, String discountCode) {
            DiscountPolicy discountPolicy = policyMap.get(discountCode);
            System.out.println("discountCode = " + discountCode);
            System.out.println("discountPolicy = " + discountPolicy);
            return discountPolicy.discount(member, price);
        }
    }
}

 

[ 로직 분석 ]

DiscountService는 Map으로 모든 `DiscountPolicy` 를 주입받는다. 이때 `fixDiscountPolicy, rateDiscountPolicy` 가 주입된다.

discount() 메서드는 discountCode로 "fixDiscountPolicy"가 넘어오면 map에서 fixDiscountPolicy 스프링 빈을 찾아서 실행한다. 물론 “rateDiscountPolicy”가 넘어오면 rateDiscountPolicy 스프링 빈을 찾아서 실행한다.

 

[ 주입 분석 ]

Map<String, DiscountPolicy> : map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.

List<DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다. 만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.

 

---

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

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

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

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