[Spring] 의존 관계 주입의 다양한 방식
의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야만 동작한다.
생성자 주입
생성자를 통해서 의존관계를 주입받는 방법
생성자 호출시점에 딱 1번만 호출되는 것이 보장되며 "불변, 필수" 의존관계에 사용된다. 단, 클래스 내 생성자가 "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라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법
"선택, 변경" 가능성이 있는 의존관계에 사용되며 자바 빈 프로퍼티 규약(set, get으로 시작하는 메서드)의 수정자 메서드 방식을 사용한다. @Autowired의 기본 동작은 주입 대상이 없으면 오류가 발생하고, 대상이 없어도 동작하길 원한다면 @Autowired(required=false) 로 지정한다.
@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;
}
}
기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우 수정자 주입 방식은 옵션이 필요할 때 부여하면 된다. 생성자 주입과 수정자 주입을 동시에 사용 가능하다.
필드 주입
필드에 바로 주입하는 방법
코드가 간결해 편리한 거 같으나 외부에서 변경이 불가능해 테스트하기 어려운 단점이 있고, DI 프레임워크가 없으면 아무것도 할 수 없다. 앱의 실제 코드와 관계없는 테스트 코드 또는 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서 특별한 용도로는 사용 가능하다.
@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;
}
}
생성자 주입을 권장하는 이유
스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장하는 이유는 "불변", "누락", final 키워드의 이유이다. 프레임워크에 의존하지 않고 순수 자바 언어의 특징을 살리는 방법이기도 하다.
"불변"
- 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없고 대부분의 의존관계는 앱 종료 전까지 불변해야 한다.
- 수정자 주입 사용시 메서드 접근 제어가 public으로 되어있어 누군가 실수로 변경할 수도 있다는 점과 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.
- 생성자 주입은 객체 생성시 한번만 호출되므로 이후에 호출될 일이 없어서 불변하게 설계가 가능하다.
"누락"
- 프레임워크없이 순수 자바 코드를 단위 테스트 하는 경우 주입 데이터가 누락되었을 때 생성자 주입 사용시 "컴파일 오류"를 발생시켜 바로 어떤 값을 필수로 주입해야 하는지 파악이 가능하다.
final 키워드
- 생성자 주입 사용시 필드에 final 키워드를 사용할 수 있는데 이때 값을 누락해 설정되지 않는 오류를 컴파일 시점에 막아준다. 컴파일 오류가 가장 빠르고 좋은 오류이다.
- 수정자 주입을 포함한 나머지 주입 방식은 생성자 이후에 호출되므로 필드에 final 키워드를 사용할 수 없다.
옵션 처리와 Lombok
의존관계를 주입할 스프링 빈이 없어도 동작해야 할 때 처리하는 방식이다.
@Autowired 만 사용한다면 required 디폴트값이 true이므로 자동 주입 대상이 없을 때 오류가 발생한다. 다음은 자동 주입 대상을 옵션으로 처리하는 방법이다.
@Autowried(required = false) : 자동 주입 대상이 없으면 에러는 뜨지 않고 수정자 메서드 자체가 호출이 안된다.
@Nullable : 자동 주입 대상이 없으면 null이 입력된다.
Optional<> : 자동 주입 대상이 없으면 Optional.empty가 입력된다.
@Autowired(required = false)
public void setNoBean1(Member member) {
System.out.println("setNoBean1 = " + member);
}
@Autowired
public void setNoBean2(@Nullable Member member) {
System.out.println("setNoBean2 = " + member);
}
@Autowired(required = false)
public void setNoBean3(Optional<Member> member) {
System.out.println("setNoBean3 = " + member);
}
롬복과 최신 트렌드
개발시 대부분 불변이고 생성자에 final 키워드를 사용하게 된다. 생성자를 직접 코드로 작성하는 과정과
주입받은 값들을 대입하는 코드도 작성을 해야하는데 롬복 라이브러리의 @RequiredArgsConstructor를 사용해
final이 붙은 필드를 모아서 생성자를 자동으로 만들어주어 편리하게 해준다.
@Component
@RequiredArgsConstructor
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;
// }
}
Lombok이 자바 애노테이션 프로세서라는 기능을 사용해서 컴파일 시점에 위에 주석 처리 되어있는 생성자 코드를 자동으로 생성해준다. 참고로, build.gradle에 아래의 Lombok 설정을 추가해주고 라이브러리가 있어야 동작한다.
configurations {
compileOnly {
extendsFrom annotationProcessor
}
}
최근에는 생성자를 딱 1개 두고 @Autowired를 생략하는 방법을 주로 사용하고, Lombok 라이브러리의 @RequiredArgsConstructor를 함께 사용함으로써 코드를 최적화시킬 수 있다.
본 내용은 인프런 핵심원리 - 기본편 김영한님의 강의를 참고하였습니다.