스프링기본10_의존관계 자동주입

의존관계 자동 주입

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

1. 의존관계 주입 방법 4가지

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

2. 생성자 주입

• 이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법
• 지금까지 진행한 방법
• 특징
  a. 생성자 호출 시점에 딱 1번만 호출되는 것이 보장된다.
  b. "불변,필수" 의존관계에 사용
  c. 생성자가 딱 1개일 때는 @Autowired를 생략해도 자동 주입 된다.
  

3. 수정자 주입(setter 주입)

• setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방식
• 특징
  a. "선택,변경" 가능성이 있는 의존관계에 이용
  b. 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법
  c. @Autowired의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false)로 지정하면 된다.
  

4. 필드 주입

• 이름 그대로 필드에 바로 주입하는 방식
• 특징
  a. 코드가 간결함
  b. 외부에서 변경이 불가능하여 테스트하기 어려우며, DI 프레임 워크가 없으면 아무것도 할 수 없다
  c. 안티패턴이므로 사용하지 말 것
  -> 애플리케이션의 실제코드와 관계없는 테스트 코드
  -> 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용
  

5. 일반 메서드 주입

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

의존관계 자동주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다. 스프링 빈이 아닌 클래스에서 @Autowired를 적용해도 아무런 일이 일어나지 않는다.

(2) 옵션 처리

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

• 자동 주입 대상을 옵션으로 처리하는 방법
  a. '@Autowired(required=false)' : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨
  b. 'org.springframework.lang.@Nullable' : 자동 주입할 대상이 없으면 null이 입력된다.
  c. 'Optional<>' : 자동 주입할 대상이 없으면 'Optional.empty'가 입력된다.
  

(3) 생성자 주입을 선택해라

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

• 불변
  -대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다.
  -수정자 주입을 사용하면 setXxx메서드를 public으로 열어두어야 함
  -누군가 실수로 변경할 수도 있고, 변경하면 안되는 메소드를 열어두는 것은 옳지 못함
  -생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 불변하게 설계 가능.

• 누락
  -생성자 주입을 사용하면 주입 데이터를 누락했을 떄 "컴파일 오류"가 발생하여 사전에 확인할 수 있다.(final키워드)
  -오직 생성자 주입 방식만 'final'키워드를 사용할 수 있다.
  

(4) 롬복과 최신 트랜드

생성자도 만들어야 하고, 주입 받는 값을 대입하는 코드도 만들어야 하고,,,,, 필드 주입처럼 편리하게 사용하는 방법은 없을까?

• 기본 코드
  

• lombok 적용한 코드
  
  -> @RequiredArgsConstructor 사용 시 final이 붙은 필드를 모아서 생성자를 자동으로 만들어 줌
  -> 룸복이 자바의 에노테이션 프로세서라는 기능을 이용하여 컴파일 시점에 생성자 코드를 자동으로 생성해 줌.

(5) 조회 빈이 2개 이상 - 문제

• @Autowired는 타입(Type)으로 조회된다.
  -> 타입으로 조회 시 선택된 빈이 2개 이상일 때 문제가 발생한다.
  (ex) FixDiscountPolicy, RateDiscountPolicy

• 오류 내용
  No qualifying bean of type 'springbasic.core.discount.DiscountPolicy' available: expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy

(6) @Autowired 필드 명, @Quilifiter, @Primary

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

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

1. @Autowired필드 명 매칭

• @Autowired 는 타입 매칭을 시도한다.
• 타입 매칭의 결과가 2개 이상일 때는 필드 명, 파라미터 명으로 빈 이름 매칭
  

2. @Quailifier

• @Quailifier는 추가 구분자를 붙여주는 방법이다.
• 1. @Quailifier끼리 매칭
• 2. 빈 이름 매칭
• 3. NoSuchBeanDefinitionException 예외 발생

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

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

3. @Primary 사용

