[Spring] 스프링 핵심 원리 - 기본편 섹션 7 의존관계 자동 주입

본 내용은 인프런 김영한T 스프링 핵심원리 - 기본편 강의를 정리한 내용입니다:)

 

[Spring] 스프링 핵심 원리 - 기본편 섹션 7 의존관계 자동 주입

💨 다양한 의존관계 주입 방법

💚 의존관계 주입법

• 생성자 주입
• 수정자 주입(setter 주입)
• 필드 주입
• 일반 메서드 주입

생성자 주입

• 생성자 호출시점에 딱 1번만 호출 보장
• 불변, 필수 의존관계에 사용
• 스프링빈에서 생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입된다.

@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
	this.memberRepository = memberRepository;
	this.discountPolicy = discountPolicy;
}

수정자 주입(setter 주입)

• 선택, 변경 가능성이 있는 의존관계에 사용

@Autowired
 public void setMemberRepository(MemberRepository memberRepository) {
 	this.memberRepository = memberRepository;
 }

 

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

필드 주입

• 외부에서 변경이 불가능해서 테스트 하기 힘들다.
• DI 프레임워크가 없으면 아무것도 할 수 없다. 되도록 사용하지 말것.

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

 

일반 메서드 주입

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

@Autowired
 public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
     this.memberRepository = memberRepository;
     this.discountPolicy = discountPolicy;
 }

⬛ 옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때 옵션처리를 해준다. @Autowired 만 사용하면 required 옵션의 기본값이 true 로 되어 있어서 자동 주입 대상이 없으면 오류가 발생한다

• @Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨
• org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력된다.
• Optional<> : 자동 주입할 대상이 없으면 Optional.empty 가 입력된다.

public class AutowiredTest {
    @Test
    void AutowiredOption() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(
                TestBean.class);
    }
    static class TestBean {
        // 호출 안됨
        @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);
        }

        // Optional.empty 호출
        @Autowired
        public void setNoBean3(Optional<Member> member) {
            System.out.println("setNoBean3(); = " + member);
        }
    }

setNoBean2 = null
setNoBean3(); = Optional.empty

🔘 생성자 주입을 선택해라!

불변

• 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다.(불변해야 한다.)
• 수정자 주입을 사용하면, setXxx 메서드를 public으로 열어두어야 한다. 누군가 실수로 변경할 수 도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.
• 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불변하게 설계할수 있다.

누락

• 생성자 주입을 사용하면 수정자 주입과 달리, 아래처럼주입 데이터를 누락 했을 때 컴파일 오류가 발생한다.그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.

@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;
     // discountPolicy 설정 누락!
     }
 //...
}

 

🪄 수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를 사용할 수 없다. 오직 생성자 주입 방식만 final 키워드를 사용할 수 있다.

💚 정리

• 기본으로 생성자 주입을 사용하고, 가끔 옵션이 필요하거나 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여
• 항상 생성자 주입을 선택해라!

⬛ 롬복과 최신 트랜드

• 롬복 라이브러리가 제공하는 @RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다.
• 롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해준다.

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

- 롬복 설치 후 Enable annotation processing을 체크 후 재시작해준다.

 //lombok 라이브러리 추가 시작
 compileOnly 'org.projectlombok:lombok'
 annotationProcessor 'org.projectlombok:lombok'
 testCompileOnly 'org.projectlombok:lombok'
 testAnnotationProcessor 'org.projectlombok:lombok'
 //lombok 라이브러리 추가 끝

- 롬복 적용 후

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

⬛ 조회 빈이 2개 이상 - 문제

• @Autowired는 타입으로 조회하기 때문에, ac.getBean(Type) 과 유사하게 동작한다.

아래처럼 중복된 DiscountPolicy 하위타입 스프링 빈이 있다면, discountPolicy를 @Autowired할 때NoUniqueBeanDefinitionException 오류가 발생한다.

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

 

하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다.  그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안된다. 스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존 관계 자동 주입에서 해결하는 여러 방법이 있다.

⬛ @Autowired 필드 명, @Qualifier, @Primary

💚 조회 대상 빈이 2개 이상일 때 해결 방법

• @Autowired 필드 명 매칭
• @Qualifier @Qualifier끼리 매칭 빈 이름 매칭
• @Primary 사용

▪️@Autowired 필드 명 매칭

• 타입 매칭
• 타입 매칭의 결과가 2개 이상일 때 필드 명, 파라미터 명(세부)으로 빈 이름 매칭

