Spring - DI 자동 주입

Hyung Jun·2021년 2월 9일
Spring
0

Spring

목록 보기
3/5
post-thumbnail
post-custom-banner

Dependency Injection (DI) 자동 주입

이 글은 김영한님의 '스프링 핵심원리' 강의 내용을 기반으로 작성한 강의 노트이다.
강의 링크 : https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

의존 관계 주입

스프링 컨테이너의 라이프사이클은 아래와 같다.

  1. 스프링 빈을 등록
  2. 의존관계를 주입

스프링 빈을 등록하는 과정에서 자연스레 생성자를 호출하게 되므로 생성자에는 빈등록과 동시에 의존관계가 주입된다.
하지만 그 외의 경우에는 의존관계를 주입하는 단계에서 주입된다.

의존관계 주입은 크게 4가지 방법이 있다

  • 생성자 주입
  • 수정자 주입(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)로 지정하면 된다.
자바진 프로퍼티 규약이란, 자바에서는 과거부터 필드의 값을 직접 변경하지 않고, getter, setter를 이용해서 값을 읽거나 수정하는 규칙을 만들어 왔었는데 이를 말한다.

필드 주입
필드에 바로 의존관계를 주입하는 방식이다.
코드가 간결해지는 장점이 있으나 외부에서 변경이 불가능해서 테스트하기 어려운 치면적인 단점이 있다. DI프레임워크가 없으면 아무것도 할 수 없기 때문에 사용하지 않으면 된다.

일반 메소드 주입
일반 메소드를 통해서 의존관계를 주입 받을 수 있다. 한 번에 여러 필드를 주입 받을 수 있는 특징이 있고, 일반적으로 잘 사용하지는 않는다.

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

옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때가 있는데, @Autowired만 사용하면 required옵션의 기본값이 true로 되어 있어 자동 주입 대상이 없으면 오류가 발생한다.
자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.

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

예제 :

	@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(required = false)
	public void setNoBean3(Optional<Member> member) {
        	System.out.println("setNoBean3 = " + member);
    	}
  • Member는 스프링 빈이 아니기 때문에 호출이 안된다

생성자 주입을 선택하라

최근 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장하는데 그 이유는 다음과 같다.

불변

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

누락

프레임워크 없이 순수하게 자바코드로 단위 테스트를 하는 경우에 수정자 주입을 사용하게 되면 @Autowired가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만, 프레임 워크 없이 테스트를 할 때는 오류 없이 테스트가 실행된다.
그러나 결과가 NPE(Null Point Exception)이 발생하는데, 의존관계가 누락되었기 때문이다.
생성자 주입을 사용하면 주입데이터를 누락 했을 때 컴파일 오류가 발생한다.
코드를 보자.
<프레임 워크 사용하지 않은 경우>

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;
        }
        //...
}

<테스트 코드>

  @Test
  void createOrder() {
      OrderServiceImpl orderService = new OrderServiceImpl();
      orderService.createOrder(1L, "itemA", 10000);
  }

결과는 NPE이다. memberRepository, discountPolicy에 대한 의존관계 주입이 누락되었기 때문이다.

만약 생성자 주입을 사용하면 의존 관계 주입 데이터를 누락 했을 때 컴파일 오류가 발생하고 IDE에서 어떤 값을 필수로 주입해야 하는지 알 수있다.

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;
        }
	//...
    }

필수 필드인 discountPolity에 값을 설정해야 하는데, 이 부분이 누락되었다. 자바는 컴파일 시점에 오류를 발생시키는데
java: variable discountPolicy might not have been initialized라고 뜬다.

정리하면,

생성자 주입 방식을 선택하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고 순수한 자바언어의 특징을 잘 살리는 방법이기도하다. 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다. 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.

Lombok과 최신 트랜드

막상 개발을 해보면, 대부분이 다 불변이고, 그래서 생성자에 final 키워드를 사용하게 된다. 그런데 생성자도 만들어야 하고, 주입받은 값을 대입하는 코드도 만들어야하는 상황에서 편리하게 사용하는 법이 lombok이다.

lombok 라이브러리 적용 방법

롬복 라이브러리가 제공하는 @RequiredArgsConstructor기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다. 

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

이런식으로 작성하면 롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해 준다.

