[Spring] 의존관계 자동 주입

Spring에는 다양한 DI 방법이 존재합니다. 이번 시간에는 의존 관계를 자동으로 주입시켜주는 방법에 대해 학습해보겠습니다.

다양한 의존관계 주입 방법

의존관계 주입에는 크게 4가지 방법이 존재합니다.

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

생성자 주입

• 생성자를 통해서 의존 관계를 주입 받는 방법이며, 지금까지 진행했던 방법입니다.
• 특징
  • 생성자 호출 시점에 딱 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)로 지정하면 됩니다.

 

여기서 자바 Bean Property란, 자바에서는 과거부터 Field 값을 직접 변경하지 않고 Getter, Setter를 통해서 값을 읽거나 수정하는 규칙을 만들었는데, 그것이 Java Bean Property 규약입니다. 

필드 주입

이름 그대로 필드에 바로 주입하는 방법이지만, 사용하지 않는 것을 추천합니다.

• 특징
  • 외부에서 변경이 불가능해서 테스트하기 힘들다는 치명적인 단점 존재
  • DI 프레임워크가 없다면 아무것도 할 수 없다.
  • 사용하는 경우
    • 애플리케이션의 실제 코드와 관계 없는 테스트 코드
    • 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

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

침고 : @SpringBootTest 처럼 스프링 컨테이너를 테스트에 통합한 경우에만 Test가 가능합니다. 순수 자바 테스트 코드에서는 당연히 동작하지 않습니다.

 

참고: 다음 코드와 같이 @Bean 에서 파라미터에 의존관계는 자동 주입됩니다. 수동 등록시 자동 등록된 빈의 의존 관계가 필요할 때 문제를 해결할 수 있습니다.

@Bean
OrderService orderService(MemberRepository memberRepoisitory, DiscountPolicy discountPolicy) {
	return new OrderServiceImpl(memberRepository, 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;
    }
}

 

참고: 어쩌면 당연한 이야기이지만 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작합니다. 스프링 빈이 아닌 Member 같은 클래스에서 @Autowired 코드를 적용해도 아무 기능도 동작하지 않습니다.

옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때가 있습니다. 그런데 @Autowired만 사용하면 required 옵션의 기본값이 true로 되어 있어서 자동 주입 대상이 없으면 오류가 발생합니다.

자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.

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

