Spring / 의존관계 주입 - @Autowired 옵션 처리, 생성자 주입 사용 권장

@Autowired 옵션 처리

의존관계를 주입할 스프링 빈이 없어도 @Autowired가 동작해야 할 때가 있다.

 

package tmp;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class MyService {

    MyRepository myRepository;

    @Autowired
    public MyService(MyRepository myRepository)
    {
        this.myRepository = myRepository;
    }
}

예를들어, 위와 같은 Service와 Repository 클래스가 있고 Service가 Repository를 의존하고 Repository는 빈으로 등록되어 있지 않은 상황이 있다고 해보자.

 

1. MyService 클래스에 @Component를 붙여 빈으로 등록해주었고, MyRepository는 빈으로 등록되어 있지 않은 일반 자바 클래스이다.

2. MyService는 MyRepository를 의존하는 객체로 @Autowired를 붙여 MyService의 생성자를 통해 주입받도록 했다.

 

-> 스프링 빈으로 등록되어 있지 않은 클래스는 @Autowired를 사용해도 의존관계를 주입할 수 없다.

 

이러한 경우 다음과 같은 세 가지 방식의 옵션처리를 할 수 있다.

 

1. @Autowired(required = false) : 자동 주입할 대상이 없으면 수정자(setter) 메소드 자체가 호출이 안됨

2. @Nullable : 자동 주입할 대상이 없으면 null이 입력됨

3. Optional<> : 자동 주입할 대상이 없으면 Optional.empty가 입력됨

 

 

TestCode

package hello.core.AutoWiredTest;

import hello.core.AppConfig;
import hello.core.member.Member;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.lang.Nullable;

import java.util.Optional;

public class AutowiredTest {

    @Test
    void AutowiredOption()
    {
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
    }
	
    
    // Member는 스프링 bean이 아닌 일반 자바 클래스 !
    
    static class TestBean{

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

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

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



    }
}

❗️참고 : Optional, @Nullable은 스프링 전반에 걸쳐 지원된다.

 

---

@Autowired는 생성자 주입을 사용하자.

과거에는 수정자 주입과 필드 주입을 많이 사용했지만, 최근에느 DI프레임워크 대부분에서 생성자 주입을 권장한다.

 

생성자 주입을 사용해야 하는 이유

 

불변 유도 

1. 애플리케이션 시작부터 종료까지 의존관계가 바뀔일이 없다. 오히려 의존관계는 종료 전까지 바뀌면 안된다.

2. 수정자 주입을 사용하면 setter 메소드를 public으로 열어두어야 하기 때문에 이로 인해 실수로 변경되는 경우가 발생할 수도 있어 좋은 설계 방법이 아님.

3. 생성자 주입은 객체 생성시 딱 1번 호출되므로 불변하게 설계할 수 있다.

 

 

누락 방지 

프레임워크 없이 순수한 자바 코드로 단위 테스트 할 때,

 

수정자(setter) 메소드를 사용한 경우

  public class OrderServiceImpl implements OrderService {
      // 수정자 썼으므로 final 뺌 
      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가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만, 순수 자바코드 테스트의 경우에는 발생하지 않는다.

class OrderServiceImpTest {

    @Test
    void createOrder()
    {
        OrderServiceImp orderService =new OrderServiceImp();
        orderService.createOrder(1L,"ItemA",1000);
    }
}

• 실행은 되지만 OrderServiceImp의 의존관계 주입이 누락되어 NPE가 발생한다.
• setter 수정자 주입을 사용하면 의존관계 주입 데이터가 누락되었을 때 어떤 게 누락되었는지 눈에 확 보이지 않는다.
• 하지만 생성자 주입을 사용하면 의존관계 주입 데이터가 누락되었을 때 컴파일 오류가 발생되어 어떤 값을 필수로 주입해야 하는지 알 수 있다. 

final 키워드 사용

생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다.

그래서 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에서 발생시켜준다.

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

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

잘 보면 필수 필드인 discountPolicy 에 값을 설정해야 하는데, 이 부분이 누락되었다. 자바는 컴파일 시점에 다음 오류를 발생시킨다.

java: variable discountPolicy might not have been initialized

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

 

 

<정리>

• 생성자 주입 방식은 스프링 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 가장 잘 살리는 방법이다.
• 기본으로는 생성자 주입방식을 사용하자. (옵션이 필요한 경우에만 수정자 주입을 사용하자)
• 필드주입은 안쓰는게 좋다.

---

롬복 라이브러리를 사용한 코드 최적화

 

https://rlaehddnd0422.tistory.com/27

Spring / 롬복 라이브러리를 이용한 코드 최적화

 

기존 OrderServiceImp

@Component
public class OrderServiceImp implements OrderService {
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
    
    @Autowired
    public OrderServiceImp(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

생성자가 하나 뿐일때에는 @Autowired 생략해도 된다.

 

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

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

 

롬복 라이브러리 적용한 최종결과

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

 

@RequiredArgsConstructor를 사용하면 final이 붙은 필드를 모아 생성자를 자동으로 만들어준다. (코드에는 보이지 않음)

 

 

---