의존관계 자동 주입

1. 다양한 의존관계 주입 방법
2. 옵션 처리
3. 생성자 주입을 선택
4. 롬복과 최신 트랜드
5. 조회 빈이 2개 이상 - 문제
6. @Autowired 필드 명, @Qualifier, @Primary
7. 애노테이션 직접 만들기
8. 조회한 빈이 모두 필요할 때, List, Map
9. 자동, 수동의 올바른 실무 운영 기준

4. 롬복과 최신 트랜드

• 개발해보면 거의 불변이다.
• 필드 주입처럼 좀 편리하게 사용하는 방법은 없을까?
• 생성자가 1개만 있으면 @Autowired를 생략 할 수 있다.

라이브러리 적용시 설정

• Preferences Annotation Processors 검색 Enable annotation processing 체크

롬복 지원 애노테이션 정리

• @Getter, @Setter : 해당 필드에 대한 기본 getter/setter 메소드를 생성
• @NoArgsConstructor : 파라미터가 없는 생성자를 생성
• @RequiredArgsConstructor : 초기화되지 않은 모든 final 필드, @NonNull로 마크되어 있는 필드들에 대한 생성자를 자동으로 생성한다.
• @AllArgsConstructor : 클래스에 존재하는 모든 필드에 대한 생성자를 자동으로 생성한다.
• @EqualsAndHashCode : equals, hashCode를 자동으로 생성해준다.
  • equals : 두객체의 내용이 같은지 동등성 비교
  • hashCode : 두 객체가 같은 객체인지 동일성 비교
• @Data : @Getter/@Setter, @RequiredArgsConstructor, @ToString, @EqualsAndHashCode를 한번에 설정해준다.

5. 조회 빈이 2개 이상 - 문제

DiscountPolicy의 하위 타입인 FixDiscountPolicy, RateDiscountPolicy 둘다 스프링 빈으로 선언 시

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

의존관계 자동 주입을 실행해보면

@Autowired
private DiscountPolicy discountPolicy

NoUniqueBeanDefinitionException 오류가 발생한다. fixDiscountPolicy, rateDiscountPolicy 두개가 발견되었다는 것이다. 의존 관계 자동 주입에서 해결하는 여러 방법을 알아 보겠다.

6. @Autowired 필드 명, @Qualifier, @Primary

1. @Autowired 필드 명 매칭

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

(기존 코드) DiscountPolicy discountPolicy -->(바뀐 코드) DiscountPolicy rateDiscountPolicy

테스트 결과

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

@Autowired 매칭 정리

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

2. @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를 찾는 용도로만 사용하는게 명확하고 좋다.

3. @Primary 사용

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

rateDiscountPolicy 가 우선권을 가지도록 설정

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy{

테스트 결과

---

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

7. 애노테이션 직접 만들기

java/com/example/springex1/annotation/MainDiscountPolicy.java

package com.example.springex1.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)
@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;
    }

@MainDiscountPolicy 등록, 추가

테스트 결과

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

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

의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우가 있다. 클라이언트가 할인의 종류를 선택할 수 있을때 등등

java/com/example/springex1/autowired/AllBeanTest.java

package com.example.springex1.autowired;

import com.example.springex1.AutoAppConfig;
import com.example.springex1.discount.DiscountPolicy;
import com.example.springex1.member.Grade;
import com.example.springex1.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);
    }
    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);
        }
    }
}

결과

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

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

• 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.
• 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.
• 스프링 빈을 하나 등록할 때 @Component 만 넣어주면 끝나는 일을 @Configuration 설정 정보에 가서 @Bean 을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정은 상당히 번거롭다.
• 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 된다.

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

애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.

• 업무 로직 빈 : 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
• 업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.

---

• 기술 지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다
• 기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다. 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 드러나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.

참고
김영한: 스프링 핵심 원리 - 기본편(인프런)
Github - https://github.com/b2b2004/Spring_ex