의존관계 자동 주입

다양한 의존관계 주입 방법

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

생성자 주입

• 이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법이다.
• 지금까지 한 방법이 생성자 주입 방법
• 특징
  • 생성자 호출 시점에 딱 1번만 호출되는 것이 보장된다.
  • 불변,필수 의존관계에서 사용
• 생성자가 딱 1개만 있으면 @Autowired 를 생략해도 자동으로 주입된다. 스프링 빈에만 해당함

수정자 주입 (setter 주입)

• setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법이다.
• 특징
  • 선택, 변경 가능성이 있는 의존관계에 사용
  • 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.

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

}

1. OrderServiceImpl을 생성해서 빈에 등록 , new OrderServiceImpl(memberRepository, discountPolicy)을 호출 ← 스프링 컨테이너에서 찾아와서 등록
   1. 생성자는 빈 등록할 때, 자동주입이 일어남
   2. 수정자는 그 다음에 일어남
2. @Autowired 의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게
   하려면 @Autowired(required = false) 로 지정하면 된다.
3. 자바반 프로퍼티, 자바에서는 과거부터 필드의 값을 직접 변경하지 않고 set,get 메서드를 통해서 값을 읽거나 수정하는 규칙을 만들었는데, 이걸 자바빈 프로퍼티 규약이라고 한다.

필드 주입

• 이름 그대로 필드에 바로 주입하는 방법이다.
• 특징
  • 코드가 간결하지만 외부에서 변경이 불가능해서 테스트 하기 힘들다는 치명적인 단점이 있다.
  • DI 프레임워크가 없으면 아무것도 할 수 없다.
  • 사용하지말자
    • 애플리케이션의 실제 코드와 관계 없는 테스트 코드
    • 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

@Component
public class OrderServiceImpl implements OrderService {

 @Autowired
 private MemberRepository memberRepository;
 @Autowired
 private DiscountPolicy discountPolicy;

}

일반 메서드 주입

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

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

 

 

 

 

 

 

 

 

옵션처리

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

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

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

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

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

 

 

 

 

 

 

 

생성자 주입을 선택해라!

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

불변

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

누락

final 키워드

생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다. 그래서 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다.

❗️컴파일 오류가 세상에서 가장 빠르고, 좋은 오류이다.

수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 오출되므로, 필드에 final 키워드를 사용할 수 없다. 오직 생성자 주입 방식만 final 키워드를 사용할 수 있다.

정리

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

 

 

 

 

 

 

 

롬복과 최식 트랜드

롬복 추가 설정

• build.gradle 에서 추가해주면 됨
• annotationProcessor을 써서 동작을 함
• Lombok 플러그인 설치
• Annotation Processors 에서 Enable annotation processing ✔️

//lombok 설정 추가 시작
configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}
//lombok 설정 추가 끝

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'

    //lombok 라이브러리 추가 시작
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'
    //lombok 라이브러리 추가 끝


    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

• Getter, Setter를 자동으로 만들어줌
• @RequiredArgsConstructor : final이 붙은 객체를 가지고(final이 붙은 필드를 모아서) 생성자를 만들어줌

정리

최근에는 생성자를 딱 1개 두고 @Autowired 를 생략하는 방법을 주로 사용한다. 여기에 Lombok 라이브러리의 @RequiredArgsConstructor 를 함께 사용하면 기능은 다 제공하면서, 코드는 깔끔하게 사용할 수 있다.

 

 

 

 

 

 

 

조회 빈이 2개 이상 - 문제

• fixDiscountPolicy, rateDiscountPolicy 둘 다 컴포넌트 스캔에 넣으면 빈이 2개가 발견되었다고 오류남
• 이때 하위 타입으로 지정할 수 도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다. 그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안된다.
• 스프링 빈을 수동 등록해서 문제를 해결해도 되지만 , 의존 관계 자동 주입에서 해결하는 여러 방법이 있다.

@Autowired 필드 명, @Qualifier ,@Primary

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

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

@Autowired 필드 명 매칭

@Autowired 는 타입 매칭을 시도하고, 이때 여러 빈이 있으면 필드 이름(파라미터 이름)으로 빈 이름을 추가 매칭한다.

필드 명 매칭은 먼저 타입 매칭을 시도 하고 그 결과에 여러 빈이 있을 때 추가로 동작하는 기능이다.

 

@Autowired 매칭 정리

1. 타입 매칭
2. 타입 매칭의 결과가 2개 이상일 때 필드 명 , 파라미터 명으로 빈 이름 매칭

@Qualifier 필드 명 매칭

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

생성자 자동 주입

// OrderServiceImpl

@Autowired
    public OrderServiceImpl(MemberRepository memberRepository , 
       @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy){

        this.memberRepository = memberRepository;
        this.discountPolicy =discountPolicy;
    }

수정자 자동 주입

@Autowired
public DiscountPolicy setDiscountPolicy(
@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
 this.discountPolicy = discountPolicy;
}

@Qualifier 로 주입할 때 @Qualifier("mainDiscountPolicy") 를 못 찾으면 어떻게 될까?

→ 그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.

하지만 경험상 @Qualifier 는 @Qualifier 를 찾는 용도로만 사용하는게 명확하고 좋다.

빈 등록시에도 @Qualifier를 동일하게 사용할 수 있다.

@Qualifier 정리

1. @Qualifier끼리 매칭
2. 빈 이름 매칭
3. NoSuchBeanDefinitionException 예외 발생

@Primary 사용

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

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy{ ,,,

우선순위

@Primary 는 기본값 처럼 동작하는 것이고, @Qualifier ****는 매우 상세하게 동작한다. 이런 경우 어떤 것이 우선권을 가져갈까? 스프링은 자동보다는 수동이, 넓은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 여기서도 ****@Qualifier 가 우선권이 높다.

 

 

 

 

 

 

 

 

애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 와 같이 문자로 적으면 컴파일 타입에 체크가 안된다. ( 예를 들어 maindiscounttPolicy 동작은 하는데 오류가 발생함. 문자이기때문에 컴파일 타임에서 오류를 잡을 수가 없음)

→ 이럴 땐 애노테이션을 만들어서 더 깔끔하게 운용할 수 있다.

MainDiscounPolicy 라는 애노테이션 직접 생성

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

생성자에서는 이렇게 자동 주입하면 됨

@Autowired
    public OrderServiceImpl(MemberRepository memberRepository ,  
                @MainDiscountPolicy DiscountPolicy discountPolicy){

        this.memberRepository = memberRepository;
        this.discountPolicy =discountPolicy;
    }

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

@Qualifier 뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다.

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

 

 

 

 

 

 

 

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

의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있다.

예를 들어서 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정하자

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; //맵으로 모든 DiscountPolicy를 주입받음
        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);
            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을 주입한다.

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

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

정리

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