Spring - 의존관계 자동 주입(조회한 빈이 모두 필요할 때 List&Map, 자동 등록?수동 등록? 올바른 운영 기준)

조회한 빈이 모두 필요할 때, 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.assertj.core.api.Assertions;
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.*;

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

            System.out.println("discountCode = " + discountCode);
            System.out.println("discountPolicy = " + discountPolicy);

            return discountPolicy.discount(member, price);
        }
    }
}

로직 분석

• DiscountService는 Map으로 모든 DiscountPolicy를 주입받는다.

policyMap = {fixDiscountPolicy=hello.core.discount.FixDiscountPolicy@32811494, rateDiscountPolicy=hello.core.discount.RateDiscountPolicy@4795ded0}
policies = [hello.core.discount.FixDiscountPolicy@32811494, hello.core.discount.RateDiscountPolicy@4795ded0]

• discount() 메소드는 discountCode로 넘어오는 값에 따라 map에서 스프링 빈을 찾아 실행한다.
  • discountCode가 fixDiscountPolicy면 fixDiscountPolicy를 찾아서 실행
  • discountCode가 rateDiscountPolicy면 rateDiscountPolicy를 찾아서 실행

주입 분석

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

참고

스프링 컨테이너는 생성자에 클래스 정보를 받는데, 여기에 클래스 정보를 넘기면 해당 클래스가 스프링 빈으로 자동 등록된다.

ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);

위 코드는 두 가지로 나누어 이해할 수 있는데

1. new AnnotationConfigApplicationContext()를 통해 스프링 컨테이너 생성
2. AutoAppConfig.class, DiscountService.class를 파라미터로 넘기면서 명시된 클래스를 자동으로 스프링 빈에 등록

정리

스프링 컨테이너를 생성하면서 해당 컨테이너에 동시에 AppConfig, DiscountService를 스프링 빈으로 자동 등록해줌.

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

어떤 경우 컴포넌트 스캔과 자동 주입을 사용하고, 어떤 경우에 설정 정보를 통해 수동으로 빈을 등록하고 의존관계도 수동으로 주입해야 할까?

결론부터 말하면 자동을 선호한다.
스프링은 @Component뿐 아니라 @Controller, @Service, @Repository등 계층에 맞춰 자동으로 스캔할 수 있도록 지원한다.
그리고 스프링부트는 컴포넌트 스캔을 기본으로 사용하게 설계 되었으며, 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계됐다.

설정 정보 기반으로 앱의 구성과 실제 동작을 명확하게 나누는게 이상적이지만, 개발자가 스프링 빈 하나 등록할 때 @Component만 넣어주면 끝나는 일을 @Configuration에 가서 @Bean을 입력하고, 객체 생성하고, 주입할 대상을 적어주는 과정은 매우매우 번거로운 일이다.
앱의 규모가 커져 관리할 빈이 많아지면 설정 정보를 관리하는 것 자체가 부담될 수도 있다.
또! 자동으로 등록해도 OCP, DIP를 지킬 수 있다.

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

앱은 크게 업무 로직, 기술 지원 로직으로 나뉜다.

• 업무 로직 빈
  • 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리(DB Query나 JPA등 DAO와 유사) 등이 모두 업무로직
  • 보통은 비즈니스 요구사항을 개발할 때 추가되거나 변경
  • 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있는데, 이런 경우 자동 기능 적극 사용 권장
    • 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽기 때문.
• 기술 지원 빈
  • 기술적 문제나 공통 관심사(AOP)를 처리할 때 사용
  • 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들
  • 업무 로직과 비교해서 수가 매우 적고 보통 앱의 전반에 걸쳐 광범위(AOP, 공통 로그 등)하게 영향을 미친다.
  • 문제가 발생했을 때 적용이 잘 되는지, 안 되는지 파악조차 어려운 경우가 많다
    • 그렇기 때문에 수동 빈 등록 사용을 권장한다

앱 전반에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 설정 정보에 직관적으로 나타나게 하는 것이 유지보수 하기 수월

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

이때는 수동 빈 등록을 적극 활용하는 것이 좋다.
위 코드(조회한 빈이 모두 필요할 때, List, Map)를 보자

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

            System.out.println("discountCode = " + discountCode);
            System.out.println("discountPolicy = " + discountPolicy);

            return discountPolicy.discount(member, price);
        }
    }

해당 코드를 보고 어떤 스프링 빈이 들어오는지, 빈의 이름은 무엇인지 한 번에 확인할 수 있는가?
자동 등록을 사용하고 있기 때문에 파악하기 위해 여러 코드를 봐야하는 수고로움이 있을 것이다.

이런 경우에는 수동 빈을 등록하거나, 자동으로 하게 된다면 특정 패키지에 같이 묶어놓는 것이 좋다.
핵심은 한번에 코드가 눈에 잘 들어와서 이해가 되어야 하는 것이다.

수동 빈 등록을 위한 코드는 다음과 같이 작성할 수 있겠다

@Configuration
public class DiscountPolicyConfig {
      @Bean
      public DiscountPolicy rateDiscountPolicy() {
          return new RateDiscountPolicy();
      }
      @Bean
      public DiscountPolicy fixDiscountPolicy() {
          return new FixDiscountPolicy();
      }
}

위와 같이 설계를 한다면 다른 구현체를 등록하거나 제거하는 것이 훨씬 수월할 것이다.
그래도 자동 등록이 하고 싶다면 인터페이스의 구현체들만 따로 모아 특정 패키지에 모아놓자.

위와 같이 수동 등록을 하고, 전략 패턴이나 정책 패턴을 사용하면 해당 패턴을 사용하는 클래스 내부에서 어떤 빈을 사용하는지 명시적으로 파악이 쉽다.

혹은, 이전 내용처럼 같은 패키지에 몰아 넣고 자동 주입 방식을 사용해도 파악이 쉽다.

참고

스프링이나 스프링 부트에서 자동으로 등록하는 빈들은 예외로 하자.
스프링 부트에서 DataSource같은 경우 자동으로 등록해 주는데 수동 등록보단 스프링 부트의 메뉴얼을 잘 참고해서 사용하도록 하자.
또, 내가 직접 기술 지원 객체를 스프링 빈에 등록한다면 수동으로 등록해 명확하게 드러내자.

정리하면 다음과 같다.
편리한 자동 기능을 적극 사용하고, 직접 등록하는 기술 지원 객체는 예외로 수동 등록하는 것이 좋다.
또 다형성(변동 정책)을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해도 좋다.

출처 : 인프런 김영한 지식공유자님의 스프링 완전 정복 로드맵 강의