[Spring][Kotlin]의존관계 자동 주입

 

다양한 의존관계 주입 방법

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

 

생성자 주입

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

[특징]

• 생성자 호출 시점에 딱 한번만 호출되는 것이 보장 -> 그때 값 세팅하고 그 후 세팅 못하게 막기 가능하다
• 불변, 필수 의존관계에 사용

생성자가 딱 하나 있다면 @Autowired 생략 가능하다.
(스프링 빈인 경우)

@Component
class OrderServiceImpl: OrderService{

	val memberRepository: MemberRepository
    val discountPolicy: DiscountPolicy
    
    @Autowired
    constructor(memberRepository: MemberRepository, discountPolicy: DiscountPolicy){
    
    	this.memberRepository = memberRepository
        this.discountPolicy = discountPolicy
    }


}

수정자 주입

 : 수정자 메서드 setter를 통해 의존관계 주입하는 방법이다.

[특징]

• 선택, 변경 가능성이 있는 의존관계에 사용
• 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법
• 빈 등록과 의존관계 주입이 나뉘어져 있는 경우임
• 값 주입해주면 생성자 주입은 필요없음

@Component
class OrderServiceImpl: OrderService{

	lateinit var memberRepository: MemberRepository
    lateinit var discountPolicy: DiscountPolicy
    
    @Autowired
    fun setMemberRepository(memberRepository: MemberRepository){
    	this.memberRepisotry = memberRepository
    }
	
    @Autowired
    fun setDiscountPolicy(discountPolicy: DiscountPolicy){
    	this.discountPolicy = discountPolicy
    }

}

필드 주입

 : 필드에 바로 주입하는 방법이다.

[특징]

• 코드가 간결하다
• 외부에서 변경이 불가능해 테스트하기 힘들다는 단점이 있다
• DI 프레임워크가 없으면 아무것도 할 수 없다

쓰지 말자.

@Component
class OrderServiceImpl: OrderService{
	
    @Autowired
	lateinit var memberRepository: MemberRepository
    @Autowired
    lateinit var discountPolicy: DiscountPolicy
    
    }

}

 

일반 메서드 주입

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

[특징]

한번에 여러 필드를 주입받을 수 있다

일반적으로 잘 사용하지 않는다.

 

의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다. 스프링 빈이 아닌 클래스에서 Autowired 코드를 적용해도 아무 기능도 동작하지 않는다.

 

옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때가 있다

하지만 @Autowired만 사용하면 required 옵션 default 값이 true이기 때문에 자동 주입 대상이 없으면 오류가 발생할 수 있다.

 

[해결방법]

