[Spring] 의존관계 자동 주입

DEINGVELOP·2023년 4월 16일
Spring
0

Spring 핵심 원리 - 기본

목록 보기
9/11

의존관계 주입 방법

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

1. Constructor Injection (생성자 주입)

방법

@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번만 호출되는 것이 보장된다.
  • 불변, 필수 의존관계에 사용
  • 요즘 가장 많이 쓰임

💡 중요!
해당 클래스에 생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입 된다.
(물론 스프링 빈에만 해당한다.)

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

최근에는 스프링 뿐만 아니라 다른 DI 프레임워크들도 대부분 생성자 주입을 권장한다.

이유 1 : 불변성

  • 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다.(불변해야 한다.)

  • 수정자 주입 : setXxx 메서드를 public으로 열어두어야 한다.

  • 누군가 실수로 변경할 수 도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.

    👉🏻 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불변하게 설계할 수 있다.

이유 2 : 누락 방지

  • @Autowired : 프레임워크 없이 순수한 자바 코드로만 단위 테스트를 수행하게 되면 의존관계가 없어도 오류가 발생하지 않는다.
  • 수정자 주입 : 의존관계를 실수로 누락하면, 실행은 되는데 NPE가 발생한다.
  • 생성자 주입 : 주입 데이터를 누락 했을 때 컴파일 오류가 발생한다.
  • 그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.

이유 3 : final 키워드

  • 생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다. 그래서 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다.
  • 발생하는 오류 : java: variable discountPolicy might not have been initialized

💡 참고

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

2. Setter Injection (수정자 주입)

방법

@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 의 기본 동작은 주입할 대상이 없으면 오류가 발생한다.
  • 주입할 대상이 Spring Container에 없어도 동작하게 하려면 @Autowired(required = false) 로 지정하면 된다.

특징

  • 선택, 변경 가능성이 있는 의존관계에 사용
    (중간에 필드 의존 관계를 바꾸고 싶을 때, 외부에서 냅다 setter 사용해서 바꿀 수 있음)
  • 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.
  • 생성자 주입과 달리, 생성과 동시에 의존관계 주입이 되는 원리는 아님
  • 종종 쓰임

💡 참고: 자바빈 프로퍼티란?

  • 자바에서는 과거부터 필드의 값을 직접 변경하지 않고, setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는 규칙을 만들었는데, 그것이 자바빈 프로퍼티 규약이다.

3. Field Injection (필드 주입)

방법

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

💡 참고

  • 순수한 자바 테스트 코드에는 당연히 @Autowired가 동작하지 않는다.
  • @SpringBootTest처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능하다

특징

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

참고
위의 방법이 아닌, 그냥 new로 바로 직접 자동 주입하는 방식도 역시 추천되지 않는다.

  • 자동 등록 : 다음 코드와 같이 @Bean에서 파라미터에 의존관계는 자동 주입된다.
@Bean
OrderService orderService(MemberRepository memberRepoisitory, DiscountPolicy 
discountPolicy) {
 	new OrderServiceImpl(memberRepository, discountPolicy)
}
  • 수동 등록 : 자동 등록된 빈의 의존관계가 필요할 때 문제를 해결할 수 있다.

4. 일반 메서드 주입

방법

@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 코드를 적용해도 아무 기능도 동작하지 않는다!

📌 정리 - 생성자 주입 방식을 선택하자!

  • 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이다.
  • 항상 생성자 주입을 선택해라! 그리고 가끔 옵션이 필요하면 수정자 주입을 선택해라. (생성자 주입과 수정자 주입을 동시에 사용할 수 있다.)
  • 필드 주입은 사용하지 않는게 좋다
  • Lombok의 @RequiredArgsConstructor를 보통 사용한다.

Options

자동 주입을 옵션으로 처리하기

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

방법 3가지

방법 1. @Autowired(required=false)

: 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨

//호출 안됨
@Autowired(required = false)
public void setNoBean1(Member member) {
	System.out.println("setNoBean1 = " + member);
}

방법 2 : org.springframework.lang.@Nullable

: 자동 주입할 대상이 없으면 null이 입력된다.

//null 호출
@Autowired
public void setNoBean2(@Nullable Member member) {
	System.out.println("setNoBean2 = " + member);
}

방법 3 : Optional<>

: 자동 주입할 대상이 없으면 Optional.empty가 입력된다.

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

출력 결과

setNoBean2 = null
setNoBean3 = Optional.empty
  • Member는 스프링 빈이 아니다.
  • setNoBean1() 은 @Autowired(required=false) 이므로 호출 자체가 안된다.

