Lombok 라이브러리의 @RequiredArgsConstructor

롬복과 최신 트랜드

막상 개발을 해보면, 대부분이 다 불변이고, 그래서 다음과 같이 필드에 final 키워드를 사용하게 된다.

그런데 생성자도 만들어야 하고, 주입 받은 값을 대입하는 코드도 만들어야 하고...(매우 귀찮다)

필드 주입처럼 좀 편리하게 사용하는 방법은 없을까? -> 롬복으로 해결 가능하다!

 

[롬복 추가]

프로젝트 시작할 때 롬복을 설치하지 않았기 때문에 build.gradle에 다음과 같은 코드를 추가하자(처음에 롬복을 추가했으면 이 과정을 뛰어넘어도 된다)

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

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'

	//lombok 라이브러리 추가 시작
	compileOnly 'org.projectlombok:lombok' 
	annotationProcessor 'org.projectlombok:lombok'
	
	testCompileOnly 'org.projectlombok:lombok' 
	testAnnotationProcessor 'org.projectlombok:lombok' 
	//lombok 라이브러리 추가 끝
}

@RequiredArgsConstructor

final이 붙으면 필수값이 되니까 이 필수값을 기반으로 생성자를 만들어준다.

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

• 다음 코드에는 보이지 않지만 메소드가 있으며 실제 호출 가능하다.

이 최종결과 코드와 이전의 코드는 완전히 동일하다.

롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해준다.

실제 class 를 열어보면 다음 코드가 추가되어 있는 것을 확인할 수 있다

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

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

[정리]

최근에는 생성자를 딱 1개 두고, @Autowired 를 생략하는 방법을 주로 사용한다.

여기에 Lombok 라이브러리의 @RequiredArgsConstructor 함께 사용하면 기능은 다 제공하면서, 코드는 깔끔하게 사용할 수 있다.

 

조회 빈이 2개 이상 - 문제

Autowired 는 타입(Type)으로 조회한다.

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

스프링 빈 조회에서 학습했듯이 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다. DiscountPolicy 의 하위 타입인 FixDiscountPolicy , RateDiscountPolicy 둘다 스프링 빈으로 선언해보자

  @Component
  public class FixDiscountPolicy implements DiscountPolicy {}

  @Component
  public class RateDiscountPolicy implements DiscountPolicy {}

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

  @Autowired
  private DiscountPolicy discountPolicy

NoUniqueBeanDefinitionException 오류가 발생한다.

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

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

이때 하위 타입으로 지정할 수 도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다.(구체적인 것에 의존하면 안된다)

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

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

 

해결 방법 = @Autowired 필드 명, @Qualifier, @Primary

해결 방법을 하나씩 알아보자.

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

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

[1]@Autowired 필드 명 매칭

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

먼저 타입으로 매칭 → 타입 매칭의 결과가 2개 이상일 때 필드 명 또는 파라미터 명으로 빈 이름 매칭한다.

예를 들어 지금 DiscountPolicy 타입이 rateDiscountPolicy, fixDiscountPolicy 이렇게 2개가 있다.

기존 코드

  @Autowired
  private DiscountPolicy discountPolicy

위의 기존 코드로 돌리면 오류가 나지지만 다음과 같이 필드 명을 빈 이름으로 변경한다면 오류가 나지 않는다. (필드명 혹은 파라미터 명을 빈 이름으로 변경)

//필드명을 빈 이름으로 
@Autowired
private DiscountPolicy rateDiscountPolicy

//파라미터 명을 빈 이름으로 
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy rateDiscountPolicy) {
		this.memberRepository = memberRepository; //할당 하는 부분
		this.discountPolicy = rateDiscountPolicy;
	}

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

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

[2] @Qualifier 붙이기

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

[방법]

1. 빈 등록 시 @Qualifier("mainDiscountPolicy") 붙이기

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

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

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

2-1) 생성자 자동 주입 예시

@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy")DiscountPolicy discountPolicy) {
		this.memberRepository = memberRepository; //할당 하는 부분
		this.discountPolicy = discountPolicy;
	}

2-2) 수정자 자동 주입 예시

@Autowired
  public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy")
  DiscountPolicy discountPolicy) {
      this.discountPolicy = discountPolicy;
  }

• 직접 빈 등록 시에도 @Qualifier를 동일하게 사용할 수 있다.

1. @Qualifier끼리 매칭
2. 빈 이름 매칭

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

1. NoSuchBeanDefinitionException 예외 발생

[3] @Primary 사용 (많이 상용)

@Primary는 우선순위를 정하는 방법이다.

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

[방법]

RateDiscountPolicy에 우선권을 부여하기 위해 RateDiscountPolicy위에만 어노테이션을 붙이자

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

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

여기까지 보면 @Primary 와 @Qualifier 중에 어떤 것을 사용하면 좋을지 고민이 될 것이다.

@Qualifier 의 단점은 주입 받을 때 다음과 같이 모든 코드에 @Qualifier 를 붙여주어야 한다는 점이다.

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

@Primary, @Qualifier 활용

코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고,

코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자.

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

물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 @Qualifier 를 지정해주는 것은 상관없다.

우선순위

@Primary 는 기본값 처럼 동작하는 것이고, @Qualifier 는 매우 상세하게 동작한다.

이런 경우 어떤 것이 우선권을 가져갈까? 자세한 것이 우선순위가 높다.

<aside> 💡 스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선순위가 높다.

</aside>

따라서 여기서도 @Qualifier 가 우선권이 높다.

애노테이션 직접 만들기

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를 쓰는데 이 안의 있는 것들을 다 가지고 오는지?

1. Target, Retention같은 부분은 자바 언어 문법상 기본으로 제공되는 부분이어서, 직접 적어주어야 합니다.
2. 자바 자체에서도 여러 애노테이션을 달 수는 있습니다. 강의에서 설명드린 부분은 에노테이션 안에 에노테이션이 포함 되는 것을 바로 인지할 수 있는가에 대한 부분입니다. 자바 언어에서는 이것을 바로 인지하지 못합니다.

[적용]

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

애노테이션에는 상속이라는 개념이 없다. 이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다.

@Qualifier 뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다. 단적으로 @Autowired도 재정의 할 수 있다.

물론 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 더 혼란만 가중할 수 있다.

하지만 Qualifier는 어노테이션을 재정의해서 사용하는 것이 더 깔끔하다.