의존관계 자동 주입

유병익·2022년 10월 17일
0

스프링 핵심 원리

목록 보기
7/9
post-thumbnail

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


  • 의존관계 주입은 크게 4가지 방법이 있음
    1. 생성자 주입
    2. 수정자 주입(Setter 주입)
    3. 필드 주입
    4. 일반 메서드 주입

1.1 생성자 주입


  • 생성자를 통해서 의존 관계를 주입 받는 방법
  • 지금까지 우리가 진행했던 방법

💡 생성자 호출시점에 딱 1번만 호출되는 것이 보장된다.
    불변, 필수 의존관계에 사용

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

💡 생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입 된다. (스프링 빈에만 해당)

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

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

1.2 수정자 주입 (Setter 주입)


  • Setter(필드의 값을 변경하는 메서드)를 통해서 의존관계를 주입하는 방법

💡 선택, 변경 가능성이 있는 의존관계에 사용
자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.

자바빈 프로퍼티, 자바에서는 필드의 값을 직접 변경하지 않고, setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는 규칙을 만들었는데, 그것이 자바빈 프로퍼티 규약이다.

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

💡 @Autowired 는 주입할 대상이 없으면 오류가 발생

주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false) 로 지정

1.3 필드 주입


  • 필드에 바로 주입하는 방법이다.

💡 코드가 간결하다. But 외부에서 변경이 불가능해서 테스트 하기 힘들다는 치명적인 단점
DI 프레임워크가 없으면 아무것도 할 수 없다. → 사용하지 말자!

  • 애플리케이션의 실제 코드와 관계 없는 테스트 코드 or 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

Example

```java
@Component
public class OrderServiceImpl implements OrderService {

		 @Autowired
		 private MemberRepository memberRepository;

		 @Autowired
		 private DiscountPolicy discountPolicy;
}
```

1.4 일반 메서드 주입


  • 일반 메서드를 통해서 주입 받을 수 있다.
  • 한번에 여러 필드를 주입 받을 수 있다.
  • 일반적으로 잘 사용하지 않는다.
  • Example
    @Component
    public class OrderServiceImpl implements OrderService {
    
    		 private MemberRepository memberRepository;
    		 private DiscountPolicy discountPolicy;
    
    		 @Autowired
    		 public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
    				 this.memberRepository = memberRepository;
    				 this.discountPolicy = discountPolicy;
    		 }
    }

💡 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다.

2. 옵션 처리


2.1 Option


  • 주입할 스프링 빈이 없어도 동작해야 할 때가 있다.
  • @Autowired 는 required 옵션의 기본값이 true → 자동 주입 대상이 없으면 오류 발생
  • 자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.
    1. @Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨
    2. org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력된다.
    3. Optional<> : 자동 주입할 대상이 없으면 Optional.empty 가 입력된다.
  • Example
    //호출 안됨
    @Autowired(required = false)
    public void setNoBean1(Member member) {
    		 System.out.println("setNoBean1 = " + member);
    }
    //null 호출
    @Autowired
    public void setNoBean2(@Nullable Member member) {
    		 System.out.println("setNoBean2 = " + member);
    }
    //Optional.empty 호출
    @Autowired(required = false)
    public void setNoBean3(Optional<Member> member) {
    		 System.out.println("setNoBean3 = " + member);
    }

💡 setNoBean1()@Autowired(required=false) 이므로 호출 자체가 안된다.


  • 최근에는 스프링을 포함한 DI 프레임워크 대부분 생성자 주입을 권장한다.
  • 이유
    • 불변
      • 대부분의 의존관계 주입은 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다.
      • 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다.
      • 객체를 생성할 때 딱 1번만 호출 → 이후에 호출 X→ 불변하게 설계 가능
    • 누락
      • 수정자 주입의 경우, 의존관계 주입이 누락될 수 있음
      • 생성자 주입을 사용하면 주입 데이터를 누락 했을 때 컴파일 오류 발생
      • IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.
    • Final 키워드
      • 생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다.
      • 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다

💡 컴파일 오류는 세상에서 가장 빠르고, 좋은 오류

💡 수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출 → 필드에 final 키워드 사용X → 오직 생성자 주입 방식만 final 키워드 사용 가능

2.2 요약


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

3. Lombok & 최신 트렌드


3.1 Lombok


  • Java 라이브러리로 반복 메서드 작성 코드를 줄여주는 코드 다이어트 라이브러리

3.1.1 Lombok Library 적용 방법


  1. build.gradle 에 라이브러리 및 환경 추가
    • build.gradle
      plugins {
       id 'org.springframework.boot' version '2.3.2.RELEASE'
       id 'io.spring.dependency-management' version '1.0.9.RELEASE'
       id 'java'
      }
      group = 'hello'
      version = '0.0.1-SNAPSHOT'
      sourceCompatibility = '11'
      //lombok 설정 추가 시작
      configurations {
       compileOnly {
       extendsFrom annotationProcessor
       }
      }
      //lombok 설정 추가 끝
      repositories {
       mavenCentral()
      }
      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') {
       exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
       }}
      test {
       useJUnitPlatform()
      }
  2. Preferences(윈도우 File Settings) plugin lombok 검색 설치 실행 (재시작)
  3. Preferences Annotation Processors 검색 Enable annotation processing 체크 (재시작)
  4. 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인

