의존관계 자동 주입

Sangkyeong Lee·2021년 5월 19일

인프런 강의 < 스프링 핵심 원리 - 기본편 > 정리


다양한 의존관계 주입 방법

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

생성자 주입

특징

  • 생성자를 딱 한번 호출하는 것을 보장한다.
  • 불변, 필수 의존관계에 사용
@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
}
  • 생성자가 호출되면 @Autowired 애너테이션을 사용해서 의존 관계를 주입해준다.
  • 생성자가 1개만 존재하면 @Autowired 생략 가능
  • 위에 final로 선언된 변수는 값이 있어야 한다는 것을 말한다.

수정자 주입

특징

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

필드 주입

특징

  • 외부에서 변경이 불가능
  • DI 프레임워크 없으면 무용지물
@Component
public class OrderServiceImpl implements OrderService {
    @Autowired
    private MemberRepository memberRepository;
    @Autowired
    private DiscountPolicy discountPolicy;
}

일반 메서드 주입

특징

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

옵션 처리

  • @Autowired는 기본 옵션이 true 이므로 자동 주입 대상이 없으면 오류가 발생한다.

처리 방법

public class AutowiredTest {

    @Test
    void AutowiredOption() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
    }

    static class TestBean {

        @Autowired(required = false)
        public void setNoBean1(Member noBean1) {
            System.out.println("noBean1 = " + noBean1);
        }

        @Autowired
        public void setNoBean2(@Nullable Member noBean2) {
            System.out.println("noBean2 = " + noBean2);
        }

        @Autowired
        public void setNoBean3(Optional<Member> noBean3) {
            System.out.println("noBean3 = " + noBean3);
        }
    }
}

결과

setNoBean2 = null
setNoBean3 = Optional.empty
  1. @Autowired(required = false): 자동 주입 대상이 없으면 수정자 메서드 자체가 호출 안됨
  2. @Nullable: 자동 주입할 대상이 없으면 Null 입력
  3. Optional<>: 자동 주입할 대상이 없으면 Optioanl.empty가 입력됨

생성자 주입을 선택하자!

불변

  • 대부분의 의존관계 주입은 애플리케이션 종료까지 변하면 안된다.
  • 수정자 주입은 setXXX 메서드를 위해 public으로 선언해야 한다.
  • 생성자 주입은 딱 한번 호출 되므로 변하지 않는다.

생성자 주입 vs 수정자 주입

생성자 주입

  • 생성자 주입은 주입 데이터를 누락했을 경우 컴파일 오류가 발생한다.
  • final 키워드를 사용해 값이 설정되지 않는 오류를 컴파일 시점에 막을 수 있다.
@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;


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

수정자 주입

  • 반면에 수정자 주입은 실행은 되지만 Null Point Exception이 발생한다.
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;
    }
}

결론

  • 생성자 주입 방식은 순수한 자바 언어의 특징을 살릴 수 있다.
  • 필수 값이 아닌 경우에 수정자 주입 방식을 선택적으로 도입하여 동시에 사용할 수 있다.
  • 필드 주입은 사용하지 말자.

롬복과 최신 트렌드

기본 코드

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

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

롬복 적용 코드

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
}
  • @RequredArgsConstructor가 final이 붙은 필드를 모아서 생성자를 자동으로 생성해준다.
  • 최근에는 생성자를 1개로 두고, @Autowired를 생략한다.

조회 빈이 2개 이상일 경우 해결

  • @Autowired는 타입으로 조회하기 때문에 빈이 2개 이상인 경우에 문제가 발생한다. - NoUniqueBeanDefinitionException 오류

해결 방법

  1. @Autowired 필드 명 매칭
  2. @Qualifier -> @Qualifier끼리 매칭 -> 빈 이름 매칭
  3. @Primary 사용

1. @Autowired

  • 먼저 타입 매칭을 하고, 여러 빈이 존재할때 추가로 동작한다.
  • 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭
@Autowired
private DiscountPolicy discountPolicy

@Autowired
private DiscountPolicy rateDiscountPolicy
  • 스프링의 타입 매칭은 본인과 같은 타입이거나, 그 타입의 자식들을 모두 끌고온다.

2. @Qualifier

  • 빈 이름을 수정하는 것이 아니라 추가적인 구분을 해준다.
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}
  • 주입시에 @Qualifier를 붙여주고 등록한 이름을 적어준다.

적용

@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}

3. @Primary

  • 우선순위를 정하는 방법이다. Primary가 지정되어 있으면 우선권을 가짐
  • @Primary@Qualifier보다 우선권이 낮다

애노테이션 직접 만들기

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
        ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}
  • 다음과 같이 @MainDiscountPolicy라는 애노테이션을 만들어서 문자열의 타입체크가 불가능한 단점을 없애준다.
    • 컴파일시 오류 발생하도록

결론

  1. 애노테이션은 상속이라는 개념이 없지만 스프링이 제공하는 기능으로 재정의가 가능하다

  2. 재정의를 많이하면 유지보수에 혼란이 생기므로 무분별하게 사용하면 안된다.

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

  • 해당 타입의 스프링 빈이 모두 필요한 경우!!
    • 예) 클라이언트가 rate, fix 두가지 할인종류를 선택할 수 있을 때

Test

@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, 10000, "rateDiscountPolicy");
        assertThat(discountPrice).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;
        }

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

로직

  • DiscountService는 Map으로 모든 DiscountPolicy를 주입 받는다.
  • discount() 메서드는 discountCode로 fixDiscountPolicy가 넘어오면 map에서 fixDiscountPolicy 스프링 빈을 찾아서 실행!

주입

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

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

기본적으로는 편리한 자동 기능을 기본으로 사용!

  • 자동으로 하는게 추세
  • @Component뿐만 아니라 @Controller, @Service, @Repository 처럼 계층에 맞춰 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원
  • 스프링 부트는 컴포넌트 스캔을 기본으로 사용한다.
  • 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록
  • 설정 정보를 기반으로 애플리케이션 구성 부분과 실제 동작하는 부분을 나누는 것이 이상적이지만 매우 번거로움
    • 관리할 빈이 많아지는 경우
  • 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

수동 빈 등록은 언제 사용??

업무 로직

웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리

기술 로직

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

결론

  • 업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리처럼 유사한 패턴이 있다. 이때는 자동 기능이 좋다
  • 기술 지원 로직은 수가 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다. 그리고 적용이 되는지 안되는지 명확히 파악이 불가능 하므로 수동 빈 등록이 좋다.
  • 다형성을 적극 활용하는 비즈니스 로직중에서 수동 빈 등록이 유리할때가 있다
    • DiscountService가 의존관계 자동 주입으로 Map<String, DiscountPolicy>에 주입을 받는 상황에서 어떤 빈이 주입되는지, 빈의 이름은 무엇인지 파악하기 힘들기 때문에

< 자료 출처: 스프링 핵심 원리 - 기본편 >

profile
💻Backend Developer

0개의 댓글