다양한 의존관계 주입
이전에 Container에 Bean을 등록하는 과정에서 의존관계 주입에 대해 간단하게 보았다.
이러한 의존관계 주입에는 어떤 다른 방법들이 있을까?
- 생성자 주입
- 수정자 주입(setter 주입)
- 필드 주입
- 일반 메서드 주입
생성자 주입
이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법이다.
지금까지 우리가 진행했던 방법이 바로 생성자 주입이다.
생성자 주입 방법은
생성자 호출시점에 딱 1번만 호출되는 것이 보장된다.
불변, 필수 의존관계에 사용된다.
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicydiscountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}위와 같이 일반적으로 행해왔던 방식이다.
또한 생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입 된다. 물론 스프링 빈에만 해당한다.
수정자 주입(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;`
}
}생성자 주입 방식에서 이렇게 수정 된다.
필드 주입, 일반 메서드 주입
필드 주입은 외부에서 변경이 불가능해서 테스트 하기 힘들다는 치명 적인 단점이 있고, DI 프레임워크가 없으면 아무것도 할 수 없다.
일반 메서드 주입은 의존관계 주입을 위한 메소드를 새로 짜는 것인데 생성자와 비슷해서 굳이 새로운 메서드를 짤 이유가 없어 잘 쓰이지 않는다.
그래서 주로 생성자 주입과 수정자 주입을 잘 활용하여 사용하도록 하자.
김영한 선생님께서 생성자와 수정자를 추천하시는 이유, 많이 간략하게 추렸다.
Autowired의 옵션
주입할 스프링 빈이 없어도 동작해야 할 때가 있다.
그런데 @Autowired 만 사용하면 required 옵션의 기본값이 true 로 되어 있어서 자동 주입 대상이 없 으면 오류가 발생한다.
이럴 때 활용할 수 있는 @Autowired의 옵션은 3가지가 있다.
@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);
} // setNoBean1 = null 출력
//Optional.empty 호출
@Autowired(required = false)
public void setNoBean3(Optional<Member> member) {
System.out.println("setNoBean3 = " + member);
} // setNoBean2 = Optional.empty 출력Lombok
이러하여, 주로 생성자 주입 방법을 사용하게 되는데, 이 과정을 자동화한 Lombok 라이브러리가 있다.
Lombok의 주요 기능
-
@Getter/@Setter
특정 필드 위에서 어노테이션을 붙여주면, 자동으로 생성된 접근자와 설정자 메소드를 사용할 수 있다. 클래스 위에 붙여주는 경우에는 모든 필드에 접근자와 설정자가 자동으로 생성된다. -
@NoArgsConstructor/@AllArgsConstructor/@RequiredArgsConstructor
생성자를 자동으로 생성해주는 어노테이션으로,@NoArgsConstructor는 파라미터가 없는 기본 생성자를 생성한다.@AllArgsConstructor는 필드 값을 모두 포함한 생성자를 생성해준다. 또,@RequiredArgsConstructor는final필드와@NonNull어노테이션이 붙은 필드에 대한 생성자를 생성하여 특정 변수만을 활용하는 생성자를 생성해 준다. -
@ToString
필드를 기반으로ToString메소드를 자동생성하며,클래스명(필드1 이름 = 필드 1 값, 필드2 이름 = 필드 2값)으로 출력된다.@ToString(exclude = “필드명”)을 사용하여 원하지 않는 필드는 제외할 수 있다. -
@EqualsAndHashCode
Equals와hashCode메소드를 자동으로 생성해주며,callSuper를 사용해서 메소드 자동 생성 시 부모 클래스의 필드까지 고려할 것인지를 설정할 수 있다.callSuper=true이면 부모 클래스 필드 값도 동일한지 고려하고,callSuper=false(기본값)로 설정하면 자신 클래스의 필드 값들만 고려한다. -
@Data
@Getter,@Setter,@ToString,@EqualsAndHashCode,@RequiredArgsConstructor를 한번에 생성해준다.
디테일하게 설명하지 않아도 Lombok을 접해봤다면 그 위대함을 알 것이다..
조회하는 빈이 2개 이상일 경우
@Autowired 는 타입(Type)으로 조회한다.
타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.
DiscountPolicy 의 하위 타입인 FixDiscountPolicy , RateDiscountPolicy 둘다 스프링 빈으로 선언 되있는데 의존관계 자동 주입을 실행하면 NoUniqueBeanDefinitionException 오류가 발생한다.
NoUniqueBeanDefinitionException: No qualifying bean of type 'hello.core.discount.DiscountPolicy' available: expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy
놀랍도록 친절한 오류 메세지..ㅎ
해결 방법
@Autowired 필드 명 매칭
@Autowired 는 타입 매칭을 시도하고, 이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.
@Autowired
private DiscountPolicy DiscountPolicy
// 필드 명을 빈 이름으로 변경
@Autowired
private DiscountPolicy rateDiscountPolicy 필드 명이 rateDiscountPolic 이므로 정상 주입된다.
필드 명 매칭은 먼저 타입 매칭을 시도 하고 그 결과에 여러 빈이 있을 때 추가로 동작하는 기능이다.
@Qualifier 사용
@Qualifier 는 추가 구분자를 붙여주는 방법이다. 주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변 경하는 것은 아니다
@Componen
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}
@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}생성자 자동 주입 예시
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}수정자 자동 주입 예시
@Autowire
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
return discountPolicy;
}김영한 선생님의 팁
@Qualifier 로 주입할 때 @Qualifier("mainDiscountPolicy") 를 못찾으면 어떻게 될까? 그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. 하지만 경험상 @Qualifier 는 @Qualifier 를 찾는 용도로만 사용하는게 명확하고 좋다.
@Primary 사용
@Primary 는 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면 @Primary 가 우선권을 가진다.
@Componen
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}
@Component
public class FixDiscountPolicy implements DiscountPolicy {}실행 시 @Primary 가 붙은 RateDiscountPolicy가 우선 매칭 된다.
@Primary, @Qualifier 활용
코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능 으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자. 메인 데이터 베이스의 커넥션을 획득하는 스프링 빈은 @Primar 를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifie 를 지정해서 명시적으로 획 득 하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다. 물론 이때 메인 데이터베이스의 스프링 빈을 등 록할 때 @Qualifier 를 지정해주는 것은 상관없다.
