[Spring] 의존관계 자동 주입 1) 의존 주입 방법

 

 

목차

• 의존관계 자동 주입 - 다양한 의존관계 주입 방법
• 의존관계 자동 주입 - 옵션 처리
• 의존관계 자동 주입 - 생성자 주입을 선택해라!
• 의존관계 자동 주입 - 롬복과 최신 트랜드 (생성자 주입을 편리하게 사용하기)
• 의존관계자동주입- 조회빈이2개이상-문제
• 의존관계 자동 주입 - @Autowired 필드 명, @Qualifier, @Primary
• 의존관계 자동 주입 - 애노테이션 직접 만들기
• 의존관계 자동 주입 - 조회한 빈이 모두 필요할 때, List, Map
• 의존관계 자동 주입 - 자동, 수동의 올바른 실무 운영 기준

 

 

 

다양한 의존관계 주입 방법 

 

 

의존관계 주입 방법

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

 

 

생성자 주입 

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

 

특징

• 생성자 호출시점에 딱 1번만 호출되는 것이 보장된다. →그 이후로는 변경이 불가능하게 막을 수 있음
• "불변", "필수" 의존관계에 사용된다 

 

*불변이어야 하는 경우에는 생성자에서만 값을 최초로 설정하고, setter등을 만들어두지 말고 변경이 불가능하게 한다(중요)

 

(지금까지 사용했던 방법) 

OrderServiceImpl

@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository; //private final:값이 필수로 있어야함 -> 생성자에서 대입해주지 않으면 컴파일 에러
    private final DisountPolicy disountPolicy; 
    
    @Autowired// 자동으로 의존관계(MemberRepo , discountpolicy)를 주입해줌
    public OrderServiceImpl(MemberRepository memberRepository, DisountPolicy disountPolicy){
        this.disountPolicy =disountPolicy; //값을 채워 넣음
        this.memberRepository=memberRepository; // 값을 채워 넣음
    }

OrderServiceImpl 생성자에 @Autowired를 붙인 경우이다.

@Component 를 이용해 컴포넌트 스캔시 스프링 컨테이너에 "OrderServiceImpl"을 등록하는데, 

등록 시 생성자를 호출한다. 이때, 생성자에 @Autowired가 있으면, 스프링 컨테이너에서 "OrderServiceImpl"이 의존하고 있는 memberRepository, discountPolicy를 주입해준다. (스프링 빈 등록과 함께 의존관계 주입이 발생한다)

 

참고: 스프링 빈 인데, 생성자가 1개만 있으면, @Autowired를 생략해도 된다.

 

 

 

 

수정자 주입(setter 주입)

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

 

특징

"선택(필수가 아닌)", "변경" 가능성이 있는 의존관계에 사용

 

@Component
    public class OrderServiceImpl implements OrderService {
    
    //변경 가능해야하므로 final x
        private MemberRepository memberRepository;
        private DiscountPolicy discountPolicy;
        
        
        @Autowired(required=false)//필수가 아닌경우
        public void setMemberRepository(MemberRepository memberRepository) {
            this.memberRepository = memberRepository;
        }
        
        
        @Autowired
        public void setDiscountPolicy(DiscountPolicy discountPolicy) {
            this.discountPolicy = discountPolicy;
        }
}

@Autowired는 주입할 대상이 없으면 오류가 발생, 주입할 대상이 없어도 동작하게 하려면 (required = false)필요

 

*자바의 규약으로 필드값은 직접 수정하지 않고, setter, getter를 이용해서 변경해야한다.

 

 

 

필드 주입

필드에 바로 주입하는 방법 (잘 사용되지 않음, 치명적 단점 존재) 

 

특징

• 외부에서 변경이 불가능하여, 테스트 하기 힘들다는 치명적 단점이 있다. 
  • 테스트 할 때, 의존관계에 있는 객체를 변경하기 어렵다
• DI프레임워크가 없으면 아무것도 할 수 없다.
• 애플리케이션의 실제 코드와 관계 없는 테스트 코드, 스프링 설정 목적으로 하는 @Configuration을 제외하고 사용X인 편이 좋다.

 

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

 

 

 

일반 메소드 주입

일반 메소드를 통해 주입 받을 수 있다.

 

특징

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

 

@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 코드를 적용해도 아무 기능도 작동하지 않는다.(예, Member)

 

 

 

 

 

