의존관계 자동 주입

1.다양한 의존관계 주입 방법

의존관계 주입은 크게 4가지

1. 생성자 주입
2. 수정자 주입(setter 주입)
3. 필드 주입
4. 일반 메서드 주입

 

 

생성자 주입

- 생성자를 통해서 의존 관계를 주입 받는 방법

• 생성자 호출시점에 딱 1번만 호출되는 것이 보장.
• 불변, 필수 의존관계에 사용

💡 생성자가 1개만 있으면 @Autowired를 생략해도 자동 주입(스프링 빈에만 해당)

@Component
public class OrderServiceImpl implements OrderService {
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
    
    @Autowired //생성자가 1개임으로 생략가능
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy
            discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
}

 

setter 주입

- setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입

• 선택, 변경 가능성이 있는 의존관계에 사용
• 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.

💡

@Autowired 의 기본 동작은 주입할 대상이 없으면 오류가 발생  ▶  @Autowired(required = false) 로 지정하면 된다.

자바빈 규약 : 필드의 값을 직접 변경하지 않고, setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는 규칙

 

 

 

필드 주입

- 필드에 바로 주입하는 방법

• 코드가 간결해서 많은 개발자들을 유혹하지만 외부에서 변경이 불가능해서 테스트 하기 힘들다는
  치명적인 단점이 있다.
• DI 프레임워크가 없으면 아무것도 할 수 없다.
• 사용하지 말자
  애플리케이션의 실제 코드와 관계 없는 테스트 코드
  스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

@Component
public class OrderServiceImpl implements OrderService {
    @Autowired
    private MemberRepository memberRepository;
    @Autowired
    private DiscountPolicy discountPolicy;
}

💡 순수한 자바 테스트 코드에는 @Autowired가 동작하지 않는다.

@SpringBootTest 처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능하다.

 

 

 

일반 메서드 주입

- 일반 메서드를 통해서 주입

• 한번에 여러 필드를 주입 받을 수 있다.
• 잘 사용하지 않는다.

@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;
    }
}

 

 

2. 생성자 주입을 선택해라

보통의 경우 생성자 주입을 권장한다.

1. 불변
   -  특별한 경우가 아닌 이상 대부분의 의존관계 주입은 한번 일어나고 애플리케이션 종료시점까지 변경할 일이 없다.
   -  생성자 주입의 경우 set메서드를 사용을 위해 접근제어자가 public이기 때문에 변경이 가능하다.
   -  생성자 주입은 객체 생성시 1번만 호출되기 때문에 불변하다.
2. 누락
   -  생성자 주입을 사용하면 데이터가 누락되었을 때 컴파일 오류가 발생하기 때문에 바로 문제를 찾을 수 있다.
3. final
   -  실수로 값을 설정하지 않더라도 final 키워드를 통해 컴파일 시점에 오류를 찾을 수 있다.
   -  생성자 주입 방식외에는 모두 생성자 이후에 호출되므로,  final 키워드를 사용할 수 없다. 

 

💡

• 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법
• 기본적으로 생성자 주입을 사용하고, 필요시에 setter 주입을 사용, 필드주입은 쓰지 않는 것이 좋다.

 

3. 롬복과 최신 트랜드

개발을 해보면 대부분이 불변이기 때문에 필드에 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;
    }
    */
}

💡
생성자를 딱 1개 두고, @Autowired 를 생략하는 방법을 주로 사용하고,

롬복 라이브러리의 @RequiredArgsConstructor 함께 사용하면 기능은 다 제공하면서, 코드는 깔끔하게 사용할 수 있다.

 

 

4. 조회 빈이 2개 이상 - 문제

할인정책의 경우 DiscountPolicy 인터페이스를 FixDiscountPolicy와 RateDiscountPolicy 두가지가 구현되어 있는데,
둘 다 @Component를 통해 스프링빈에 등록하면 문제가 생긴다.
@Autowired는 타입으로 조회하게 되는데 Fix와 Rate 둘다 DiscountPolicy의 하위타입이기 때문.

