본 프로젝트 자료는 김영한님의 스프링 핵심 원리 - 기본편 참고 제작됐음을 알립니다.
일단 의존관계 자동 주입 알아보기 전에 의존관계에 대해서 알아야 한다.
의존관계 란?
- A 와 B 가 있다고 가정 해보자.
- 서로 의존관계라고 봤을 때, A 가 변할 경우, B 는 그 영향 범위 안에 들어간다. 결국 하나가 변하면 나머지도 따라 변해야 한다.
- 쉽게 말해 의존관계는 A 가 변경됬을 때 그 영향이 B 에 미치는 관계이다.
그럼 의존관계는 어느 상황에 쓰일까?
아래 코드 예시
public class A {
private B b;
public A() {
this.b = new B();
}
}일단 A 객체는 B 객체에 의존 관계가 있다. 하지만 이러면 문제점이 뭘까?
가장 큰 문제는 B 가 C 나 D, E 등으로 변경해야 할 때 A클래스의 생성자를 매번 변경해야하고 유연성이 떨어지는 결과를 가져준다. 그리고 처음에 배웠던 5원칙인 SOLID 중 DIP 원칙을 위반하는 꼴이기도 하다.
하지만 의존관계라는걸 활용하면 이러한 문제점들을 해결 할 수 있다.
의존 관계 주입(DI)이란?
장점
1. 결합도가 줄어든다
어떤 객체가 다른 객체에 의존한다는 것은, 그 의존 대상의 변화에 취약하다는 뜻이다. DI를 이용하면 주입받는 대상이 바뀔지 몰라도 해당 객체의 구현 자체를 수정할 일은 없어진다.
2. 유연성이 높아진다
기존 PizzaChef 클래스는 피자 레시피를 바꾸는 것이 쉽지 않았다. 생성자 코드 자체를 변경해주어야 했지만, DI를 이용하면 생성자의 인수만 다른 피자 레시피로 바꿔주면 된다.
3. 테스트하기 쉬워진다
DI를 이용한 객체는 자신이 의존하고 있는 인터페이스가 어떤 클래스로 구현되어 있는지 몰라도 된다. 따라서 테스트하기 더 쉬워진다.
4. 가독성이 높아진다
다양한 의존관계 주입 방법이 존재하지만 크게 4가지 방법이 있다고 한다.
- 생성자 주입
- 수정자 주입(setter 주입)
- 필드 주입
- 일반 메서드 주입
결론부터 말하자면 '생성자 주입'이 가장 좋다.
각 주입이 어느 차이점이 있는지 살펴보자.
1. 생성자 주입
- 이름 그대로 생성자를 통해서 의존 관계를 주입하는 방식이다.
생성자 주입을 사용하는 장점 3가지
- 순환 참조 방지
- final 선언이 가능
- 테스트 코드 작성 용이
특징
- 생성자 호출시점에 딱 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;
}
}팁!) 이때 @Autowired 는 생성자가 1개만 존재하면 생략해도 문제 없다.
2. 수정자 주입
- Setter 메소드에 @Autowired 어노테이션을 붙이는 방법이다
- setter 에 @Autowired 을 생성해 수정자 메서드를 만들어 의존 관계에 주입하는 방법이다.
- 특징
- 선택, 변경 가능성이 있는 의존관계에 사용
- 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.
아래 코드 예시
@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) 로 지정하면 된다.
3. 필드 주입
필드에 @Autowired 어노테이션만 붙여주면 자동으로 의존성 주입 된다. 사용법이 매우 간단하기 때문에 가장 많이 접할 수 있는 방법이다.
단점
- 코드가 간결하지만, 외부에서 변경하기 힘들다.
- 프레임워크에 의존적이고 객체지향적으로 좋지 않다.
아래 코드 예시
@Component
public class OrderServiceImpl implements OrderService {
@Autowired
private MemberRepository memberRepository;
@Autowired
private DiscountPolicy discountPolicy;
}-
참고: 순수한 자바 테스트 코드에는 당연히 @Autowired가 동작하지 않는다. @SpringBootTest 처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능하다.
-
참고: 다음 코드와 같이 @Bean 에서 파라미터에 의존관계는 자동 주입된다. 수동 등록시 자동 등록된 빈의 의존관계가 필요할 때 문제를 해결할 수 있다.
테스트를 활용한 코드 예시
@Bean
OrderService orderService(MemberRepository memberRepoisitory, DiscountPolicy discountPolicy) {
new OrderServiceImpl(memberRepository, discountPolicy)
}4. 일반 메서드 주입
- 일반 메서드를 통해서 주입 받을 수 있다.
- 특징
- 한번에 여러 필드를 주입 받을 수 있다.
- 일반적으로 활용하지 않는다.
일반 메서드 코드 예시
@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 코드를 적용해도 아무 기능도 동작하지 않는다.
5. 옵션 처리
만약, 의존 관계를 주입할 스프링 빈이 없을 때 동작해야 하는 경우가 있다.
- @Autowired만 사용하는 경우 required 옵션 기본값인 true가 사용되어 자동 주입 대상이 없으면 오류가 발생하는 경우가 있을 수 있다.
- 스프링 빈을 옵셔널하게 해 둔 상태에서 등록이 되지 않고, 기본 로직으로 동작하게 하는 경우
자동 주입 대상 옵션 처리 방법
- @Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출되지 않게 된다.
- org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력된다.
- Optional<> : 자동 주입할 대상이 없으면 Optional.empty가 입력된다.
스프링 빈이 아닌 Member라는 클래스를 의존성 주입하는 경우의 코드 예시
@Autowired(required = false) // 호출 안됨
public void setNoBean1(Member noBean1) {
System.out.println("noBean1 = " + noBean1);
}
@Autowired
public void setNoBean2(@Nullable Member noBean2) {
System.out.println("noBean2 = " + noBean2);
}
@Autowired
public void setNoBean3(Optional<Member> noBean3) {
System.out.println("noBean3 = " + noBean3);
}아래 코드는 결과값 출력 예시
setNoBean2 = null
setNoBean3 = Optional.empty- 참고: @Nullable, Optional은 스프링 전반에 걸쳐서 지원된다. 예를 들어서 생성자 자동 주입에서 특정 필드에만 사용해도 된다.
생성자 주입 답장너!
과거에는 수정자 주입과 필드 주입 등 다양한 주입으로 많이들 사용했지만, 최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 공식적으로도 권장하고 있다.
그 이유는 무엇일까?
- 불변
- 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다.(불변해야 한다.)
- 수정자 주입을 사용하면, setXxx 메서드를 public으로 열어두어야 한다.
- 누군가 실수로 변경할 수 도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.
- 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불변하게 설계할 수 있다.
정리
- 생성자 주입 방식을 선택하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이기도 하다.
- 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다. 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.
- 항상 생성자 주입을 선택해라! 그리고 가끔 옵션이 필요하면 수정자 주입을 선택해라. 필드 주입은 사용하지 않는게 좋다.