옵션 처리

 

주입할 스프링 빈이 없어도 동작하게 하는 방법

없어도 default로 무언가 다른것이 실행되어야 하는경우가 있다. 

* @Autowired만 사용하면, required 가 true로 되어있어, 주입할 대상이 없으면 오류가 발생한다.(동작x)

 

방법에는 3가지가 있다.

• @Autowired(required = false)
  • 자동 주입할 대상이 없으면 메소드가 호출되지 않는다.
• @Nullable
  • 자동 주입할 대상이 없으면 null이 입력된다.
• Optional<>
  • 자동주입할 대상이 없으면 Optional.empty가 입력된다.

 

주입할 스프링 빈이 없는 테스트상황을 구현하기 위해 다음과 같이 패키지와 자바 클래스를 생성해준다.

스프링 빈이 아닌 일반 클래스를 주입하여, 자동 주입할 대상이 없게 만들기 위해서 Member클래스를 주입하여 실행해본다.

 

AutowiredTest

package hello.core.autowired;

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 org.springframework.lang.Nullable;

import java.util.Optional;

public class AutowiredTest {

    @Test
    void AutowiredOption(){
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);//스프링 빈으로 등록
    }



    static class TestBean{

        @Autowired(required = false) //의존 관계가 없다면 메소드를 호출하지 않는다.
        public void setNoBean1(Member noBean1){
            System.out.println("noBean1 = " + noBean1);
        }

        @Autowired
        public void setNoBean2(@Nullable Member noBean2){
            System.out.println("noBean2 = " + noBean2);//호출되지만 null로
        }

        @Autowired
        public void setNoBean3(Optional<Member> noBean3){
            System.out.println("noBean3 = " + noBean3);//스프링 빈이 없으면 Optional.empty로 값이 들어감
        }


    }

}

 

결과

결과는 다음과 같이 setNoBean1메소드는 호출되지 않았다.

 

 참고: @Nullable, Optional은 스프링 전반에 걸쳐서 지원된다. 예를 들어서 생성자 자동 주입에서 특정 필드에만 사용해도 된다. (매개변수 여러개 중 한개에만 적용해도된다는 의미)

 

 

생성자 주입 권장

과거에는 수정자, 필드 주입을 사용했지만, 최근에는 생성자 주입을 권장한다.

 

이유

 

불변

대부분의 의존관계 주입은 1번만 일어나면 애플리케이션 종료시까지 의존관계를 변경할 일이 없다.

(사실, 대부분의 의존관계는 애플리케이션 종료시까지 불변해야한다.)

 

수정자 주입을 사용하는 경우 setXXX method를 public으로 두어야 하고, 이를 누군가가 변경할 수 있다.

변경하면 안되는 메소드를 public으로 두는 것 또한 좋은 설계방식이 아니다.

 

생성자 주입은 생성시 1번만 호출되므로, 호출이후에 사용되는 일이 없어 불변을 지킬 수 있다.

 

 

 

누락

프레임워크 없이 순수한 자바 코드를 단위 테스트하는 경우 (DB, 스프링이 엮이지 않고, 순수 클래스만 테스트 하려는 경우 → 매우 많음)

 

수정자 주입을 사용하는 경우)

OrderServiceImpl을 수정자 주입으로 구현한 후, 자바 코드 단위 테스트를 작성해보자.

 

OrderServiceImpl

@Component
public class OrderServiceImpl implements OrderService{

//3. 스프링 컨테이너 사용(의존관계 주입 - setter주입) 
    private MemberRepository memberRepository;
    private DisountPolicy disountPolicy;

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

    @Autowired
    public void setDiscountPolicy(DisountPolicy disountPolicy){
        this.disountPolicy = disountPolicy;
    }

 

OrderServiceImplTest

package hello.core.order;

import org.junit.jupiter.api.Test;

public class OrderServiceImplTest {

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


}

 

다음과 같이 에러가 발생한다.

이는 수정자 주입 방법이 프로그래머에게 해당 클래스가 어디에 의존하고 있는지 직관적으로 알기 어려워,

의존 주입을 누락시켜 테스트코드를 작성했기 때문이다.

수정자 주입에서는 이러한 누락이 자주 발생한다.

 

생성자 주입을 사용하는 경우)