//호출 안됨
@Autowired(required = false)
public void setNoBean1(Member member) {
	0System.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는 스프링 빈이 아닙니다. SetNoBean1()은 @Autowired(required=false)이므로 호출 자체가 되지 않습니다.

참고: @Nullable, Optional은 스프링 전반에 걸쳐서 지원됩니다. 예를 들어서 생성자 자동 주입에서 특정 필드에만 사용해도 됩니다.

생성자 주입을 선택하는 이유

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

불변

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

누락

프레임워크 없이 순수한 자바 코드를 단위 테스트 하는 경우에

다음과 같이 수정자 의존관계인 경우

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
void createOrder() {
    OrderServiceImpl orderService = new OrderServiceImpl();
    orderService.createOrder(1L, "itemA", 10000);
}

이렇게 테스트를 수행하면 실행은 되지만, 막상 실행 결과는 NPE가 발생하는데, memberRepository, discountPolicy 모두 의존 관계주입이 누락되었기 때문입니다.

생성자 주입을 사용하면 다음처럼 주입 데이터를 누락 했을 때 컴파일 오류가 발생합니다. 그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있습니다.

@Test
void createOrder() {
	OrderServiceImpl orderService = new OrderServiceImpl(); // 컴파일 에러 발생
	orderService.createOrder(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` 에 값을 설정해야 하는데, 이 부분이 누락되었습니다. 자바는 컴파일 시점에 다음 오류를 발생시킨다.
• java: variable discountPolicy might not have been initialized

참고: 수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를 사용할 수 없습니다. 오직 생성자 주입 방식만 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;
        this.discountPolicy = discountPolicy;
    }
}

생성자가 딱 1개만 있다면 @Autowired를 생략할 수 있습니다.

@Component
public class OrderServiceImpl implements OrderService {
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
    
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
}

이제는 롬복을 적용해보겠습니다.

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

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

최종 결과 코드는 이전의 코드와 완전히 동일합니다. 롬복이 자바의 애노테이션 프로세서라는 기능을 이용하여 컴파일 시점에 생성자 코드를 자동으로 생성해줍니다.

롬복 라이브러리 적용 방법

build.gradle에 라이브러리 및 환경 추가

plugins {
	id 'java'
	id 'org.springframework.boot' version '3.2.1'
	id 'io.spring.dependency-management' version '1.1.4'
}

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

java {
	sourceCompatibility = '17'
}

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'
}

tasks.named('test') {
	useJUnitPlatform()
}

IntelliJ 환경 설정

1. Preference -> plugin -> lombok 검색 설치 실행(재시작)
2. Preferences -> Annotation Processors 검색 -> Enable annotation processing 체크(재시작)
3. 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인

조회 빈이 2개 이상일 경우

@Autowired는 타입(type)으로 조회합니다.

@Autowired
private DiscountPolicy discountPolicy

타입으로 조회하기 때문에, 마치 다음 코드와 유사하게 동작합니다. (실제로는 더 많은 기능을 제공합니다.)

ac.getBean(DiscountPolicy.class)

스프링 빈 조회에서 학습하였듯이, 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생합니다.

DiscountPolicy의 하위 타입인 FixDiscountPolicy, RateDiscountPolicy 둘 다 스프링으로 선언할 경우, NoUniqueBeanDefinitionException 에러가 발생합니다.

NoUniqueBeanDefinitionException: No qualifying bean of type
'hello.core.discount.DiscountPolicy' available: expected single matching bean
but found 2: fixDiscountPolicy,rateDiscountPolicy

이때 하위 타입으로 지정할 수도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다. 그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 되지 않습니다.

스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존 관계를 자동 주입해서 해결하는 여러 방법이 존재합니다.

@Autowired 필드 명, @Qualifire, @Primary

해결 방법을 하나씩 알아보겠습니다.

@Autowired 필드 명 매칭

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

@Autowired
private DiscountPolicy rateDiscountPolicy

필드 명을 빈 이름으로 변경할 경우, 필드 명이 rateDiscountPolicy이므로 정상 주입됩니다.

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

1. 타입 매칭
2. 타입 매칭의 결과가 2개 이상일 경우, 필드 명, 파라미터 명으로 빈 이름 매칭

@Qualifier 사용

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

빈 등록 시 @Qualifier를 붙여줍니다.

@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}

// or

@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}

주입시에 @Qualifier를 붙여주고 등록한 이름을 적어줍니다.

// 생성자 자동 주입 예시
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

// 수정자 자동 주입 예시
@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
	this.discountPolicy = discountPolicy;
}

@Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 찾지 못할 경우, mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾습니다. 하지만 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 것이 명확하고 좋습니다.

 

다음과 같이 직접 빈 등록시에도 @Qualifier를 동일하게 사용할 수 있습니다.

@Bean
@Qualifier("mainDiscountPolicy")
public DiscountPolicy discountPolicy() {
	return new ...
}

1. @Qualifier끼리 매칭
2. 빈 이름 매칭
3. 만약 빈이 없다면 NoSuchBeanDefinitionException 예외 발생

@Primary 사용

@Primary는 우선순위를 정하는 방법입니다. @Autowired 시에 여러 빈이 매칭되면 @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) {
	this.discountPolicy = discountPolicy;
}

코드를 실행해보면 @Primary가 잘 동작하는 것을 확인할 수 있습니다.

 

여기까지 본다면 @Primary와 @Qualifier 중에 어떤 것을 사용할 지 고민이 될 것입니다. @Qualifier의 단점은 주입 받을 때 다음과 같이 모든 코드에 @Qualifier를 붙여주어야 한다는 점입니다.

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

반면에 @Primary 를 사용하면 이렇게 @Qualifier 를 붙일 필요가 없습니다.

 

@Primary, @Qualifier 활용

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

 

우선순위

@Primary 는 기본값 처럼 동작하는 것이고, @Qualifier 는 매우 상세하게 동작합니다. 이런 경우 어떤 것이 우선권을 가져갈까요? 스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높습니다. 따라서 여기서도 `@Qualifier` 가 우선권이 높습니다.

Annotation 직접 만들기

@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일 시 타입 체크가 되지 않습니다. 다음과 같은 Annotation을 직접 만들어서 문제를 해결할 수 있습니다.

package hello.core.annotataion;

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)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

//생성자 자동 주입
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
@MainDiscountPolicy DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

//수정자 자동 주입
@Autowired
public DiscountPolicy setDiscountPolicy(@MainDiscountPolicy DiscountPolicy discountPolicy) {
	this.discountPolicy = discountPolicy;
}

Annotation에는 상속이라는 개념이 없습니다. 이렇게 여러 Annotation을 모아서 사용하는 기능을 스프링이 지원해주는 기능입니다. @Qualifier 뿐만 아니라 다른 Annotation들도 함께 조합해서 사용할 수 있으며, 단적으로 @Autowired를 재정의 할 수 있습니다.

조회한 빈이 모두 필요할 때, List와 Map을 사용하자

의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있습니다.

예를 들어서 할인 서비스를 제공하는데, 클라이언트가 할인의 종류를 선택할 수 있다고 가정해보겠습니다. 스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있습니다.

package hello.core.autowired.allbean;

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.annotation.AnnotationConfigApplicationContext;

import java.util.List;
import java.util.Map;

public class AllBeanTest {
    @Test
    void findAllBean() {
        AnnotationConfigApplicationContext 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");

        Assertions.assertThat(discountService).isInstanceOf(DiscountService.class);
        Assertions.assertThat(discountPrice).isEqualTo(1000);

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

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

        @Autowired
        public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policyList) {
            this.policyMap = policyMap;
            this.policyList = policyList;
            System.out.println("policyMap = " + policyMap);
            System.out.println("policyList = " + policyList);
        }
        public int discount(Member member, int price, String discountCode) {
            DiscountPolicy discountPolicy = policyMap.get(discountCode);

            System.out.println("discountCode = " + discountCode);
            System.out.println("discountPolicy = " + discountPolicy);

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

로직 분석

• DiscountService는 Map으로 모든 DiscountPolicy를 주입받는다.
• 이때 fixDiscountPolicy, discount ()메서드는 discountCode로 "fixDiscountPolicy"가 넘어오면 map에서 rateDiscountPolicy 스프링 빈을 찾아서 실행한다.

주입 분석

 

• Map<String, DiscountPolicy> : map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로 DiscountPolicy타입으로 조회한 모든 스프링 빈을 담아준다.
• List<DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
• 만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.

참고 - 스프링 컨테이너를 생성하면서 스프링 빈 등록하기

스프링 컨테이너는 생성자에 클래스 정보를 받습니다. 여기에 클래스 정보를 넘기면 해당 클래스가 스프링 빈으로 자동 등록이 도ㅟㅂ니다.

new AnnotationConfigApplicationContext(AutoAppConfig.class,DiscountService.class);

 

이 코드는 2가지로 나누어 이해할 수 있습니다.

• new AnnotationConfigApplicationContext()를 통해 스프링 컨테이너를 생성한다.
• AutoAppConfig.class, DiscountService.class 를 파라미터로 넘기면서 해당 클래스를 자동으로 스프링 빈으로 등록한다.

정리하면 스프링 컨테이너를 생성하면서, 해당 컨테이너에 동시에 AutoAppConfig , DiscountService를 스프링 빈으로 자동 등록합니다.

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

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

스프링은 현재 시간이 갈 수록 점점 자동을 선호하는 추세입니다. @Component뿐만 아니라 @Controller, @Service, @Repository 처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원합니다. 거기에 더해서 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계되었습니다.

 

설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만, 직접 빈을 등록하고, 객체를 생성하고, 주입할 대상을 일일히 적어주는 과정은 상당히 번거롭습니다.

또한 실무에서는 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 됩니다.

그리고 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있습니다.

 

그렇다면 수동 빈 등록은 언제 사용하는 것이 좋을까?

애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있습니다.

• 업무 로직 빈: 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 Repository 등이 모두 업무 로직이며, 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경됩니다. 업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느 정도 유사한 패턴이 있습니다. 이런 경우는 자동 기능을 적극 사용하는 것이 좋으며, 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악이 쉽습니다.
• 기술 지원 빈: 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용합니다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들을 의미합니다. 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미칩니다. 그리고 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많습니다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋습니다.

 

비즈니스 로직 중에서 다형성을 적극 활용할 때

조회한 빈이 모두 필요한 경우를 다시 생각해봅시다.

DiscountService가 의존 관계 자동 주입으로 Map에 주입받는 상황이였습니다. 여기에 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일 지 코드만 보고 한번에 쉽게 파악하기는 쉽지 않습니다. 특히 자동 등록을 사용하고 있기 때문에 파악하려면 여러 코드를 찾아봐야 합니다.

 

이런 경우는 수동 빈으로 등록하거나 또는 자동으로 하면 특정 패키지에 같이 묶어두는 것이 코드를 파악하는 데 조금 더 수월합니다.

참고로 스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 예외다. 이런 부분들은 스프링 자체를 잘 이해하고 스프링의 의도대로 잘 사용하는게 중요하다. 스프링 부트의 경우 DataSource 같은 데이터베이스 연결에 사용하는 기술 지원 로직까지 내부에서 자동으로 등록하는데, 이런 부분은 메뉴얼을 잘 참고해서 스프링 부트가 의도한 대로 편리하게 사용하면 된다. 반면에 스프링 부트가 아니라 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 드러내는 것이 좋다.

참고

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