org.springframework.beans.factory.UnsatisfiedDependencyException: 
Error creating bean with name 'orderServiceImpl' defined in file [C:\Users\ServiceImpl.class]: 
Unsatisfied dependency expressed through constructor parameter 1; 
nested exception is org.springframework.beans.factory.NoUniqueBeanDefinitionException: 
No qualifying bean of type 'hello.core.discount.DiscountPolicy' available: 
expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy

하위 타입을 지정해서 해결하면 DIP를 위배하게 되고, 수동으로 등록하는 방법도 있지만

의존 관계 자동 주입에서 해결하는 여러 방법이 있다.

 

 

1. @Autowired 필드 명 매칭
2. @Qualifier @Qualifier끼리 매칭 (빈 이름 매칭)
3. @Primary 사용

 

 

1. @Autowired 필드 명 매칭

@Autowired는 처음에 타입으로 매칭을 시도하고, 빈이 여러개가 있으면 필드, 파라미터 이름으로 매칭을 시도한다.

 

//필드명
private final DiscountPolicy discountPolicy; // 에러
private final DiscountPolicy rateDiscountPolicy; // 성공


//========================================================================================

//파라미터명
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
} // 에러

public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy rateDiscountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = rateDiscountPolicy;
} // 성공

 

2. @Qualifier

@Qualifier는 추가 구분자를 통해 구분할 수 있는 방법을 제공한다.(이름변경 x)

 

//빈 등록시 @Qualifier 사용
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}



//생성자 파라미터에 @Qualifier("mainDiscountPolicy") 추가
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = rateDiscountPolicy;
}

📌 필드, 직접 빈 등록, 수정자 주입, 필드 주입 등 모두 @Qualifier 사용 가능

 

 

❗  @Autowired와 비슷하게 @Qualifier("mainDiscountPolicy")를 찾지 못하면 mainDiscountPolicy라는 이름의 스프링빈을 추가로 탐색한다. 하지만 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 것이 명확하고 좋다.

 

 

@Primary 사용

우선순위 지정 (빈이 여러개일 때, @Primary로 지정된 빈이 우선적으로 선택된다)

 

@Component
@Primary // 추가
public class RateDiscountPolicy implements DiscountPolicy {}

📌 @Primary, @Qualifier 활용

메인으로 사용한 빈에는 @Primary를 사용하고 서브로 가끔 사용하는 빈은 @Qualifier 지정을 통해 명시적으로 획득하는 식으로 사용할 수 있다.

 

📌  우선순위

@Primary 는 기본값 처럼 동작하는 것이고, @Qualifier 는 매우 상세하게 동작한다.

스프링은 자동보다는 수동, 넒은 범위의 보다는 좁은 범위의 선택권이 우선 순위가 높기 때문에 @Qualifier 가 우선이다.

 

 

5. 애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 를 사용할 때 "mainDiscountPolicy"는 단순 문자이기 때문에 컴파일 시 타입 체크가 안된다는 문제가 있다.

 

이럴 경우 직접 애노테이션을 만들어 해결이 가능하다. 

 

@Qualifier 내부에 있는 어노테이션들을 복사해서 직접 생성한 애노테이션에 추가하고 @Qualifier("mainDiscountPolicy") 을 붙이면 @MainDiscountPolicy를 사용할 수 있다.

 

/**
 * This annotation may be used on a field or parameter as a qualifier for
 * candidate beans when autowiring. It may also be used to annotate other
 * custom annotations that can then in turn be used as qualifiers.
 *
 * @author Mark Fisher
 * @author Juergen Hoeller
 * @since 2.5
 * @see Autowired
 */
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Qualifier {

   String value() default "";

}

 

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {

}

 

@Component
@MainDiscountPolicy // 추가
public class RateDiscountPolicy implements DiscountPolicy {}

이렇게하여 @Qualifier("xxx") 사용시 혹시 모를 오타에도 대비할 수 있다.

 

 

📌 애노테이션은 상속의 개념이 아니고 스프링에서 지원해주는 기능이다. 그래서 여러 애노테이션을 조합해서 사용할 수 있고, 재정의도 가능하지만 무분별하게 사용하면 유지보수에 혼란을 줄 수 있다.

 

 