OrderServiceImplTest

package hello.core.order;

import org.junit.jupiter.api.Test;

public class OrderServiceImplTest {

     @Test
    void createOrder(){
         OrderServiceImpl orderService = new OrderServiceImpl();
         orderService.creatOrder(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 키워드를 사용할 수 있다.

 

 

정리

• 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법
• 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다. 
  • 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.
• 항상 생성자 주입을 선택해라! 그리고 가끔 옵션이 필요하면 수정자 주입을 선택해라. 필드 주입은 사용하지 않는게 좋다.

 

 

 

 

롬복 

 

실제 개발에서는 대부분 "불변"이다.

따라서 생성자에 final키워드를 주로 사용한다.

그런데, 생성자 제작, 매개변수로 의존관계 주입 + 내부에 주입 받은 값 대입  등등 너무 많다.

이것을 줄일 수 있는 방법

 

 

1. 생성자가 하나뿐이면 생략가능 

생성자가 하나 뿐일 경우 @Autowired를 생략할 수 있다. 

 

2. 롬복 라이브러리

 

라이브러리 추가

build.gradle에 롬복라이브러리를 추가한다.

build.gradle

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
	
	//lombok 라이브러리 추가 시작
	compileOnly 'org.projectlombok:lombok'
	annotationProcessor 'org.projectlombok:lombok'
	testCompileOnly 'org.projectlombok:lombok'
	testAnnotationProcessor 'org.projectlombok:lombok'
	//lombok 라이브러리 추가 끝

}

(추가 시 꼭 refresh 해주어야 한다.)

라이브러리에 lombok이 들어왔음을 확인 가능 

 

 

PlugIn추가

Preference > Plugins > Lombok 

 

 

Preference > Annotation Processors

 

 

@Getter @Setter

다음 annotation(lombok라이브러리)를 사용하면, get필드명 , set필드명의 getter setter를 따로 선언해두지 않아도, 사용가능하다.

 

테스트를 위해 hello.core하위에 HelloLombok 클래스를 생성한다. 

 

HelloLombok

package hello.core;


import lombok.Getter;
import lombok.Setter;

//getter setter를 자동으로 만들어
@Getter
@Setter
public class HelloLombok {

    private String name;
    private int age;

    public static void main(String[] args) {
        HelloLombok helloLombok = new HelloLombok();
        helloLombok.setName("yjlee");

        String name = helloLombok.getName();
        System.out.println("name = " + name);
    }



}

다음과 같이 getter/setter를 따로 선언하지 않았음에도, 사용이 가능하며 에러도 나지 않는다.

물론 생성자, ToString 등등도 annotation으로 지원한다.(java lombok 검색해서 더 알아보기 추천) 

 

 

@RequiredArgsConstructor

값이 필수로 요구되는 final 제어자가 붙은 필드들을 이용하여 생성자를 만들어준다.  (코드에는 보이지 않지만 호출 가능)

@Component
@RequiredArgsConstructor//final이 붙은 필드값을 사용하는 생성자를 자동 생성
public class OrderServiceImpl implements OrderService{

//2. 스프링 컨테이너 사용 (문제점해결 / 의존관계 주입 - 생성자 주입방법)
    private final MemberRepository memberRepository;// -> 오직 인터페이스만 존재 (추상화에만 의존함 DIP)
    private final DisountPolicy disountPolicy; //인터페이스 (추상)에만 의존함 (DIP)


//생성자 부분을 주석처리해도 된다 
//    @Autowired// 자동으로 의존관계(MemberRepo , discountpolicy)를 주입해줌
//    public OrderServiceImpl(MemberRepository memberRepository, DisountPolicy disountPolicy){
//        this.disountPolicy =disountPolicy;
//        this.memberRepository=memberRepository;
//    }

다음과 같이 사용할 수 있다. (주석해제 하고, RequiredArgsConstructor을 제거한 버전과 같다)

의존관계 추가 시 (private final ~~~만 추가하면됨 ) 아주 편리하다.

이 최종결과 코드와 이전의 코드는 완전히 동일하다. 
롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해준다. 
실제 class 를 열어보면 다음 코드(생성자)가 추가되어 있는 것을 확인할 수 있다.

 

 

 

정리 

최근에는 생성자를 딱 1개 두고, @Autowired 를 생략하는 방법 사용

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