[Spring] 롬복과 최신 트렌드

 

안녕하세요! 이번 포스팅은 롬복과 최신 트렌드에 대해서 알아보겠습니다.

 

롬복과 최신 트렌드

막상 개발을 해보면, 대부분이 다 불변이고, 그래서 다음과 같이 생성자에 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;
}

엄청나게 간결해졌습니다.

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

 

public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy 
discountPolicy) {
     this.memberRepository = memberRepository;
     this.discountPolicy = discountPolicy;
}

 

정리

최근에는 생성자를 딱 1개 두고 @Autowired를 생략하는 방법을 주로 사용합니다. 여기에 Lombok 라이브러리의 @RequiredArgsConstructor 함께 사용하면 기능은 다 제공하면서, 코드는 깔끔하게 사용할 수 있습니다.

 

 

롬복 라이브러리 조회 방법

 

plugins {
     id 'org.springframework.boot' version '2.3.2.RELEASE'
     id 'io.spring.dependency-management' version '1.0.9.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') {
 exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
 }
}
test {
 useJUnitPlatform()
}

1. Preferences(윈도우 File Settings) plugin lombok 검색 설치 실행 (재시작)

2. Preferences Annotation Processors 검색 Enable annotation processing 체크 (재시작)

3. 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인

 

조회 빈이 2개 이상 - 문제

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

 

@Autowired
private DiscountPolicy discountPolicy

타입으로 조회하기 때문에, 마치 다음 코드와 유사하게 동작합니다.

ac.getBean(DiscountPolicy.class)

 

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

DisocuntPolicy의 하위 타입인 FixDiscountPolicy, RateDiscountPolicy 둘 다 스프링 빈으로 선언해봅시다.

 

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

그리고 이렇게 의존관계 자동 주입을 실행하면

 

@Autowired
private DiscountPolicy discountPolicy

NoUniqueBeanDefinitionException 오류가 발생합니다.

 

오류 메시지가 친절하게도 하나의 빈을 기대했는데 fixDiscountPolicy, rateDiscountPolicy 2개가 발견되었다고 알려줍니다.

 

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

그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안 됩니다.

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

 

 

@Autowired 필드 명, @Qualifier, @Primary

 

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

 

조회 대상 빈이 2개 이상일 때 해결 방법

- @Autowired 필드 명 매칭

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

- @Primary 사용

 

@Autowired 필드 명 매칭

 

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

 

기존 코드

 

 

필드 명을 빈 이름으로 변경

 

필드 명이 rateDiscountPolicy 이므로 정상 주입됩니다.

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

 

@Autowired 매칭 정리

1. 타입 매칭

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

 

@Qualifier 사용

 

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

생성자 자동 주입 예시

 

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

 

수정자 자동 주입 예시

 

@Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 못 찾으면 어떻게 될까요? 그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾습니다. 하지만 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 게 명확하고 좋다고 합니다.

 

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

 

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

@Qualifier 정리

1. @Qualifier끼리 매칭

2. 빈 이름 매칭

3. NoSuchBeanDefinitionException 예외 발생

 

 

@Primary 사용

 

@Primary는 우선순위를 정하는 방법입니다. @Autowired 시에 여러 빈이 매칭 되면 @Primary가 우선권을 가집니다.

 

rateDiscountPolicy가 우선권을 가지도록 해보겠습니다.

@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가 잘 동작하는 것을 확인할 수 있습니다.

 

여기까지 보면 @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를 지정해서 명시적으로 획득하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있습니다. 물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 @Qualifier를 지정해주는 것은 상관없습니다.

 

우선순위

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

 

애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy) 이렇게 문자를 적으면 컴파일 시 타입 체크가 안됩니다. 다음과 같은 애노테이션을 만들어서 문제를 해결할 수 있습니다.

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) {
	 return discountPolicy;
}

애노테이션에는 상속이라는 개념이 없습니다. 이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능입니다. @Qualifier 뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있습니다. 단적으로 @Autowired도 재정의 할 수 있습니다. 물론 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 더 혼란만 가중할 수 있습니다.

 

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

 

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

