다양한 의존관계 주입방법
- 생성자 주입
- 수정자 주입(setter 주입)
- 필드 주입
- 일반 메서드 주입
생성자 주입
- 이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법이다.
- 지금까지 우리가 진행했던 방법이 생성자 주입이다.
특징
- 생성자 호출시점에 딱 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를 생략해도 자동 주입 된다. 물론, 스프링 빈에만 해당된다.
수정자 주입(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)로 지정하면 된다.
필드 주입
- 이름 그대로 필드에 바로 주입하는 방법이다.
특징
- 코드가 간결해서 많은 개발자를 유혹하지만, 외부에서 변경이 불가능해서 테스트하기 힘들다는 치명적인 단점이 있다.
- memberRepository를 dummy로 바꿔서 테스트하고 싶을 때, 방법이 없다. 코드를 수정해야한다.
- DI 프레임워크가 없으면 아무것도 할 수 없다.
- 사용하지 말자!
- 애플리케이션의 실제 코드와 관계 없는 테스트코드에 사용
- 스프링 설정을 목적으로하는 @Configuration 같은 곳에서만 특별한 용도로 사용
일반 메서드 주입
- 일반 메서드에 @Autowired를 넣을 수 있다.
특징
- 한번에 여러 필드를 주입 받을 수 있다.
- 일반적으로 잘 안쓴다.
옵션 처리
- 주입할 스프링 빈이 없어도 동작해야 할 때가 있다.
- required 옵션을 false로 주어서 빈이 없어도 동작하게 할 수 있다.
@Autowired(required= false)
- 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출되지 않는다.
@Nullable
- 자동 주입할 대상이 없으면 null로 넣어서 호출 된다.
Optional<>
- 자동 주입할 대상이 없으면 Optional.empty로 넣어서 호출된다.
public class AutowiredTest{
@Test
void AutowiredOption() {
ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
}
static class TestBean {
@Autowired(required = false)
public void setNoBean1(Member member) {
System.out.println("noBean1 = " + member);
}
@Autowired
public void setNoBean2(@Nullable Member member) {
System.out.println("noBean2 = " + member);
}
@Autowired
public void setNoBean3(Optional<Member> member) {
System.out.println("noBean3 = " + member);
}
}
}noBean2 = null
noBean3 = Optional.empty
생성자 주입을 선택해라!
- 과거에는 수정자 주입과 필드 주입을 많이 사용했지만, 최근에는 모든 DI프레임 워크가 생성자 주입을 권장한다.
불변
- 대부분 의존관계 주입은 한번 일어나면 애플맅케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려 대부분 의존관계는 종료전 까지 변하면 안된다.
- 수정자 주입을 사용하면 setXxx를 열어두어야 하므로 누군가가 호출할 수도 있다.
누락
- 프레임워크 없이 순수한 자바 코드를 단위 테스트 하는 경우에 setter 주입을 사용할 경우, setter를 호출하지 않으면 null exception이 뜨게 된다.
- 하지만, 생성자 주입을 사용하면 컴파일 에러가 떠버린다. 반드시 임의의 테스트 객체를 만들어서 주입시켜주어야한다.
final
- 생성자 주입을 사용하면 필드에
final키워드를 사용할 수 있다. 그래서 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다.
정리
- 생성자 주입을 사용하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 가장 잘 살리는 방법이기도 하다.
- 기본적으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다. 동시에 사용해도 상관없다.
- 항상 생성자 주입을 선택하자! 필요한 경우 수정자 주입방식을 선택해서 옵션으로 제공하자! 필드주입을 머리에서 잊자!
롬복과 최신 트렌드
- 막상 개발해보면, 대부분 다 불변이고, 생성자에 final 키워드를 사용하게 된다.
- 생성자도 만들고, 주입 받는 값 대입하는 코드도 만들고… 필드 주입보다 귀찮다.
- 생성자가 하나만 있으면
@Autowired를 생략할 수 있지만, 그래도 생성자는 다 적어주어야한다.
@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
}- Lombok을 사용하면, 이렇게 생성자를 명시해주지 않아도, 알아서 final이 붙은 필드를 초기화하는 생성자가 생긴다.
- 최근에는 생성자를 딱 1개 두고,
@Autowired를 생략하는 방법을 주로 사용한다. 여기에 Lombok 라이브러리의@RequiredArgsConstructor를 함께 사용하면 기능은 다 제공되면서, 코드는 깔끔하게 사용할 수 있다.
조회 빈이 2개 이상 - 문제
@Autowired는 type으로 조회한다. 즉,ac.getBean(DiscountPolicy.class)와 유사하게 동작한다(실제론 더 많은 기능을 제공한다고 한다)
DiscountPolicy의 하위 타입인FixDiscountPolicy와RateDiscountPolicy둘 다 스프링 빈으로 선언해보자.
org.springframework.beans.factory.NoUniqueBeanDefinitionException: No qualifying bean of type 'hello.core.discount.DiscountPolicy' available: expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy- 이렇게 NoUniqueBeanDefinitionException 오류가 발생한다.
- 물론, 하위타입으로 지정할 수 있지만, 그럼 DIP를 위반하고 유연성이 떨어진다. 그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안된다.
- 물론, 수동 등록하여 문제를 해결해도 된다. 그래도 우리는 자동을 사용할 것이므로 자동 등록에서 문제를 해결해보자.
@Autowired 필드 명, @Qualifier, @Primary
@Autowired 필드 명 매칭
@Autowired는 타입 매칭을 시도하고, 이때 여러 빈이 있으면 필드 이름(파라미터 이름)으로 빈 이름을 추가 매칭한다.
private final DiscountPolicy discountPolicy;
=>
private final DiscountPolicy fixDiscountPolicy;- 이렇게 변경해주면, 알아서 FixDiscountPolicy를 주입해준다.
- 먼저 타입부터 매칭을 시도하고, 빈이 2개 이상이면 필드 이름으로 매칭한다.
@Qualifier
@Qualifier는 추가 구분자를 붙여주는 방법이다. 추가적인 방법을 제공하는 것이지, 빈 이름 자체를 변경하는건 아니다.
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}- 이렇게 넣어줄 수 있다.
- 만약,
@Qualifier("mainDiscountPolicy")를 못 찾으면 어떻게 될까? 그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. ⇒ 헷갈리니 이런 일이 없도록 하자.
Qualifier 정리
- Quilifier끼리 매칭
- 빈 이름 매칭
- 없으면
NoBeanDefinitionException예외 발생
@Primary
- 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭 되면
@Primary가 우선권을 갖는다.
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy
@Component
public class FixDiscountPolicy implements DiscountPolicy이렇게 하면, RateDiscountPolicy가 우선권을 갖게 된다.
@Primary, @Qualifier 활용
코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고,
코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자.
메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary 를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고,
서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier 를 지정해서 명시적으로 획득 하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.
물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 @Qualifier 를 지정해주는 것은 상관없다.
우선순위
@Primary는 기본값처럼 동작하고, @Qualifier는 매우 상세하게 동작한다. 스프링의 대 원칙은 상세한 설정이 우선권이 더 높으므로, @Qualifer가 더 우선순위가 높다.
애노테이션 직접 만들기
@Qualifer(”mainDiscountPolicy”)이렇게 적으면, 컴파일 시 타입 체크가 안 된다. 그래서, 애노테이션을 직접 정의해서 해결할 수 있다.
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}- 이렇게 해주면 된다.
- 애노테이션에는 상속이라는 개념이 없다. 이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다.
@Qualifer뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다. 다만, 애노테이션을 무분별하게 정의하는 것은 유지보수를 더 어렵게 만든다.
조회한 빈이 모두 필요할 때, List, Map
- 의도적으로 정말 해당 타입의 스트링 빈이 모두 다 필요한 경우가 있다.
- 예를 들어, 클라이언트가 할인의 종류를 선택할 수 있다고 가정해보자(fix, rate). 그럼 두 policy모두 서비스단에서 필요하게 된다.
public class AllBeanTest {
@Test
void findAllBean() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);
}
static class DiscountService {
private final Map<String, DiscountPolicy> policyMap;
private final List<DiscountPolicy> policies;
@Autowired
public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies) {
this.policyMap = policyMap;
this.policies = policies;
System.out.println("policyMap = " + policyMap);
System.out.println("policies = " + policies);
}
}
}- 이렇게, 그냥 parameter로 받으면 알아서 모두 받는다.
public class AllBeanTest {
@Test
void findAllBean() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);
DiscountService discountService = ac.getBean(DiscountService.class);
Member member = new Member(1L, "userA", Grade.VIP);
int discountPrice = discountService.discount(member, 10000, "fixDiscountPolicy");
Assertions.assertThat(discountService).isInstanceOf(DiscountService.class);
Assertions.assertThat(discountPrice).isEqualTo(1000);
int rateDiscountPrice = discountService.discount(member, 20000, "rateDiscountPolicy");
Assertions.assertThat(rateDiscountPrice).isEqualTo(2000);
}
static class DiscountService {
private final Map<String, DiscountPolicy> policyMap;
private final List<DiscountPolicy> policies;
public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies) {
this.policyMap = policyMap;
this.policies = policies;
System.out.println("policyMap = " + policyMap);
System.out.println("policies = " + policies);
}
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”도 마찬가지다.
자동, 수동의 올바른 실무 운영 기준
편리한 자동 기능을 기본으로 사용하자
그러면 어떤 경우에 컴포넌트 스캔과 자동 주입을 사용하고, 어떤 경우에 설정 정보를 통해서 수동으로 빈을 등록하고, 의존관계도 수동으로 주입해야 할까?
결론부터 이야기하면, 스프링이 나오고 시간이 갈 수록 점점 자동을 선호하는 추세다. 스프링은 @Component 뿐만 아니라 @Controller , @Service , @Repository 처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다. 거기에 더해서 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.
설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만, 개발자 입장에서 스프링 빈을 하나 등록할 때 @Component 만 넣어주면 끝나는 일을 @Configuration 설정 정보에 가서 @Bean 을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정은 상당히 번거롭다.
또 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 된다. 그리고 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.
그러면 수동 빈 등록은 언제 사용하는게 좋을까?
애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.
- 업무 로직 빈: 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.
- 기술 지원 빈: 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.
기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다. 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 들어나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 들어내는 것이 좋다.
💡
애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 딱! 설정 정보에 바로 나타나게 하는 것이 유지보수 하기 좋다.
비지니스 로직에서 다형성을 적극 활용할 때
DiscountService 가 의존관계 자동 주입으로 Map<String, DiscountPolicy>에 주입을 받는 상황을 생각해보자. 여기에 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일지 코드만 보고 한번에 쉽게 파악할 수 있을까? 내가 개발했으니 크게 관계가 없지만, 만약 이 코드를 다른 개발자가 개발해서 나에게 준 것이라면 어떨까?
이 부분을 별도의 설정 정보로 만들고 수동으로 등록하면 다음과 같다.
@Configuration public class DiscountPolicyConfig {
@Bean
public DiscountPolicy rateDiscountPolicy() {
return new RateDiscountPolicy();
}
@Bean
public DiscountPolicy fixDiscountPolicy() {
return new FixDiscountPolicy();
}
}이 설정 정보만 봐도 한눈에 빈의 이름은 물론이고, 어떤 빈들이 주입될지 파악할 수 있다. 그래도 빈 자동 등록을 사용하고 싶으면 파악하기 좋게 DiscountPolicy 의 구현 빈들만 따로 모아서 특정 패키지에 모아두자.
참고로 스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 예외다. 이런 부분들은 스프링 자체를 잘 이해하고 스프링의 의도대로 잘 사용하는게 중요하다. 스프링 부트의 경우 DataSource 같은 데이터베이스 연결에 사용하는 기술 지원 로직까지 내부에서 자동으로 등록하는데, 이런 부분은 메뉴얼을 잘 참고해서 스프링 부트가 의도한 대로 편리하게 사용하면 된다. 반면에 스프링 부트가 아니라 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 들어내는 것이 좋다.
정리
- 편리한 자동 기능을 기본으로 사용하자
- 직접 등록하는 기술 지원 객체는 수동 등록
- 다형성을 적극 활용하는 비지니스 로직도 수동 등록
Uploaded by N2T
(23.05.31 22:36)에 작성된 글 입니다.
