[Spring] 의존관계 자동 주입

 

 

안녕하세요 이번 포스팅은 의존관계 자동 주입에 대해 알아보겠습니다

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

 

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

 

생성자 주입

이름 그대로 생성자를 통해서 의존 관계를 주입받는 방법입니다.

지금까지 저희가 진행했던 방법이 바로 생성자 주입이죠 사실 위에 4가지 방법 중 생성자 주입이 가장 권장하는 주입 ㅂ아법입니다.

생성 자 주입의 특징으로는

- 생성자 호출싲머에 딱 1번만 호출되는 것이 보장됩니다.

- 불변, 필수 의존관계에 사용합니다

 

여기서는 불편과 필수라는 키워드가 중요한데요, 의존관계를 주입하고 나서는 변경이 불가해야 한다는 것입니다.

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

수정자 주입(setter 주입)

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

참고 : @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 프레임워크가 없으면 아무것도 할 수 없습니다.

- 결론은 그냥 사용하지 말아야 된다고 합니다.

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

필드 주입을 사용하면 안 된다는 것을 알고 충격적이었습니다. 

개발원에서 스프링을 배울 때는 의존관계 주입을 모두 필드 주입으로 했는데 더 이상 사용하지 말아야겠습니다.

 

일반 메서드 주입

- 일반 메서드를 통해서 주입받을 수 있습니다.

- 특징

   - 한 번에 여러 필드를 주입받을 수 있습니다.

   - 일반적으로 잘 사용하지 않습니다.

 

@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는 스프링 빈이 아닙니다.

@Configuration 설정 파일에서 @Bean으로 수동 등록도 하지 않았고 @ComponentScan에 걸리게 @Component 어노테이션을 달아 주지 않았기 때문에 스프링 빈이 아닌 순수 자바 오브젝트입니다.

매개변수 타입 앞에 @Nullable을 붙여주면 null이 반환되고 Optional클래스를 통해서 실행시키면 Optional.empty가 반환이 됩니다. Optional은 wrapper class처럼 값이 없다면 null 처리를 해주기 위함입니다.

 

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

 

생성자 주입을 선택해라!!!

 

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

 

불변

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

수정자 주입을 사용하면, seXxx 메서드를 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);
}

그런데 막상 실행 결과는 Null Point Exception이 발생하는데, memberRepository, discountPolicy 모두 의존관계 주입이 누락되었기 때문입니다.

 

생성자 주입을 사용하면 다음처럼 주입 데이터를 누락했을 때 컴파일 오류가 발생합니다.

그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있습니다.

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

 

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에 값을 설정해야 하는데, 이 부분이 누락되었습니다. 자바는 컴파일 시점에 다음 오류를 발생시킵니다. java: variable discountPolicy might not have been initialized

여기서 기억해야 할 것은 컴파일 오류는 세상에서 가장 빠르고 좋은 오류입니다!

 

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

 

ㄹfinal 키워드는 초기화되는 값이나, 의존관계 주입을 해주지 않으면 컴파일 오류가 발생합니다.

 

정리

 

생성자 주입 방식을 선택하는 이유는 여러 가지가 있지만, 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이기도 합니다. 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 됩니다. 생성자 주입과 수정자 주입을 동시에 사용할 수 있습니다.

항상 생성자 주입을 선택하는 것이 좋으며 가끔 옵션이 필요하면 수정자 주입을 선택하면 되고 필드 주입은 사용하지 않는 게 좋습니다.

 

다음 포스팅은 롬복과 최신 트렌드에 대해서 알아보겠습니다!!