Study/Java&Spring

의존관계 자동 주입

kdhoooon 2021. 7. 23. 22:32

의존관계 주입 방법

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

 

 

생성자 주입

  • 이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법
  • 특징
    • 생성자 호출시점에 딱 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라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법
  • 특징
    • 선택, 변경 가능성이 있는 의존관계에 사용
    • 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법
  • <예시 코드> 
    @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;
    }
}​
  • 자바빈 프로퍼티 구약 : 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;
    }
}​

 

 

참고, 스프링 컨테이너가 관리하는 스프링 빈이어야 의존관계 자동주입(@Autowired)은 동작한다.

 

 

 

 

옵션 처리

  • 주입할 스프링 빈이 없어도 동작해야 할 떄가 있다.
  • @Autowired만 사용하면 required 옵션의 기본값이 true로 되어 있어서 자동 주입 대상이 없으면 오류가 발생한다.
  • 이 때, 오션을 이용하여 처리한다.
  • 종류
    1. @Autowired(required = false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출이 안된다.
    2. org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null 이 입력된다.
    3. Option<> : 자동 주입할 대상이 없으면 Optional.empty가 입력된다.
  • <예시 코드> 
    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);
    }

    @Autowired
    public void setNoBean3(Optional<Member> noBean3){
        System.out.println("noBean3 = " + noBean3);
    }
}​
  •  @Nullabel, Optional은 스프링 전반에 걸쳐서 지원된다. 예를 들어서 생성자 자동 주입에서 특정 필드에만 사용해도 된다.

 

 

 

과거에는 수정자 주입과 필드 주입을 많이 사용했지만, 최근에는 스프링을 포함한 DI프레임워크 대부분이 생성자 주입을 권장한다. 그이유는 다음과 같다.

 

1. 불변

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

 

 

2. 누락

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가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만, 지금은 프레임 워크 없이 순수한 자바 코드로만 단위 테스트를 수행하고 있다.

 

3. 생성자 주입을 사용하면 주입데이터를 누락 했을 때 컴파일 오류가 발생한다.

 

4. 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에 값을 설정해야 하는데, 이 부분이 누락되었다. 자바는 컴파일 시점에 다음 오류를 발생시킨다.

5. 롬복과 최신 트랜드

  • 개발을 해보면, 대부분이 다 불변이고, 다음과 같이 생성자에 final 키워드를 사용하게 된다. 그런데 생성자도 만들어야 하고, 주입 받은 값을 대입하는 코드도 만들어야 하기 때문에 롬북을 사용한다.
  • <예시코드> 
    @Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
}​
    @RequiredArgsConstructor를 적는것 만으로도 생성자를 따로 만들지 않아도 생성 된다.
  • plugins {
	id 'org.springframework.boot' version '2.5.3-SNAPSHOT'
	id 'io.spring.dependency-management' version '1.0.11.RELEASE'
	id 'java'
}

group = 'hello'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

//lombok 설정 추가 시작
configurations {
	compileOnly{
		extendsFrom annotationProcessor
	}
}
//lombok 설정 추가 끝

repositories {
	mavenCentral()
	maven { url 'https://repo.spring.io/milestone' }
	maven { url 'https://repo.spring.io/snapshot' }
}

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()
}
    롬복을 사용하기 위해서는 해당 주석친 부분을 gradle.build에 추가한뒤 refresh 해주어야 한다.
  • 인텔리제이에서 사용 순서
    1. Prefrences(윈도우 File -> Settings) -> plugin -> lombok 검색 설치 실행 (재시작)
    2. Prefrences -> Annotation Processors 검색 -> Enable annotation processing 체크(재시작)
    3. 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인

 

 

조회한 빈이 2개이상 인 경우

@Autowired 는 타입(Type)으로 조회한다. 타입으로 조회하기 떄문에, 마치 ac.getBean() 코드와 유사하게 동작한다.

이경우 NoUniqueBeanDefinitionException 오류가 발생한다.

하위 타입으로 지정할 수도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다.

 

해결방법

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

 

 

@Autowired 필드 명 매칭

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

 

<예시>

기존코드

@Autowired
private DiscountPolicy discountPolic

필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy

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

 

 

@Qualifier 사용

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

 

<예시코드>

선언부

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

문자로 찾는 것이기 떄문에 오타와 같은 오류에 취약하다는 단점이 있다.

@Qualifier는 @Qualifier를 찾는 용도로만 사용하는게 명확하고 좋다.

 

 

 

@Primary 사용

우선순위를 정하는 방법

 

<예시코드>

선언부

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}


@Component
public class FixDiscountPolicy implements DiscountPolicy {}

사용코드

//생성자
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
	this.memberRepository = memberRepository;
	this.discountPolicy = discountPolicy;
}
//수정자
@Autowired
public DiscountPolicy setDiscountPolicy(DiscountPolicy discountPolicy) {
	return discountPolicy;
}

 

@Primary, @Qualifier 활용

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

 

 

 

 

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

<예시 코드>

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.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
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.*;

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

        int rateDiscountPrice = discountService.discount(member, 20000, "rateDiscountPolicy");
        assertThat(rateDiscountPrice).isEqualTo(2000);
    }

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

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

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

 

Map<String, DiscountPolicy> : map 의 키에 스프링 빈의 이름을 넣어주고, 그값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.

List<DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.

만약 해당하는 타입의 스프링 빈이 없으면 빈 컬렉션이나 Map을 주입한다.

 

 

마무리.

 

결과적으로 자동기능을 기본으로 사용하는것이 바람직 하다. 하지만 애플리케이션에 광범위하게 영향을 미친 기술 지원 객체는 수동 빈으로 등록해서 설정 정보에 바로 나타나게 하는 것이 유지보수 하기 좋다.

 

'Study > Java&Spring' 카테고리의 다른 글

JPA 정의와 사용  (0) 2021.12.30
Spring MVC  (0) 2021.12.26
컴포넌트 스캔  (0) 2021.07.20
싱글톤 컨테이너  (0) 2021.07.20
XML, BeanDefinition  (0) 2021.07.20

'Study/Java&Spring'의 다른글

  • 현재글의존관계 자동 주입

관련글

댓글

티스토리툴바