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

[6om1n]

다양한 의존관계 주입 방법

의존관계 주입은 크게 4가지 방법이 있다.

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

생성자 주입

• 생성자 주입이란 이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법이다.
• 특징
  • 생성자 호출 시점에 딱 1번만 호출되는 것이 보장된다.
  • 생성자가 둘 이상 있으면 Autowired 를 호출해야한다.
  • 불변, 필수 의존관계에 사용된다.
  • NPE (NullPointerException)을 방지할 수 있다.
  • 주입 받을 필드를 final로 선언 가능하다.

@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개만 있으면 스프링 빈에서는 @Autowired 를 생략해도 자동 주입 된다.
• 스프링 컨테이너는 1. 스프링 빈을 등록하고, 2. 연관관계를 자동 주입한다. (@Autowired) 있는 것들

수정자 주입 (setter 주입)

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

@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) 로 지정하면 된다.

📌 참고

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

• 자바빈 프로퍼티 규약 예시

class Data {
    private int age;
    public void setAge(int age) {
        this.age = age;
    }

    public int getAge() {
        return age;
     }
}

필드 주입

• 이름 그래도 필드에 바로 주입하는 방법이다.
• 특징
  • 코드가 간결하다는 특징이 있지만, 외부에서 변경이 불가능해서 테스트 하기 어렵다.
  • DI 프레임워크가 없으면 아무것도 할 수 없다.
  • 따라서 순수 자바 코드로 테스트 하기 어렵다.
  • 주로, 애플리케이션의 실제 코드와 상관 없는 특정 테스트를 하고 싶을 때 사용한다.
    • 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용한다.

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

📌 참고

• 순수한 자바 테스트 코드에는 당연히 @Autowired 가 동작하지 않는다. @SpringBootTest 처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능하다.
• 아래 코드와 같이 @Bean 에서 파라미터에 의존 관계는 자동 주입된다. 수동 등록 시 자동 등록된 빈의 의존관계가 필요할 때 문제를 해결 할 수 있다.
  

일반 메서드 주입

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

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

📌 참고

• 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다. 스프링 빈이 아닌 Member 같은 클래스에서 @Autowired 코드를 적용해도 아무 기능이 동작하지 않는다.

---

옵션 처리

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

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

• 자동 주입 대상을 옵션으로 처리하는 방법은 아래와 같다.

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

• 아래의 코드로 확인해보자

//호출 안됨
@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); 
}

• Member는 스프링 빈이 아니다.
• setNoBean1() 은 @Autowired(required = false) 이므로 호출 자체가 안된다.
• 출력 결과
  

📌 참고

• @Nullable , Optional 은 스프링 전반에 걸쳐서 지원된다. 예를 들어 생성자 자동 주입에서 특정 필드에만 사용해도 된다.

---

생성자 주입을 선택해라!

과거에는 수정자 주입과 필드 주입을 많이 사용했지만, 최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입 을 권장한다. 그 이유는 다음과 같다.

불변

• 대부분 의존관계 주입은 한 번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다. (불변 해야한다.)

• 수정자 주입을 사용하면 set 메소드를 public으로 열어두어야 한다.

• 누군가 실수로 변경할 수도 있고, 변경하면 안되는 메소드를 열어두는 것은 좋은 설계 방법이 아니다.

• 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불변하게 설계할 수 있다.

• 수정자 의존관계인 경우

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 가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만, 지금은 프레임워크 없이 순수한 자바 코드로만 단위 테스트를 수행하고 있다.

@Test
void createOrder() {
 OrderServiceImpl orderService = new OrderServiceImpl();
 orderService.createOrder(1L, "itemA", 10000);
}

• 위와 같이 테스트를 수행하면 실행은 된다.
• 하지만, 실행 결과는 NPE (Null Point Exception) 이 발생하는데, memberRepository, discountPolicy 모두 의존 관계 주입이 누락되었기 때문이다.
• 생성자 주입을 사용하면 주입 데이터를 누락 했을 때 컴파일 오류 가 발생한다.
• 또한 IDE에서 바로 어떤 값을 주입해야 하는 지 알 수 있다.

final 키워드

• 생성자 주입을 사용하면 필드에 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;
    }
 //...
}

• 위의 코드를 보면 필수 필드인 discountPolicy 에 값을 설정해야 하는데, 이 부분이 누락되었다. 이럴 경우 컴파일 시험에 아래와 같은 오류를 발생 시킨다.
  

• 기억하자 ! 컴파일 오류는 세상에서 가장 빠르고, 좋은 오류다!

📌 참고

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

🐣 정리

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

---

롬복과 최신 트랜드

• 개발을 하다보면 다 불변이고, 필드에 final 키워드를 사용하게 되는데 생성자도 만들어야 하고, 주입 받은 값을 대입하는 코드도 만들어야 하고 .. 귀찮은 점들이 많다.
• 이걸 편리하게 만들어주는 어노테이션 기반으로 코드를 자동완성 해주는 라이브러리가 롬복 이다.

아래의 코드에서 롬복의 편리성을 확인해보자

• 기존의 코드

@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개만 있으면 @Autowired 를 생략할 수 있다.

• 롬복을 적용한 코드

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
}

• 롬복을 적용한 코드는 이전의 코드와 완전히 동일하다.
• 롬복 라이브러리가 제공하는 @RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다.
• 롬복이 애노테이션 프로세서 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해준다.
• 위의 코드에서는 생성자 코드가 보이지는 않지만 실제 class를 열어보면 아래와 같은 코드가 추가되어있는 것을 확인할 수 있다.

🐣 정리

• 최근에는 생성자를 딱 1개 두고, @Autowired 를 생략하는 방법을 주로 사용한다.
• 여기에 롬복 라이브러리의 @RequiredArgsConstructor 를 함께 사용하면 기능을 다 제공하면서 코드를 깔끔하게 사용할 수 있다.

📌 참고

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

1. build.gradle 에 라이브러리 및 환경 추가
   

2. File -> Settings -> plugin -> lombok 검색 설치 실행

3. Preferences -> Annotation Processors 검색 -> Enable annotation processing 체크 (재시작)

4. 임의의 테스트 클래스를 만들고 @Getter , @Setter 확인

✏️ 더불어

• @Getter 와 @Setter

롬복에서 가장 많이 사용하는 어노테이션이며, @Getter 와 @Setter 를 클래스 이름 위에 적용시키면 모든 변수들에 적용 가능하고, 변수 이름 위에 적요시키면 해당 변수들만 적용이 가능하다.

• @AllArgsConstructor

모든 변수를 사용하는 생성자를 자동 완성 시켜주는 어노테이션이다.

• @NoArgsConstructor

어떠한 변수도 사용하지 않는 기본 생성자를 자동 완성 시켜주는 어노테이션이다.

• @RequiredArgsConstructor

• 특정 변수만을 활용하는 생성자를 자동 완성 시켜주는 어노테이션이다.
• 생성자의 인자로 추가 할 변수에 @NonNull 어노테이션을 붙여서 해당 변수를 생성자의 인자로 추가할 수 있다.
• 아니면, 해당 변수에 final 을 선언해도 의존성을 주입받을 수 있다.

• @ToString

• 클래스의 변수들을 기반으로 ToString 메소드를 자동으로 완성시켜준다.
• @ToString.Exclude 어노테이션을 붙여주면 출력을 제외할 수 있다.

---