예를 들어서 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정해봅시다.

스프링 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있습니다.

 

import hello.core.AutoAppConfig;
import hello.core.discount.DiscountPolicy;
import hello.core.member.Grade;
import hello.core.member.Member;
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.assertThat;

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);
 }
 
 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);
         System.out.println("discountCode = " + discountCode);
         System.out.println("discountPolicy = " + discountPolicy);

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

 

로직 분석

- DiscountService는 Map으로 만든 DiscountPolicy를 주입받습니다. 이때 fixDiscountPolicy, rateDiscountPolicy가 주입됩니다.

- disocunt() 메서드는 discountCode로 "fixDiscountPolicy"가 넘어오면 map에서 fixDiscountPolicy 스프링 빈을 찾아서 실행합니다. 물론 "rateDiscountPolicy"가 넘어오면 rateDiscountPolicy 스프링 빈을 찾아서 실행합니다.

 

주입 분석

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

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

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

 

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

 

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

new AnnotationConfigApplicationConctext()를 통해 스프링 컨테이너를 생성합니다.

AutoAppConfig.class, DiscountService.class를 파라미터로 넘기면서 해당 클래스를 자동으로 스프링 빈으로 등록합니다. 정리하면 스프링 컨테이너를 생성하면서, 해당 컨테이너 동시에 AutoAppConfig, DiscountService를 스프링 빈으로 자동 등록합니다.

 

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

 

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

그러면 어떤 경우에 컴포넌트 스캔과 자동 주입을 사용하고, 어떤 경우에 설정 정보를 통해서 수동으로 빈을 등록하고, 의존 관계도 수동으로 주입해야 할까요?

 

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

 

설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만, 개발자 입장에서는 스프링 빈을 하나 등록할 때 @Component만 넣어주면 끝나는 일을 @Configuration 설정 정보에 가서 @Bean을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정을 상당히 번거롭습니다.

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

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

 

그러면 수동 빈 등록은 언제 사용하면 좋을까요?

 

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

 

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

 

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

 

업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리처럼 어느 정도 유사한 패턴이 있습니다. 이런 경우 자동 기능을 적극 사용 한느 것이 좋습니다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽습니다.

기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미칩니다. 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 드러나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많습니다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 들어내는 것이 좋습니다.

 

애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 딱 설정 정보에 바로 나타나게 하는 것이 유지보수하기 좋습니다.

 

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

 

의존관계 자동 주입 - 조회한 빈이 모두 필요할 때, List, Map을 다시 봅시다.

DiscountService가 의존관계 자동 주입으로 Map <String, DiscountPolicy>에 주입을 받는 상황을 생각해봅시다. 여기에 어떤 빈들이 주입될지, 각 빈들의 이름은 무엇일지 코드만 보고 한 번에 쉽게 파악할 수 있을까요? 내가 개발했으니 크게 관계가 없지만, 만약 이 코드를 다른 개발자가 개발해서 나에게 준 것이라면 어떨까요?

자동 등록을 사용하고 있기 때문에 파악하려면 여려 코드를 찾아봐야 합니다.

 

이런 경우 수동 빈으로 등록하거나 또는 자동으로 하면 특정 패키지에 같이 묶어두는 것이 좋습니다.

 

이 부분을 별도의 설정 정보로 만들고 수동으로 등록하면 다음과 같습니다.

 

@Configuration
public class DiscountPolicyConfig {
 
 @Bean
 public DiscountPolicy rateDiscountPolicy() {
 return new RateDiscountPolicy();
 }
 
 @Bean
 public DiscountPolicy fixDiscountPolicy() {
 return new FixDiscountPolicy();
 }
}

이 설정 정보만 봐도 한눈에 빈의 이름은 물론이고, 어떤 빈들이 주입될지 파악할 수 있습니다. 그래도 빈 자동 등록을 사용하고 싶으면 파악하기 좋게 DiscountPolicy의 구현 빈들만 따로 모아서 특정 패키지에 모아 두자.

 

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