build.gradle에 라이브러리 및 환경을 추가하여 사용할 수 있다.

 plugins {
    id 'org.springframework.boot' version '2.3.2.RELEASE'
    id 'io.spring.dependency-management' version '1.0.9.RELEASE'
    id 'java'
}
group = 'hello'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'
//lombok 설정 추가 시작
configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}
//lombok 설정 추가 끝
repositories {
    mavenCentral()
}
dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
	//lombok 라이브러리 추가 시작
	compileOnly 'org.projectlombok:lombok'
        annotationProcessor 'org.projectlombok:lombok'
	testCompileOnly 'org.projectlombok:lombok'
        testAnnotationProcessor 'org.projectlombok:lombok'
        //lombok 라이브러리 추가 끝
        testImplementation('org.springframework.boot:spring-boot-starter-test') {
            exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
        }
 }
test {
    useJUnitPlatform()
}

조회 빈이 2개 이상 - 문제

@Autowired는 타입(Type)으로 조회한다.

@Autowired
private DiscountPolicy discountPolicy

타입으로 조회하기 때문에, 마치 다음과 같은 코드와 유사하게 동작한다.
ac.getBean(DiscountPolicy.class)
스프링 빈 조회를 할 때 타입으로 조회를 하면 선택된 빈이 2개 이상일 때 문제가 발생한다. DiscountPolity의 하위 타입인 FixDiscountPolicy, RateDicountPolicy 둘 다 스프링 빈으로 설정해 보자.

@Component
pulbic class FixDiscountPolicy implements DiscountPolicy{}

@Component
pulbic class RateDiscountPolicy implements DiscountPolicy{}

그리고 다음과 같이 의존관계 자동 주입을 실행하면,

@Autowired
private DiscountPolicy discountPolicy

NoUniqueBeanDefinitionException 오류가 발생한다.
오류메세지가 하나의 빈을 기대했는데 fixDiscountPolicy, RateDiscountPolicy 2개가 발견되었다고 알려준 것이다.

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

@Autowired 필드 명, @Qualifier, @Primary

@Autowired 필드 명 매칭

@Autowired는 타입 매칭을 시도하고, 이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.
기존 코드가 

@Autowired
private DiscountPolicy discountPolicy

일 때, 

@Autowired
private DiscountPolicy rateDiscountPolicy

필드 명이 rateDiscountPolicy이므로 정상 주입된다.
필드 명 매칭은 먼저 타입 매칭을 시도 하고 그 결과에 여러 빈이 있을 때 추가로 동작하는 기능이다.

@Qualifier 사용

@Qualifier는 추가 구분자를 붙여주는 방법으로 주입 시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.

빈 등록 시 @Qualifier를 붙여 준다.

@Component
@Qualifier("mainDiscountPolicy")
pulbic class FixDiscountPolicy implements DiscountPolicy{}

@Component
@Qualifier("fixDiscountPolicy")
pulbic class RateDiscountPolicy implements DiscountPolicy{}

이렇게 하면 생성자 자동 주입 예시는

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

과 같이 사용 한다.

Primary 사용

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

@Primary, @Qualifier 활용

코드에서 자주 사용하는 메인 데이터베이스의 커텍션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자. 메인 데이터 베이스의 커넥션을 획득하는 스프링 빈은 @Primary를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 데이터베이스 커넥션빈을 획득할 때는 @Qualifier를 지정해서 명시적으로 획득 하는 방식으로 사용 하면 효율적이다.

조회한 빈이 모두 필요할 때

조회한 빈이 여러개일 때 모든 스프링 빈이 필요한 경우에는 List, Map을 사용할 수 있다.

public class AllBeanTest {

    @Test
    void findAllBean(){
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);        
        DiscountService discountService = ac.getBean(DiscountService.class);
        // Map에서 키값이 fixDiscountPolicy인 value를 꺼냄
        DiscountPolicy fixDiscountPolicy = discountService.policyMap.get("fixDiscountPolicy");
        // Map에서 키값이 rateDiscountPolicy value를 꺼냄
        DiscountPolicy rateDiscountPolicy = discountService.policyMap.get("rateDiscountPolicy"); 

    }
    @RequiredArgsConstructor // lombok 라이브러리 사용
    static class DiscountService{
        private final Map<String, DiscountPolicy> policyMap; // 주입될 때 key는 빈 이름, value는 스프링 빈
        private final List<DiscountPolicy> policies;
    }
}
profile
Hyung Jun
Keep Learning👨🏻‍💻
이전 포스트

Spring - Singleton

다음 포스트

Spring - 빈 생명주기 콜백

post-custom-banner

0개의 댓글