💡 최근에는 생성자를 딱 1개 두고, @Autowired를 생략하는 방법을 주로 사용

Lombok@RequiredArgsConstructor 함께 사용 → 모든 기능 제공 + 깔끔한 코드

4. @Autowired


4.1 조회 빈이 2개 이상


  • @Autowired타입(Type)으로 조회한다.
  • 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제 발생
  • Example
    @Component
    public class FixDiscountPolicy implements DiscountPolicy {}
    
    @Component
    public class RateDiscountPolicy implements DiscountPolicy {}
    
    @Autowired
    private DiscountPolicy discountPolicy

💡 NoUniqueBeanDefinitionException오류 발생

  • 스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존 관계 자동 주입에서 해결하는 여러 방법이 있다.

4.2 해결 방법


4.2.1 @Autowired 필드 명 매칭


  • @Autowired 는 타입 매칭을 시도

  • 이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.

  • Example

    • Before
      @Autowired
      private DiscountPolicy discountPolicy
    • After
      @Autowired
      private DiscountPolicy rateDiscountPolicy

    💡 필드 명이 rateDiscountPolicy이므로 정상 주입된다.

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

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


4.2.2 @Qualifier @Qualifier끼리 매칭 빈 이름 매칭


  • @Qualifier 는 추가 구분자를 붙여주는 방법이다.

  • 주입시 추가적인 방법을 제공하는 것

  • 빈 이름을 변경하는 것은 아님

  • Example

    @Component
    @Qualifier("mainDiscountPolicy")
    public class RateDiscountPolicy implements DiscountPolicy {}
    @Component
    @Qualifier("fixDiscountPolicy")
    public class FixDiscountPolicy implements DiscountPolicy {}
    • 생성자 주입 Example

      @Autowired
      public OrderServiceImpl(
      MemberRepository memberRepository, 
      @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
      		 this.memberRepository = memberRepository;
      		 this.discountPolicy = discountPolicy;
      }
    • 수정자 주입 Example

      @Autowired
      public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
      		 return discountPolicy;
      }
  • @Qualifier 로 주입할 때, @Qualifier("mainDiscountPolicy") 를 못찾으면?
  • mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.
  • @Qualifier@Qualifier 를 찾는 용도로만 사용하는게 명확

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


4.2.3 @Primary 사용


  • @Primary 는 우선순위를 정하는 방법

  • @Autowired 시에 여러 빈이 매칭되면 @Primary 가 우선권을 가진다.

  • Example

    @Component
    @Primary
    public class RateDiscountPolicy implements DiscountPolicy {}
    
    @Component
    public class FixDiscountPolicy implements DiscountPolicy {}
    • 사용코드

      //생성자
      @Autowired
      public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
      		 this.memberRepository = memberRepository;
      		 this.discountPolicy = discountPolicy;
      }
      //수정자
      @Autowired
      public DiscountPolicy setDiscountPolicy(DiscountPolicy discountPolicy) {
      		 return discountPolicy;
      }
  • @Qualifier 는 주입 받을 때 다음과 같이 모든 코드에 @Qualifier 를 붙여주어야 한다는 단점

  • @Primary 를 사용하면 이렇게 @Qualifier 를 붙일 필요가 없다.

4.2.4 우선 순위


  • @Primary는 기본값 처럼 동작
  • @Qualifier 는 매우 상세하게 동작
  • 스프링은 자동보다는 수동, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다.
  • 따라서 여기서도 @Qualifier가 우선권이 높다.

4.2.5 애노테이션 직접 만들기


  • @Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안된다.
  • 애노테이션을 만들어서 문제를 해결
package hello.core.annotataion;
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;
}

//수정자 자동 주입
@Autowired
public DiscountPolicy setDiscountPolicy(@MainDiscountPolicy DiscountPolicy discountPolicy) {
		 return discountPolicy;
}

💡 애노테이션에는 상속이라는 개념이 없음

여러 애노테이션을 모아서 사용하는 기능은 Spring이 지원해주는 기능

5. 조회한 빈이 모두 필요할 때


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

    • ex) 클라이언트가 할인의 종류(rate, fix)를 선택
  • Example Code

    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.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);
    				 }
    		 }
    }
    
  • 로직 분석

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

    2. 이때 fixDiscountPolicy, rateDiscountPolicy가 주입된다.

    3. discount ()메서드는 discountCode"fixDiscountPolicy"가 넘어오면 map에서 fixDiscountPolicy스프링 빈을 찾아서 실행

      (“rateDiscountPolicy”가 넘어오면 rateDiscountPolicy스프링 빈을 찾아서 실행)

  • 주입 분석

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

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


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

    • @Configuration에 가서 @Bean, 객체 생성, 주입할 대상을 일일이 적어주는 과정은 번거로움
    • 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담
    • 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.
  • 수동 빈 등록은 언제?

    • 애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록
    • 설정 정보에 바로 나타나게 하는 것이 유지보수 용이
    • 스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 예외
    • 스프링 부트가 아닌 직접 기술 지원 객체를 스프링 빈으로 등록 → 수동으로 등록 → 명확
💡 편리한 자동 기능을 기본으로 사용하자 직접 등록하는 기술 지원 객체는 수동 등록 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해보자
profile
Backend 개발자가 되고 싶은

0개의 댓글