Autowired(required = false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨

org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력된다

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

 

Optional은 값이 null일수도 있고 아닐수도 있다는 상태를 감싼 것이다.

 

@Nullable, Optional은 스프링 전반에 걸쳐서 지원된다.

 

왜 생성자 주입을 선택해야 하는가?

최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다.

[이유]

1. 불변

• 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료까지 변경할 일이 없다.
• 수정자 주입을 사용하면 setter 메서드들을 public으로 열어두어야 한다.

2. 누락

 : 프레임워크 없이 순수 자바 코드 단위 테스트하는 경우 생성자 주입을 사용하면 필수 값들이 안들어가면 컴파일 오류가 뜨가 때문에 미리 버그를 잡을 수 있다.(@Autowired가 동작하지 않기 때문에)

 

3. final 키워드를 넣을 수 있음

생성자 주입을 사용하면 필드에 final 키워드를 넣을 수 있다.

kotlin에서도 val을 사용할 수 있다.

 

 

[결론]

• 생성자 주입은 프레임워크에 의존하지 않고 순수한 자바 언어의 특징을 잘 살리는 방법이다.
• 기본으로 생성자 주입을 사용하고 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 사용할 수 있다.
• 항상 생성자 주입을 사용하고 옵션이 필요하면 수정자 주입으로, 필드 주입은 사용하지 않는 것이 좋다.

 

조회 빈이 2개 이상인 경우

@Autowired는 타입으로 빈을 조회한다.

따라서 선택된 빈이 2개 이상일 때 문제가 발생한다.

이때의 해결방법을 알아보자

 

@Autowired 필드 명 매칭

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

 

@Qualifier -> @Qualifier 끼리 매칭 -> 빈 이름 매칭

@Qualifier는 추가 구분자를 붙여주는 방법이다.

이것은 빈 이름을 변경하는 것은 아니다.

등록 시 Qualifier 애노테이션 붙이고 생성자 주입에서나 수정자 주입에서 필드 앞에 Qualifier 애노테이션으로 지정하면 된다.

@Component
@Qualifier("mainDiscountPolicy")
class RateDiscountPolicy: DiscountPolicy{...}

@Autowired
constructor(memberRepository: MemberRepository, 
			@Qualifier("mainDiscountPolicy") discountPolicy: DiscountPolicy){
            
	this.memberRepository = memberRepository
    this.discountPolicy = discountPolicy
}

@Qualifier로 주입할 때 해당 Qualifier를 못찾으면 위의 mainDiscountPolicy 처럼 Qualifier안의 문자열과 같은이름의 스프링 빈을 추가로 찾는다.

하지만 Qualifier용도로만 사용하는 게 명확하고 좋다.

 

 

@Primary 사용

이것도 편하고 자주 사용하는 방법이다.

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

 

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

Primary와 Qualifier가 만나면 Qualifier 가 우선권을 갖는다
Qualifier이 더 세세한 설정이기 때문

 

애노테이션 직접 만들기

@Qualifier("xxx") 이렇게 적으면 컴파일 시 문자열로 타입 체크가 안되기 때문에 실수를 모르고 넘어갈 수 있다.

이때 @xxx 과 같은 애노테이션을 만들어서 문제를 해결할 수 있다.

 

package soyang.hellocore.annotation

import org.springframework.beans.factory.annotation.Qualifier
import java.lang.annotation.*
import java.lang.annotation.Retention
import java.lang.annotation.Target

@Target(ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Qualifier("mainDiscountPolicy")
annotation class MainDiscountPolicy()

 

package soyang.hellocore.discount

import org.springframework.stereotype.Component
import soyang.hellocore.annotation.MainDiscountPolicy
import soyang.hellocore.member.Grade
import soyang.hellocore.member.Member

@Component
@MainDiscountPolicy
class RateDiscountPolicy: DiscountPolicy {...}

@Component
class OrderServiceImpl: OrderService {

    val memberRepository: MemberRepository
    val discountPolicy: DiscountPolicy

    @Autowired
    constructor(memberRepository: MemberRepository,
                @MainDiscountPolicy discountPolicy: DiscountPolicy){
        this.memberRepository = memberRepository
        this.discountPolicy = discountPolicy
    }

	...
}

 

애노테이션에는 상속이라는 개념이 없다.
이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다.
Autowired도 재정의 가능하지만 뚜렷한 기능을 무분별하게 재정의하는 것은 유지보수에 혼란을 줄 뿐이다.

 

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

의도적으로 해당 타입의 스프링 빈이 모두 필요한 경우도 있다.

스프링을 사용하면 소위 말하는 전략 패턴을 간단하게 구현할 수 있다.(선택 할 수 있도록)

 

서비스가 모든 Policy를 다 주입받고 어떤 메서드로 string이 내려오면 map에서 string으로 Policy 찾아서 해당 로직을 호출하면 된다.

 

HashMap<String, 빈 타입>으로 빈을 모두 저장한 다음 입력된 spring으로 검색해서 해당 빈을 사용해서 로직 수행하면 된다.

실무에서는 HashMap 대신 ConcurrentHashMap을 써야 Thread-safe 하게 동작할 수 있다.

 

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

편리한 자동 기능을 기본으로 하자

 : 스프링이 나오고 시간이 많이 지나서 Component 뿐만 아니라 Controller, Service, Repository 처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다.

자동 빈 등록을 해도 OCP, DIP 지킬 수 있다. 

 

기술 지원 로직의 경우에는 수동 등록하자

앱은 크게 업무 로직과 기술 지원 로직으로 나뉜다.

업무 로직 빈 : 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등이 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가하거나 변경된다.

기술 지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. DB 연결이나 공통 로그 처리처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

 

업무로직은 숫자도 많고 유사한 패턴이 있으므로 자동 기능을 사용하고

기술지원 로직은 수는 적지만 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미치고 적용이 잘 되고 있는지 여부를 파악하기 어려운 경우가 많으므로 수동 빈 등록을 해서 명확하게 드러내는 것이 좋다.

 

 

 

[출처]

스프링 핵심 원리 - 기본편

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

스프링 핵심 원리 - 기본편 - 인프런 | 강의