참고

  • @Nullable, Optional은 스프링 전반에 걸쳐서 지원된다.
  • 예를 들어서 생성자 자동 주입에서 특정 필드에만 사용해도 된다.

Lombok

@RequiredArgsConstructor

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

@Autowired와 중복 타입의 빈 충돌

  • @Autowired : Type으로 조회함
    타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.
    • 발생하는 오류 : NoUniqueBeanDefinitionException

해결 방법

  • 하위 타입으로 지정 : DIP를 위배하고 유연성이 떨어진다.
  • 타입이 똑같은 빈 여러 개 or 자식 여러 개 : 해결이 안된다.
  • 빈 수동 등록도 방법이지만, 의존관계 자동 주입에서도 해결 가능

방법 1 : @Autowired 매칭 방법

  1. 타입 매칭
  2. 타입 매칭의 결과가 2개 이상일 때 필드 명, 파라미터 명으로 빈 이름 매칭

방법 2 : @Qualifier

: 추가 구분자를 붙여주는 방법

  • 주입시 추가적인 방법을 제공하는 것이지 빈 이름을
    변경하는 것은 아니다

즉,
1. @Qualifier끼리 매칭
2. 빈 이름 매칭
3. NoSuchBeanDefinitionException 예외 발생

방법

@Component
@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;
}
  • 수정자 자동 주입
    @Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy")
DiscountPolicy discountPolicy) {
    this.discountPolicy = discountPolicy;
}

    참고

    • @Qualifier 로 주입할 때 @Qualifier("mainDiscountPolicy")를 못찾으면 → mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.
    • 하지만 경험상 @Qualifier는 같은 @Qualifier를 찾는 용도로만 사용하는게 명확하고 좋다.

방법 3 : @Primary

@Primary는 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면 @Primary가 우선권을 가진다.

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Qualifier vs @Primary

  • Main-DB Connection 획득 스프링 빈 : @Primary를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회
  • Sub-DB Connection 획득 스프링 빈 : @Qualifier를 지정해서 명시적으로 획득 하는 방식으로 사용

→ 코드를 깔끔하게 유지할 수 있다.

둘 중 적용되는 우선순위는?

  • 스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다.
    → 여기서도 @Qualifier 가 우선권이 높다

Annotation 직접 만들기

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 {
}
  • 애노테이션에는 상속이라는 개념이 없다. 이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다. - @Qulifier 뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다.
    • 단적으로 @Autowired도 재정의 할 수 있다. 물론 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 더 혼란만 가중할 수 있다.

Spring과 전략 패턴

  • 의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있다. 예를 들어서 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정해보자.
  • 스프링을 사용하면, 정말 쉽게 전략 패턴을 사용할 수 있다.
package hello.core.autowired;

import hello.core.AutoAppConfig;
import hello.core.discount.DiscountPolicy;
import hello.core.member.Grade;
import hello.core.member.Member;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import java.util.List;
import java.util.Map;

import static org.assertj.core.api.Assertions.assertThat;

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

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

1) 기본 권장 - 편리한 자동 기능 사용

  • 스프링은 @Component 뿐만 아니라 @Controller, @Service, @Repository 처럼 계층에 맞추어 일반적인
    애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다.
  • 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.
  • 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

2) 그러면, 수동 기능은 언제?

2-1) 기술 지원 빈에 사용

: 애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체에 사용!

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

  • 업무 로직 빈
    • 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등등
    • 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
  • 기술 지원 빈
    • 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용됨
    • 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들

업무 로직

  • 숫자도 매우 많음
  • 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있음
  • 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉬움

기술 지원 로직

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

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


2-2) 특이 케이스 : 비즈니스 로직 중에서도 수동이 필요할 경우

: 다형성을 적극 활용할 때!

  • 위의 AllBeanTest 같은 경우, 어떤 빈들이 주입될지, 각 빈의 이름이 무엇일지 등은 코드만 보고 파악하기 어렵다.

    • 자동 등록을 사용하고 있기 때문에, 파악하려면 여러 코드를 찾아봐야 함!

  • 이럴 경우에는, 수동 빈으로 등록하거나 또는 자동으로 하면 특정 패키지에 같이 묶어두는 게 좋다!

    👉🏻 핵심은, 딱 보고 이해가 되어야 한다!

    • 수동 빈으로 등록하기

      @Configuration
public class DiscountPolicyConfig {

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

💡 참고!

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

[Spring] Component Scan, @Autowired

다음 포스트

[Spring] Bean Lifecycle Callback

0개의 댓글