📚 1. 다양한 의존관계 주입 방법
1. 생성자 주입
생성자를 통해 의존관계를 자동 주입받는 방식으로 생성자 호출시점에 딱 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;
}
}- DI된 스프링 빈들이 final 키워드를 붙혀 필수 값인 경우 생성자 주입을 통해 의존관계주입한다.
- 생성자가 하나인 경우
@Autowired어노테이션이 없어도 된다. (생략 가능, 자동으로 추가됨)
2. 수정자 주입(Setter 주입)
Setter를 통해 필드의 값을 수정할 수 있는데 (자바 관례인 getter/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애노테이션을 부여해서 의존관계를 주입 한다. - 애노테이션이 부여되지 않으면 NULL 상태이다.
- 스프링 컨테이너의 생성과정에서 스프링 빈 등록 이후 스프링 빈 의존관계 설정 준비단계에서 설정하는 단계와 동일하다.
참고 : 생성자 주입은 스프링 빈에서 해당 클래스를 생성하는 시점에서 생성자를 호출할 수 밖에 없는데 해당 생성자에 파라미터를 전달하기 위해서는 의존관계를 주입해야 한다.
@Autowired의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게 하려면@Autowired(required = false)로 지정하면 된다.
자바빈 프로퍼티 규약 : 필드의 값을 직접 변경하지 않고, setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는 규칙
3. 필드 주입
필드에 바로 주입하는 방식
@Component
public class OrderServiceImpl implements OrderService{
@Autowired private MemberRepository memberRepository;
@Autowired private DiscountPolicy discountPolicy;
}
- 접근제어자가
private여도 문제없이 의존관계 주입이 된다. - 사용시 간결해서 좋지만, 외부에서 변경 및 테스트 하기 어렵다는 단점이 있다.
- DI 프레임워크가 없으면 아무것도 할 수 없다.
- 고립테스트를 할 때 해당 어노테이션이 있으면 할 수가 없다.
- 테스트 코드, 특수할 때만 사용하며, 가급적 사용하지 않는 것을 권장한다.
외부에서 변경 및 테스트가 어려운 이유
테스트를 위해 테스트 클래스를 만들어 해당 스프링 빈들(memberRepository,discountPolicy)FakeObject를 만들어 고립테스트를 하고싶을 때@Autowired어노테이션이 있으면 몹시 번거로워진다. 스프링 빈 등록시점에서FakeObject를 주입할 수 없고 그렇기에 따로 setter를 만들어 주입해야 한다. setter가 만들어지면 수정자 주입을 하면 된다. 즉, DI 프레임워크가 없으면 사용할 수 없다는 의미이다.
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;
}
}
참고 : 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다.
스프링 빈으로 등록되지 않은 클래스(Member와 같은Domain)에서는 주입받을 수 없다.
📚 2. 옵션 처리
지금까지 기본적으로 스프링 빈이 없을 때, 오류가 발생했다.
하지만, 주입할 빈이 없어도 동작해야할 때도 있다. 이를 해결하기 위해서 옵션처리를 해줘야 한다.
자동 주입 대상을 옵션으로 처리하는 방법
(1)
@Autowired(required=false)
자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 되지 않는다.
(2)org.springframework.lang.@Nullable
자동 주입할 대상이 없으면null이 입력된다.
(3)Optional<>
자동 주입할 대상이 없으면Optional.empty가 입력된다.
test/../hello.core/autowired/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);
}
//null 호출
@Autowired
public void setNoBean2(@Nullable Member noBean2){
System.out.println("noBean2 = " + noBean2);
}
//Optional.empty 호출
@Autowired
public void setNoBean3(Optional<Member> noBean3){
System.out.println("noBean3 = " + noBean3);
}
}
}
실행 결과
Member는 등록된 스프링 빈이 아니기 때문에 찾을 수 없다.
setNoBean1():@Autowired(required=false)속성으로 설정되어 있기 때문에 메서드가 호출 되지 않는다.setNoBean2(): 해당 빈을 찾을 수는 없지만,@Nullable애노테이션이 있기에 NULL을 주입한다.setNoBean3(): Optional 파라미터이므로Optional.empty를 주입한다.
참고
@Nullable,Optional은 스프링 전반에 걸쳐서 지원된다.
예를 들어, 생성자 자동 주입에서 특정 필드에만 사용해도 된다.오류가(Error) 발생했을 때,
오류 메시지 읽는 것도 좋고, 오류 중에 파란색 색칠된 곳을 확인한다.
파란색칠된 곳이 없다면, 다 검정색일 때 스프링 뛰울 때 오류가 발생한 것이다.
오류를 읽어본다.
📚 3. 생성자 주입을 선택하라
이전까지, 많은 의존관계 주입방법에 대해 알아보았다. 지금까지 배운 많은 방법 중 무엇을 써야 할까?
최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다.
그이유는 무엇일까?
(1) 불변
- 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. (애플리케이션 종료 전까지 변하면 안된다.)
- 수정자 주입을 사용할 경우, setter(setXxx) 메서드를 public으로 열어야함으로 변경 가능성이 생긴다.
- 객체 생성시점에서 최초 1회 생성자가 반드시 호출되며 이 상황에서 의존관계까지 주입하기에 불변 설계가 가능하다.
(2) 누락
프레임워크에 의존하지 않고 순수 자바로 고립 테스트를 하는 경우(수정자 의존관계 혹은 필드 의존관계) @Autowired 애노테이션이 스프링 프레임워크 내에서는 문제가 있을 경우 오류를 발생한다.
순수 JAVA로 작성할 경우 실행은 되지만, NullPointException이 발생한다.
수정자 의존관계
java/hello.core/order/OrderServiceImpl.java
@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 가 프레임워크 안에서 동작할 때는 의존관계가 없으면, 오류가 발생하지만, 지금은 프레임워크 없이 순수한 자바 코드로만 단위 테스트를 수행하고 있다.
test/../hello.core/order/OrderServiceImplTest.java
package hello.core.order;
import org.junit.jupiter.api.Test;
public class OrderServiceImplTest {
@Test
void createOrder() {
OrderServiceImpl orderService = new OrderServiceImpl();
orderService.createOrder(1L, "itemA", 10000);
}
}
실행 결과
실행하면 NPE (Null Point Exception)이 발생한다.
이유는 memberRepository , discountPolicy 모두 의존관계 주입이 누락되었기 때문이다.
해당 에러를 해결하기 위해서는 테스트코드 OrderServiceImpTest에 직접 의존관계를 다음과 같이 주입해줘야 한다.
package hello.core.order;
import hello.core.discount.FixDiscountPolicy;
import hello.core.member.Grade;
import hello.core.member.Member;
import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
public class OrderServiceImplTest {
@Test
void createOrder() {
MemberRepository memberRepository = new MemoryMemberRepository();
memberRepository.save(new Member(1L, "catsbi", Grade.VIP));
OrderServiceImpl orderService = new OrderServiceImpl();
orderService.setMemberRepository(memberRepository);
orderService.setDiscountPolicy(new FixDiscountPolicy());
Order order = orderService.createOrder(1L, "itemA", 10000);
assertThat(order.getDiscountPrice()).isEqualTo(1000);
}
}
실행 결과
정상적으로 동작한다. 하지만, 이런 테스트 코드를 다시 작성하기 위해서는 주문서비스에 필요한 의존관계와 관련된 다른 의존관계까지 다알아야 한다.
생성자가 아닌 수정자이기 때문에 직접 코드를 다 살펴보기전까지 무슨 의존관계가 필요한지 알 수 없다.
final 키워드
final키워드를 사용시 모든 주입이 생성자 호출시점에 이뤄지며 무조건 의존관계가 주입되도록 할 수 있다.
필수 필드인
discountPolicy에 값을 설정해야 하는데, 이 부분이 누락되어있다.JAVA는 컴파일 시점에
java: variable discountPolicy might not have been initialized오류를 발생시킨다.
컴파일 오류는 세상에서 가장 빠르고, 좋은 오류이다.
참고 : 수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에
final키워드를 사용할 수 없다.
오직 생성자 주입 방식만final키워드를 사용할 수 있다.
💡 정리
- 생성자 주입 방식을 선택하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이기도 하다.
- 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다.
- 항상 생성자 주입을 선택하자, 옵션이 필요할 때 수정자 주입을 선택하자❗️
- 필드 주입은 사용하지 않는게 좋다.
📚 4. 룸북과 최신 트렌드
의존관계주입을 일반적으로 생성자 주입 방식을 사용하기로 결정했다.
그럼 이제 매번 필요한 부분에 대해 생성자를 만들어주고, 주입받은 값을 대입도 해주어야 한다.
이러한 번거러운 작업을 롬복Lombok라이브러리를 사용해서 어노테이션으로 해결할 수 있다.
1. 롬복 설정
프로젝트 최초 구성시 의존성 설정에서 롬복을 설정했다면 자동으로 설정되어있으니 바로 사용하면 된다.
build.gradle설정
plugins {
id 'org.springframework.boot' version '2.6.1'
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()
}
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'
}
test {
useJUnitPlatform()
}
- Preferences ➡️ plugin
-
Preerences ➡️ Annotatio Processors 검색 ➡️ Enable annotation processing 체크
-
임의의 테스트 클래스를 만들고
@Getter,@Setter확인
-
@RequiredArgsConstructor사용
package hello.core.order;
import hello.core.discount.DiscountPolicy;
import hello.core.member.Member;
import hello.core.member.MemberRepository;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{
// 멤버 레포지토에서 회원을 찾기 위함
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
}
@RequiredArgsConstructor:final키워드가 붙은 필드를 모아서 생성자를 자동으로 만들어준다.@RequiredArgsConstructor를 열어보면 다음과 같은 코드가 추가되어있다.
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy
discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
💡 정리
- 생성자를 1개 둘 때는,
@Autowired를 생략하는 방법을 주로 사용한다.- 여기애
Lombok라이브러리의@RequiredArgsConstructor함께 사용하면 기능은 다 제공하면서, 코드는 깔끔하게 사용할 수 있다.
📚 4. 조회 빈이 2개 이상 - 문제
의존관계를 자동주입하는 방법에서 자동, 수동 그리고 롬복을 이용한 방법까지 알아보았다.
이런 자동주입에서 주의할 점이 있다.
같은 타입의 빈이 둘 이상 등록될 경우 문제가 생길 수 있는데, 이를 @Autowired 애노테이션은 빈을 타입( type)으로 조회한다.
이는 이전에 쓰던 ac.getBean(xxxx.class)와 유사하다.
스프링 빈 조회할 때 발생했던 문제와 동일하게 타입으로 조회시 선택된 빈이 둘 이상이면 문제가 발생한다.
예제 프로젝트에서 할인 정책(DiscountPolicy)의 구현체인 FixDiscountPolicy, RateDiscountPolicy 가 둘 다 스프링 빈으로 등록할 경우 해당 문제를 만날 수 있다.
/**FixDiscountPolicy.class**/
@Component
public class FixDiscountPolicy implements DiscountPolicy{
...
}
/**RateDiscountPolicy.class**/
@Component
public class RateDiscountPolicy implements DiscountPolicy{
...
}
public class AutoAppConfigTest {
@Autowired
private DiscountPolicy discountPolicy;
...
}
위와 같이 각 할인정책을 모두 스프링 빈으로 등록한 후 @Autowired 로 자동주입을 받으려고 시도하면 다음과 같은 결과가 나온다.
실행 결과
No qualifying bean of type 'hello.core.discount.DiscountPolicy' available: expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy
해석시, fixDiscountPolicy , rateDiscountPolicy 두 개의 빈이 발견되었다는 에러이다.
하지만, 매번 사용할 하나의 정책만 스프링 빈으로 등록해서 사용하는 것은 안된다.
해결 방안
@Autowired 가 부여된 필드의 이름, @Qualifier 애노테이션, @Primary 애노테이션을 사용해 해결할 수 있다.
📚 5. @Autowired 필드명, @Qualifier, @Primary
No qualifying bean of type 'hello.core.discount.DiscountPolicy' available: expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy
위와 같은 오류 해결방안을 찾아보자!
💡조회 대상 빈이 2개 이상일 때 해결 방법
@Autowired필드명 매칭@Qualifier➡️@Qualifier끼리 매칭 ➡️ 빈 이름 매칭@Primary사용하기
(1) @Autowired 필드명
@Autowired 애노테이션은 의존관계 자동주입 타입 매칭을 통해 주입한다.
이때 빈이 여러 개가 검색된다면 필드명으로 빈 이름, 파라미터 이름으로 추가 매칭한다.
즉, 할인정책(DiscountPolicy) 타입으로 스프링 빈을 검색하였을 때 fixDiscountPolicy, rateDiscountPolicy 두 개의 빈이 검색된다면 다음으로 필드명으로 빈을 추가적으로 매칭한다.
기존 코드
@Component
public class OrderServiceImpl implements OrderService{
// 멤버 레포지토에서 회원을 찾기 위함
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) { // discountPolicy -> rateDiscountPolicy
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}
필드 명을 빈 이름으로 변경
@Component
public class OrderServiceImpl implements OrderService{
// 멤버 레포지토에서 회원을 찾기 위함
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy rateDiscountPolicy) { // discountPolicy -> rateDiscountPolicy
this.memberRepository = memberRepository;
this.discountPolicy = rateDiscountPolicy;
}
}실행 결과
필드 명이 rateDiscountPolicy 이므로 정상 주입된다.
필드 명 매칭은 먼저 타입 매칭을 시도하고 그 결과에 여러 빈이 있을 때 추가로 동작하는 기능이다.
정리
@Autowired매칭은 우선, 타입으로 매칭을 시도하고 매칭결과가 2개 이상일 경우 빈 이름으로 매칭을 시도한다.
(2) @Qualifier
@Qualifier 는 추가 구분자를 붙여주는 방법이다.
추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것이 아니다.
빈 등록시 @Qualifier를 붙여준다.
(1) FixDiscountPolicy
@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {
...
}
(2) RateDiscountPolicy
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {
...
}
주입시에 @Qualifier를 붙여주고 등록한 이름을 적어준다.
생성자 자동 주입 예시
@Component
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}
수정자 자동 주입 예시
@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
return discountPolicy;
}
- 생성자 자동 주입 예시를 참고하며,
OrderServiceImpl빈에 의존관계 주입을 할 때 할인 정책은Qualifier로 등록된 이름을 통해 매칭한다. - 필드뿐아니라 생성자 및 수정자에도 파라미터에 해당 애노테이션을 부여해서 매칭할 수 있다.
Componet뿐 아니라@Bean을 직접 등록하는 경우에도 동일하게 사용 가능하다.@Qualifier로 주입할 때@Qualifier("mainDiscountPolicy)"를 찾지 못할시, mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.- 매칭되는 빈을 찾지 못한다면
NoSuchBeanDefinitionException예외가 발생한다. @Qualifier는@Qualifier를 찾는 용도로만 사용하는 것이 명확하고 좋다.- 해당 기능을 사용자 애노테이션으로 만들어 더 편리하게 관리할 수 있다. (이 방법은 다음 섹션에서 학습한다.)
(3) @Primary
애노테이션의 이름 뜻 그대로 우선순위를 정하는 방법이다.
@Autowired를 통해 여러 빈이 매칭될 경우 @Primary 애노테이션을 가지고 있는 빈이 우선권을 가지게 된다.
(1) FixDiscountPolicy.class
@Component
public class FixDiscountPolicy implements DiscountPolicy{
...
}
(2) RateDiscountPolicy.class
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy{
...
}
사용코드
(1) 생성자
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy){
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}
(2) 수정자
@Autowired
public DiscountPolicy setDiscountPolicy(DiscountPolicy discountPolicy) {
return discountPolicy;
}
이렇게 @Primary 애노테이션이 붙으면 테스트 클래스에서 DiscountPolicy 타입으로 빈을 조회할 때 검색되는 FixDiscountPolicy, RateDiscountPolicy 두 개의 빈중 @Primary 애노테이션을 가지고있는 RateDiscountPolicy 가 우선권을 가지게 되어 해당 빈이 자동주입 된다.
@Primary 는 @Qualifier 와는 다르게 양쪽에 애노테이션을 붙여주지 않아도 된다는 점에서 장점을 가지고 있다.
**
@Primary, @Qualifier 활용
코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자.
메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary 를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier 를 지정해서 명시적으로 획득 하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.
물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 @Qualifier 를 지정해주는 것은 상관없다.
우선순위
@Primary는 기본값처럼 동작한다.
@Qualifier는 매우 상세하게 동작한다.
스프링은 자동보다는 수동이, 넓은 범위의 선택권 보다는 좁은 범위의 선택권이 우선순위가 높다.
따라서,Qualifier가 우선권이 높다.
📚 6. 애노테이션 직접 만들기
@Qualifier 애노테이션의 이름을 부여하여 매칭을 하는데 이 이름은 문자열이기에 컴파일시 타입 체크가 안된다.
예시로, 한쪽에서는 @Qualifier("myService)" 다른 한쪽에서는 @Qualifier("mySrvice)" 이런식으로 실수를 할 수 있다는 것이다.
그래서 이런 경우 다음과 같은 애노테이션을 만들어서 문제를 해결할 수 있다.
(1) 애노테이션 정의
package hello.core.annotation;
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)
@Inherited
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}
- 이 애노테이션은 필드, 메서드, 파라미터, 타입, 애노테이션 타입에 전부 사용 가능하다.
- 런타임시에 동작한다.
- 상속이 된다.
@Qualifier동작을 한다.
(2) 적용하기
@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}
(1) 생성자 자동 주입
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @MainDiscountPolicy DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
(2) 수정자 자동 주입
@Autowired
public DiscountPolicy setDiscountPolicy(@MainDiscountPolicy DiscountPolicy discountPolicy){
return discountPolicy;
}
- 애노테이션에는 상속이라는 개념이 없다.
- 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다.
@Qulifier뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다.@Autowired도 재정의 할 수 있다.- 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의는 하지 말자❗️
📚 7. 조회한 빈이 모두 필요할 때, List, Map
지금까지는 자동주입하기위해 스프링 빈 검색해서 2개 이상 나오는 경우 하나를 어떻게 골라서 주입할지에 대해 알아보았다.
하지만, 반대로 2개 이상 나올 경우 모두 스프링 빈을 조회해야하는 경우도 있다.
ex) 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(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.assertj.core.api.Assertions;
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.*;
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;
@Autowired
DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies) {
this.policyMap = policyMap;
this.policies = policies;
System.out.println("policyMap = " + policyMap);
System.out.println("policyMap = " + policies);
}
public int discount(Member member, int price, String discountCode) {
DiscountPolicy discountPolicy = policyMap.get(discountCode);
return discountPolicy.discount(member, price);
}
}
}
실행 결과
로직 분석
DiscountService에서는 생성자가 Map, List 타입이니 해당 콜렉션의 지네릭 타입에 매칭 되는 모든 빈, 모든DiscountPolicy를 주입받는다.fixDiscountPolicy,rateDiscountPolicy가 주입된다.discount()메서드는discountCode로 "fixDiscountPolicy" 가 넘어오면 map에서fixDiscountPolicy스프링 빈을 찾아서 실행한다. 물론 "rateDiscountPolicy" 가 넘어오면rateDiscountPolicy스프링 빈을 찾아서 실행한다.
주입 분석
Map<String, DiscountPolcy>: map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로DiscountPolicy타입으로 조회한 모든 스프링 빈을 담아준다.List<DiscountPolicy>:DiscountPolicy타입으로 조회한 모든 스프링 빈을 담아준다.
만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.
참고 - 스프링 컨테이너를 생성하면서 스프링 빈 등록하기
스프링 컨테이너는 생성자에 클래스 정보를 받는다. 여기에 클래스 정보를 넘기면 해당 클래스가 스프링 빈으로 자동 등록된다.
new AnnotationConfigApplicationContext(AutoAppConfig.class,DiscountService.class);
이 코드는 2가지로 나누어 이해할 수 있다.
new AnnotationConfigApplicationContext()를 통해 스프링 컨테이너를 생성한다.AutoAppConfig.class,DiscountService.class를 파라미터로 넘기면서 해당 클래스를 자동으로 스프링 빈으로 등록한다.정리
스프링 컨테이너를 생성하면서, 해당 컨테이너에 동시에AutoAppConfig,DiscountService를 스프링 빈으로 자동 등록한다.
📚 8. 자동, 수동의 올바른 실무 운영 기준
스프링 빈을 등록하는 2가지 방법(자동/수동)
- 자동 :
@Component Scan+ '@Component'- 수동 :
Appconfig파일 +@Bean/<bean>
자동기능을 기본으로 사용하자❗
스프링 프로젝트 생성시 자동생성되는 루트 클래스 @SpringBootApplication 애노테이션이 있는데, 이 안에 컴포넌트 스캔을 기본으로 사용하고 @Controtller, @Service, @Repository 처럼 계층별로 맞는 애플리케이션 로직을 자동으로 스캔할 수 있다.
최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.
@Component 면 자동으로 스프링 빈으로 등록되는 상황에서 직접 @Configuartion 설정 정보에 가서 빈을 직접 생성해서 객처를 생성 후 의존관계 주입까지 다 수동으로 하는 것은 (주입할 대상을 일일이 적어주는 과정은) 상당히 번거롭다.
또한, 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것은 부담이 된다.
결정적으로 자동 빈 등록을 사용해도 OCP, DIP 원칙을 지킬 수 있다.
수동 빈 등록을 사용하는 시점
애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.
(1) 업무 로직 빈
- 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리등 모두 업무 로직이다.
- 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
(2) 기술 지원 빈
- 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다.
- 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 고통 기술들이다.
(3) 업무 로직 빈 vs 기술 지원 빈
(3-1) 업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있다.
(3-1) 이런 경우 자동 기능을 적극 사용하는 것이 좋다.
(3-1) 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악히기 쉽다.
(3-2) 기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다.
(3-2) 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 들어나지만, 기술 지원 로직은 적용이 잘 되고 있는지 조차 파악하기 어려운 경우가 많다.
(3-2) 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 들어내는 것이 좋다.
애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 설정 정보에 바로 나타나게 하는 것이 유지보수 하기 좋다.
비즈니스 로직 중에서 다향성을 적극 활용할 때
의존관계 자동 주입 - 조회한 빈이 모두 필요할 때, 이전 공부 내용 List, Map을 보면 DiscountService 가 의존관계 자동 주입으로 Map<String, DiscountPolicy> 에 주입을 받는 상황을 생각해보자!
다른 개발자가 개발해서 나에게 준 소스라면, 어떤 빈들이 주입될지, 각 빈들의 이름은 무엇일지 코드만 보고 쉽게 파악하기 어렵다.
자동 등록을 사용하기 있기에, 파악하기 위해서는 여러 코드를 찾아봐야 한다.
이런 경우 수동 빈으로 등록하거나 또는 자동으로 한다면 특정 패키지에 같이 묶어 두는 것이 좋다! (쉽게 이해할 수 있게)
자동으로 할 경우 특정 패키지에 묶어서 한 곳에 모아 둔다.
수동으로 할 경우, 별도의 설정 정보를 만들고 수동으로 등록한다.
이 설정 정보만 봐도 한 눈에 빈의 이름은 물론이고, 어떤 빈들이 주입될지 파악할 수 있다.
@Configuration
public class DiscountPolicyConfig {
@Bean
public DiscountPolicy rateDiscountPolicy(){
return new RateDiscountPolicy();
}
@Bean
public DiscountPolicy fixDiscountPolicy(){
return new FixDiscountPolicy();
}
}
참고
- 스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 예외이다.
- 이런 부분들은 스프링 자체를 잘 이해하고 스프링의 의도대로 잘 사용하는 게 중요하다!
- 스프링 부트의 경우
DataSource같은 데이터베이스 연결에 사용하는 기술 지원 로직까지 내부에서 자동으로 등록한다. (이런 부분은 메뉴얼을 잘 참고해서 스프링 부트가 의도한 대로 편리하게 사용하면 된다.)- 스프링 부트가 아니라, 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 들어내는 것이 좋다.
정리
- 편리한 자동 기능을 기본으로 사용하자!
- 직접 등록하는 기술 지원 객체는 수동 등록하자!
- 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민하자!
참고
