[스프링 핵심 원리 - 기본편] #7. 의존관계 자동 주입 (1)

[seyxxn]

7_의존관계 자동 주입 (1)

다양한 의존관계 주입 방법

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

생성자 주입

• 생성자를 통해 의존 관계를 주입 받는 방법
• 지금까지 사용해온 방법
• 생성자 호출 시점에 딱 1번만 호출되는 것을 보장
• 불변, 필수 의존관계에 사용
  • 멤버 변수를 private 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;
      }
  }

• @Autowired 생략 : 생성자가 1개만 존재한다면 생략 가능하다 (스프링 빈에만 해당)
  • 생성자가 1개만 존재한다면 생략해도 @Autowired가 있는 것과 같게 취급하는 의미
• 오토와이어 애노테이션이 생략된 코드

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

수정자 주입 (Setter 주입)

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

  @Component
  public class OrderServiceImpl implements OrderService {
      private MemberRepository memberRepository;
      private DiscountPolicy discountPolicy;
  
      // setter 함수들에 애노테이션을 붙임
      @Autowired
      public void setMemberRepository(MemberRepository memberRepository) {
      this.memberRepository = memberRepository;
      }
      @Autowired
      public void setDiscountPolicy(DiscountPolicy discountPolicy) {
      this.discountPolicy = discountPolicy;
      }
  }

  • 필드(멤버변수)를 수정하려면 우선 final 키워드를 제거해야 한다.
  • 직접 수정하지 않고 setter 메서드를 이용해서 값을 변경하며 이때 이 수정자 메서드에 @Autowired 애노테이션을 추가해야 한다.
• @Autowired를 사용할 때, 주입할 대상이 없으면 오류가 발생한다.
  • 주입할 대상이 없어도 오류가 나지 않게 하려면 @Autowired(required=flase)로 지정해야 한다.
• 자바 빈 프로퍼티 규약
  • 자바에서는 필드의 값을 직접 변경하지 않고 getter, setter 메서드를 이용하여 값을 읽어오고 수정한다는 규칙이 있다.

필드 주입

• 필드(멤버변수)에 바로 주입하는 방법
• 코드가 간결하지만 외부에서의 변경이 불가능하여 테스트하기 힘들다.
• 순수한 자바코드로의 테스트는 불가능하고, DI 프레임워크가 없으면 아무것도 할 수 없다.
• 애플리케이션의 실제 코드와 관계 없는 테스트 코드나, 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용하는 것이 좋다.
• 필드 주입 코드
• 일반 메서드 주입

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

• 순수한 자바 테스트 코드에서는 @Autowired가 동작하지 않는다. 스프링 빈이기때문에 작동하는 것임을 주의해야 한다.
• 자동관계주입은 스프링 컨테이너에서 관리하는 스프링 빈 이여야만 동작한다.

일반 메서드 주입

• 일반 메서드를 통해 주입받는 방법
• 한번에 여러 필드를 주입받을 수 있다.
• 잘 사용하지 않는다.
• 일반 메서드 주입 코드

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

옵션 처리

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

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

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

  • @Autowired(requied=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출이 안됨
  • org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력됨
  • Optional<> : 자동 주입할 대상이 없으면 Optinal.empty가 입력됨

• 예제 코드 추가 AutowiredTest.java

  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);
          }
          // required의 기본값은 true이다.
          // 따라서 false로 지정해주지 않으면 오류가 발생한다. (찾을 수 없어서)
          // false하면 의존관계가 없으면 메서드 자체가 호출 X
  
          @Autowired
          public void setNoBean2(@Nullable Member noBean2) {
              System.out.println("noBean2 = " + noBean2);
          }
          // Nullable 하면 호출은 되는데 널로 들어온다.
  
          @Autowired
          public void setNoBean3(Optional<Member> noBean3) {
              System.out.println("noBean3 = " + noBean3);
          }
          // 값이 없으면 Optional.empty로 들어온다.
  
      }
  }

  • 출력 결과

    setNoBean2 = null
    setNoBean3 = Optional.empty
    

생성자 주입을 선택해라!

• 최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다.

불변

• 대부분의 의존관계 주입은 한번 일어아면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 그리고 애플리케이션이 종료될 때까지 변하면 안되는 경우가 많다.
• 수정자 주입을 사용하면, setter 메소드를 public으로 열어두어여 한다.
  • 이는 누군가 실수로 변경할 가능성을 초래한다. 변경하면 안되는 메서드를 열어두는 것은 좋지 않다.
• 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불면하게 설계할 수 있다.

누락

• 프레임워크 없이 순수한 자바 코드를 단위 테스트하는 경우 코드 작성 과정에서 의존 관계 주입 누락이 될 수 있다.
• 생성자 주입을 사용하면 주입 데이터를 누락했을 때 컴파일 오류가 발생
  • 그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.

final 키워드

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

롬복과 최신 트랜드

• 편리를 위해 롬복 사용

• 롬복 라이브러리 적용 방법

  • 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()
  }

• 롬복 사용 전 코드

      @Component
      public class OrderServiceImpl implements OrderService {
          private final MemberRepository memberRepository;
          private final DiscountPolicy discountPolicy;
  
      // @Autowired 생성자가 딱 1개만 있으면 Autowired를 생략할 수 있음
      public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
          this.memberRepository = memberRepository;
          this.discountPolicy = discountPolicy;
          }
      }

• 롬복 사용

  • 롬복 라이브러리가 제공하는 @RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다.

• 롬복 사용 후 코드

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

정리

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