의존관계 주입방법
생성자 주입
- 생성자를 통해서 의존 관계를 주입 받는 방법이다.
- 생성자 호출시점에 딱 1번만 호출되는 것이 보장된다.
- 불변, 필수 의존관계에 사용된다.
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
//생성자가 1개만 있으면 생략 가능하다.
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
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;
}
}필드 주입
- 이름 그대로 필드에 바로 주입하는 방법이다.
- 코드가 간결해서 좋아보이지만 외부에서 변경이 불가능해서 테스트 하기 힘들다는 단점이 있다.
- 순수 자바 테스트 코드에서는
@Autowired가 동작하지 않아 테스트가 불가능하다. - 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;
}
}옵션 처리
자동 주입할 대상이 없으면 에러가 난다.
하지만 주입할 스프링 빈이 없어도 동작해야 할 때가 있다.
자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.
@Autowired(required=false): 자동 주입할 대상이 없으면 메서드 자체가 호출이 안된다. 생성자 주입에는 사용할 수 없다.@Nullable: 자동 주입할 대상이 없으면 null이 입력된다. 생성자 자동 주입에서 특정 필드에만 사용할 수 있다.Optional<>: 자동 주입할 대상이 없으면Optional.empty가 입력된다. 생성자 자동 주입에서 특정 필드에만 사용할 수 있다.
@Autowired(required = false)
public void setNoBean1(Member member){
System.out.println("Bean1 = " + member);
}
@Autowired
public void setNoBean2(@Nullable Member member){
System.out.println("Bean2 = " + member);
}
@Autowired
public void setNoBean3(Optional<Member> member){
System.out.println("Bean3 = " + member);
}출력결과
Bean2 = null
Bean3 = Optional.empty• member는 스프링 빈이 아니다. 따라서 setNoBean1 메서드는 호출이 안된다.
생성자 주입 권장
최근에는 스프링을 포함한 DI프레임워크 대부분이 생성자 주입을 권장하고 있다.
이유는 불변과 누락 때문이다.
불변
- 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 변경할 일이 없다. 오히려 대부분의 의존관계는 변하면 안된다. (불변)
- 수정자 주입을 사용하면, setXXX 메서드를 public으로 열어둬야한다.
- 누군가 실수로 변경할 수 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.
- 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불변하게 설계할 수 있다
누락
프레임워크 없이 순수한 자바 코드를 단위 테스트 하는 경우에 생성자 주입을 사용하면 다음처럼 주입 데이터를 누락 했을 때 컴파일 오류가 발생한다. 그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.
OrderServiceImpl.java
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
//생성자가 1개만 있으면 생략 가능하다.
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}OrderServiceImplTest.java
@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;
//컴파일 오류 발생
}
}즉, final 키워드는 객체가 생성시점에 초기화되어야한다. 초기화되면 그 값은 변경할 수 없다.
위 코드에서는 final 변수인 discountPolicy를 초기화하지 않았기에 컴파일 오류가 발생한다.
정리
- 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다. 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.
- 항상 생성자 주입을 선택해라! 그리고 가끔 옵션이 필요하면 수정자 주입을 선택해라. 필드 주입은 사용하지 않는게 좋다.
롬복과 최신 트렌드
롬복은 자바 개발자들이 자주 사용하는 라이브러리로 생성자도 만들고, 파라미터도 만들고 대입하는 코드도 만들어준다. 기본 코드를 줄여준다.
변경 전
@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;
}
}변경 후
@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
}@RequiredArgsConstructor 어노테이션(롬복 라이브러리)은 final 이 붙은 필드에 한해서 생성자를 자동으로 만들어준다. 자동으로 필드에 따른 생성자를 자동으로 만들어준다.
단 생성자가 하나일 때만 사용 가능하다. @Autowired를 생략할 수 있기 때문이다.
조회 빈이 2개 이상-문제해결
@Autowired는 타입으로 조회된다. 하위 타입이 2개 이상일 때 상위 타입으로 조회하면 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변경 후
해결방법: @Qualifier 사용
빈 등록 시 @Qualifier를 붙여준다.
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}주입시에 @Qualifier를 붙여주고 주입해줄 빈의 추가 구분자를 붙여준다.
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}직접 빈 등록시
@Bean
@Qualifier("mainDiscountPolicy")
public DiscountPolicy discountPolicy() {
return new ...
}해결방법: @Primary 사용
@Primary는 우선 순위르 정하는 방법. @Primary가 적힌 빈이 우선권을 가진다.
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}
@Component
public class FixDiscountPolicy implements DiscountPolicy {}코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능 으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자.
메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary 를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier 를 지정해서 명시적으로 획 득 하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.
@Primary 는 기본값 처럼 동작하는 것이고, @Qualifier 는 매우 상세하게 동작한다.
이런 경우 어떤 것이 우선권을 가져갈까?
스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 여기서도 @Qualifier 가 우선권이 높다.
조회한 빈이 모두 필요할 때(List, Map 사용)
의도적으로 해당 타입의 스프링 빈이 다 필요한 경우가 있다. 여기서는 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정할 때, 스프링을 사용하면 ‘전략 패턴’을 간단히 구현할 수 있다.
public class AllBeanTest {
@Test
void findAllBean() {
//given
ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);
DiscountService discountService = ac.getBean(DiscountService.class);
Member member = new Member(1L, "memberA", Grade.VIP);
//when
int fixDiscountPrice = discountService.discount(member, 10000, "fixDiscountPolicy");
int rateDiscountPrice = discountService.discount(member, 20000, "rateDiscountPolicy");
//then
Assertions.assertThat(fixDiscountPrice).isEqualTo(1000);
Assertions.assertThat(rateDiscountPrice).isEqualTo(2000);
}
static class DiscountService{
private final Map<String, DiscountPolicy> policyMap;
private final List<DiscountPolicy> policyList;
public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policyList) {
this.policyMap = policyMap;
this.policyList = policyList;
}
public int discount(Member member, int price, String discountCode) {
DiscountPolicy discountPolicy = policyMap.get(discountCode);
return discountPolicy.discount(member, price);
}
}
}로직 분석
DiscountService는 Map으로 모든DiscountPolicy를 주입받는다. 이때,fixDiscountPolicy,rateDiscountPolicy가 주입된다.discount()메서드는discountCode로fixDiscountPolicy가 넘어오면 map에서fixDiscountPolicy스프링 빈을 찾아서 실행한다. 물론rateDiscountPolicy가 넘어오면rateDiscountPolicy스프링 빈을 찾아서 실행한다.
주입 분석
Map<String, DiscountPolicy>: map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로DiscountPolicy타입으로 조회한 모든 스프링 빈을 담아준다.List<DiscountPolicy>:DiscountPolicy타입으로 조회한 모든 스프링 빈을 담아준다. 만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.
자동 빈 등록/수동 빈 등록 비교
| 기준 | 자동 빈 등록 (Auto Bean Registration) | 수동 빈 등록 (Manual Bean Registration) |
|---|---|---|
| 정의 | 어노테이션을 사용하여 스프링이 빈을 자동으로 검색하고 등록하는 방법 | XML 설정 파일이나 Java 설정 클래스를 사용하여 빈을 명시적으로 등록하는 방법 |
| 방법 | @Component, @Service, @Repository, @Controller 등의 어노테이션 사용 | @Bean 어노테이션을 사용하거나 XML 파일에서 빈을 직접 정의 |
| 유연성 | 적은 코드와 설정으로 빠르고 편리하게 빈 등록 가능 | 더 세밀한 제어가 가능하며, 복잡한 설정에 유리 |
| 관리 용이성 | 큰 프로젝트에서 빈이 많을 경우 관리가 어려워질 수 있음 | 명시적인 빈 등록으로 인해 관리가 상대적으로 용이 |
| 자동화 정도 | 높음 (개발자가 직접 빈을 등록할 필요가 없음) | 낮음 (개발자가 직접 빈을 정의하고 관리해야 함) |
| 추적 및 디버깅 | 빈이 자동으로 등록되므로 추적과 디버깅이 어려울 수 있음 | 수동 등록으로 인해 빈의 생성과 관리가 더 명확하고 추적하기 쉬움 |
| 적합한 사용 시나리오 | 단순한 의존성, 규모가 작거나 중간 정도인 프로젝트에 적합 | 복잡한 의존성 구조, 높은 커스터마이징이 필요한 대규모 프로젝트에 적합 |
새로운 것을 배우고 즐기며, 그 안에서 성장하길 원합니다.