• @Primary는 우선순위를 정하는 방법이다. @Autowired 시에 여러 번 매칭되면 '@Primary'가 우선권을 가진다.

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {

@Component
public class FixDiscountPolicy implements DiscountPolicy {

4. @Primary, @Quailifier 활용

• 메인 데이터베이스의 커넥션을 획득하는 스프링 빈 vs 서브 데이터베이스의 커넥션을 획득하는 빈
  -> 메인은 @Primary를 적용해서 사용
  --> 서브는 @Qualifier를 지정해서 명시적으로 획득하는 방식으로 사용
• 둘 중 우선순위는 @Quailifier가 높다. (더욱 상세함, 수동)

(7) 애노테이션 직접 만들기

• @Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일 시 타입 체크가 안됨.
  -> 다음과 같이 애노테이션을 만들어서 문제 해결 가능
  
  -> 애노테이션에는 상속이라는 개념이 없다.
  --> 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원하는 기능이다.
  -> Quailifier 뿐만 아니라 다른 에노테이션들도 함께 조합해서 사용할 수 있다.

(8) 조회한 빈이 모두 필요할 때, List, Map

의도적으로 해당 타입의 스프링 빈이 다 필요한 경우도 있다.
예를 들어 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate,fix)를 선택할 수 있다고 가정해보자. 스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있다.

package springbasic.core.autowired;


import org.assertj.core.api.Assertions;
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 springbasic.core.AutoAppConfig;
import springbasic.core.discount.DiscountPolicy;
import springbasic.core.member.Grade;
import springbasic.core.member.Member;

import java.util.List;
import java.util.Map;

import static org.assertj.core.api.Assertions.*;

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, "rateDiscountPolicy");
        assertThat(rateDiscountPrice).isEqualTo(2000);

    }

    static class DiscountService {
        private final Map<String, DiscountPolicy> policyMap;
        private final List<DiscountPolicy> policies;

        @Autowired
        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);
            return discountPolicy.discount(member, price);
        }
    }
}

• 로직 분석

1. DiscountService는 Map으로 모든 'DiscountPolicy' 주입받음 (fixDiscountPolicy, rateDiscountPolicy)
2. discount() 메서드는 discountCode로 넘어온 인자값으로 map에서 스프링 빈을 찾아서 실행한다.

• 주입 분석

1. Map<String,DiscountPolicy>: map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로 'DiscountPolicy' 타입으로 조회한 모든 스프링 빈을 담아준다.
2. List<DiscountPolicy'> : 'DiscountPolicy'타입으로 조회한 모든 스프링 빈을 담아준다.
3. 만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.

(9) 자동, 수동의 올바른 실무 운영 기준

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

• 스프링은 @Component 뿐만 아니라, @Controller, @Service, @Repository 처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다.
• 설정정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나눈 것이 이상적이나, @Component만 넣어주면 끝나는 일을 설정정보에서 @Bean을 적고 객체를 생성하고 주입할 대상을 일일이 적어주는 과정은 상당히 번거롭다.
• 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

2. 수동 빈 등록은 언제 사용하면 좋을까?

• 업무로직 빈 : 웹을 지원하는 컨트롤러, 핵심 비지니스 로직이 있는 서비스, 데이터 계층을 로직을 처리하는 리포지토리 등이 모두 업무로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.

• 기술지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

• 업무로직 빈 = 자동 기능 / 기술지원 빈 = 수동기능

3. 비지니스 로직 중에서 다형성을 적극 활용할 때

• 의존관계 자동주입 : 조회한 빈이 모두 필요할 때(List,Map) 어떤 빈들이 주입될 지 코드만 보고 한번에 쉽게 파악 가능할 까?
  -> 수동 빈으로 등록하거나, 자동빈으로 특정 패키지에 같이 묶어두는 것이 좋다

4. 정리

• 편리한 자동 기능을 기본으로 사용하자.
• 직접 등록하는 기술 지원 객체는 수동 등록
• 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해보자