👉 @Primary와 @Qualifier를 상황에 맞게 적절히 사용하면 된다.

 

 

6. 조회한 빈이 모두 필요할 때, List, Map

의도적으로 해당 타입의 스프링 빈이 다 필요한 경우

Ex) 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정

static class DiscountService {
        private final Map<String, DiscountPolicy> policyMap;
        private final List<DiscountPolicy> policies;

        public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policyLidst) {
            this.policyMap = policyMap;
            this.policies = policyLidst;
            System.out.println("policyMap = " + policyMap);
            System.out.println("policyLidst = " + policyLidst);
        }

        public int discount(Member member, int price, String discountCode) {

            DiscountPolicy discountPolicy = policyMap.get(discountCode);

            return discountPolicy.discount(member, price);
        }
    }

 

👉 동적으로 빈을 선택해야 할 때 Map이나 List를 사용하면 편리하게 사용 가능하다.

 

 

7. 자동, 수동의 올바른 실무 운영 기준

편리한 자동 기능을 기본으로 사용하자

 

스프링은 @Component 뿐만 아니라 @Controller , @Service , @Repository 처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다. 

 

설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만,

 @Component 만 넣어주면 끝나는 일을 @Configuration 설정 정보에 가서 @Bean 을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정은 상당히 번거롭다. 또 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 된다.

그리고 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

 

 

수동 빈 등록은 언제 사용하면 좋을까?

애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.

업무 로직 빈: 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는
리포지토리등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.

기술 지원 빈: 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 
공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한
패턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가
발생했는지 명확하게 파악하기 쉽다.

기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게
영향을 미친다. 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 드러나지만, 기술 지원
로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다. 그래서 이런 기술 지원 로직들은
가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.

 

애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 딱! 설정 정보에 바로 나타나게 하는 것이 유지보수 하기 좋다.

 

비즈니스 로직 중에서 다형성을 적극 활용할 때

 

의존관계 자동 주입 - 조회한 빈이 모두 필요할 때, List, Map을 다시 보자.
DiscountService 가 의존관계 자동 주입으로 Map<String, DiscountPolicy> 에 주입을 받는 상황을
생각해보자. 여기에 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일지 코드만 보고 한번에 쉽게 파악할 수
있을까? 내가 개발했으니 크게 관계가 없지만, 만약 이 코드를 다른 개발자가 개발해서 나에게 준 것이라면
어떨까?
자동 등록을 사용하고 있기 때문에 파악하려면 여러 코드를 찾아봐야 한다.

 

이런 경우 수동 빈으로 등록하거나 또는 자동으로하면 특정 패키지에 같이 묶어두는게 좋다! 핵심은 딱 보고
이해가 되어야 한다!

@Configuration
public class DiscountPolicyConfig {

    @Bean
    public DiscountPolicy rateDiscountPolicy() {
        return new RateDiscountPolicy();
    }
    @Bean
    public DiscountPolicy fixDiscountPolicy() {
        return new FixDiscountPolicy();
    }
}

이 설정 정보만 봐도 한눈에 빈의 이름은 물론이고, 어떤 빈들이 주입될지 파악할 수 있다. 그래도 빈 자동 등록을 사용하고 싶으면 파악하기 좋게 DiscountPolicy 의 구현 빈들만 따로 모아서 특정 패키지에 모아두자.

참고로 스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 예외다. 이런 부분들은 스프링 자체를 잘 이해하고 스프링의 의도대로 잘 사용하는게 중요하다. 스프링 부트의 경우 DataSource 같은 데이터베이스 연결에 사용하는 기술 지원 로직까지 내부에서 자동으로 등록하는데, 이런 부분은 메뉴얼을 잘 참고해서 스프링 부트가 의도한 대로 편리하게 사용하면 된다. 반면에 스프링 부트가 아니라 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 드러내는 것이 좋다.

 

 

정리 편리한 자동 기능을 기본으로 사용하자 직접 등록하는 기술 지원 객체는 수동 등록 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해보자