@Autowired
private DiscountPolicy rateDiscountPolicy //discountPolicy에서 구체명으로 바꿔줌

▪️@Qualifier끼리 매칭 빈 이름 매칭

• @Qualifier끼리 매칭
• 빈 이름 매칭
• NoSuchBeanDefinitionException 예외 발생

@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}

주입시에 아래처럼 @Qulifier(등록한 이름)을 적어준다.

@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
                    @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
 this.memberRepository = memberRepository;
 this.discountPolicy = discountPolicy;
}

만약 @Qulifier(등록한 이름)를 못 찾으면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.

또한, 직접 빈 등록시에도 @Qualifier를 동일하게 사용할 수 있다. (@Bean + @Qualifier(..))

▪️@Primary 사용

• Autowired 시에 여러 빈이 매칭되면 @Primary 가 우선권을 가진다.

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

💚 @Primary, @Qualifier 활용

메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary 를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier 를 지정해서 명시적으로 획득 하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.

 

💚 우선순위

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

⬛ 애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안된다. 다음과 같은 애노테이션을 만들어서 문제를 해결할 수 있다.

 

1. 어노테이션 만들기

package hello.core.annotataion;
import org.springframework.beans.factory.annotation.Qualifier;
import java.lang.annotation.*;
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}

2 메인할인정책 어노테이션 붙여주기

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

3. 생성자 주입에 어노테이션 붙여 구체화

//생성자 자동 주입
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
 @MainDiscountPolicy DiscountPolicy discountPolicy) {
 this.memberRepository = memberRepository;
 this.discountPolicy = discountPolicy;
}

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

해당 타입의 스프링 빈이 다 필요한 경우도 있다. 예를 들어서 할인 서비스에서, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있는 경우이다. 이때 스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있다.

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");

        assertThat(discountService).isInstanceOf(DiscountService.class);
        assertThat(discountPrice).isEqualTo(1000);

    }

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

        public int discount(Member member, int price, String discountCode) {
            DiscountPolicy discountPolicy = policyMap.get(discountCode);
            System.out.println("discountCode = " + discountCode);
            System.out.println("discountPolicy = " + discountPolicy);
            return discountPolicy.discount(member,price);

        }
    }
}

policyMap = {fixDiscountPolicy=com.basic.basicproject.discount.FixDiscountPolicy@7dda48d9, rateDiscountPolicy=com.basic.basicproject.discount.RateDiscountPolicy@6e4566f1}
policies =[com.basic.basicproject.discount.FixDiscountPolicy@7dda48d9,com.basic.basicproject.discount.RateDiscountPolicy@6e4566f1]
discountCode = fixDiscountPolicy
discountPolicy = com.basic.basicproject.discount.FixDiscountPolicy@7dda48d9

💚 로직 분석

• DiscountService는 Map으로 모든 DiscountPolicy 를 주입받는다. (fixDiscountPolicy , rateDiscountPolicy 주입)
• discount () 메서드는 discountCode로 "fixDiscountPolicy"가 넘어오면 map에서 fixDiscountPolicy 스프링 빈을 찾아서 실행

💚 주입 분석

• Map<String, DiscountPolicy> : map의 키에 스프링 빈의 이름을 넣고, 그 값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
• List<DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다. 만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.

💚 스프링 컨테이너를 생성하면서 스프링 빈 등록하기

스프링 컨테이너는 생성자에 클래스 정보를 받는다. 여기에 클래스 정보를 넘기면 해당 클래스가 스프링 빈으로 자동 등록된다.

new AnnotationConfigApplicationContext(AutoAppConfig.class,DiscountService.class);

• new AnnotationConfigApplicationContext() 를 통해 스프링 컨테이너를 생성
• AutoAppConfig.class , DiscountService.class 를 파라미터로 넘기면서 해당 클래스를 자동으로
  스프링 빈으로 등록
• 즉, 스프링 컨테이너를 생성하면서, 해당 컨테이너에 동시에 AutoAppConfig , DiscountService 를 스프링 빈으로 자동 등록

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

• 되도록 자동 빈 등록을 기본사 하자.
•  기술 지원 객체는 수동 빈으로 등록해 설정 정보에 바로 나타나게 하는 것이 유지보수 하기 좋다.
• 비즈니스 로직에서 댜형성을 활용 할 때, 수동 빈으로 등록하거나 또는 자동으로하면 특정 패키지에 같이 묶어두는게 좋다.

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