스프링 핵심 원리 - 기본편 [의존관계 자동 주입]

윤현우·2023년 2월 2일
AutowiredSpring bootbeandi
0

스프링 핵심 원리 - 기본편

목록 보기
9/11
post-thumbnail

목차

  1. 다양한 의존관계 주입 방법
  2. 생성자 주입을 선택해라!
  3. 롬복과 최신 트랜드
  4. 조회 빈이 2개 이상 - 문제
  5. @Autowired 필드 명, @Qualifier, @Primary
  6. 애노테이션 직접 만들기
  7. 조회한 빈이 모두 필요할 때, List, Map
  8. 자동, 수동의 올바른 실무 운영 기준

1. 다양한 의존관계 주입 방법

의존관계 주입은 크게 4가지 방법이 있다.

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

1-1. 생성자 주입

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

생성자 주입 특징

  • 생성자 호출 시점에 딱 1번만 호출되는 것이 보장된다.
  • 불편, 필수 의존관계에 사용
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {

    //memberRepository와 discountPolicy가 의존하는 구현체에가 들어간다. memberRepository --> memoryMemberRepository , discountPolicy --> RateDiscountPolicy
    this.memberRepository = memberRepository;
    System.out.println("memberRepository = " + memberRepository);
    this.discountPolicy = discountPolicy;
    System.out.println("discountPolicy = " + discountPolicy);
}
실행결과
memberRepository = hello.core.member.MemoryMemberRepository@5aa360ea
discountPolicy = hello.core.discount.FixDiscountPolicy@6548bb7d

중요!
단일 생성자일 경우(생성자가 1개) @Autowired를 생략해도 자동 주입 된다. 물론 스프링 빈에만 해당한다.

1-2. 수정자 주입(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) 로 지정하면 된다.

1-3. 필드 주입

필드에 바로 주입하는 방법(그동안 내가 사용하던 방법)

필드 주입 특징

  • 코드가 간결해서 많은 개발자들을 유혹하지만 외부에서 변경이 불가능해서 테스트 하기 힘들다는 치명적인 단점이 있다.

  • DI 프레임워크가 없으면 아무것도 할 수 없다.

  • 사용하지 말자!

    • 애플리케이션의 실제 코드와 관계 없는 테스트 코드
    • 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용
@Component
public class OrderServiceImpl implements OrderService {
	@Autowired
 	private MemberRepository memberRepository;
 
 	@Autowired
 	private DiscountPolicy discountPolicy;
}

필드 주입을 사용해서 테스트를 하려면 @SpringBootTest처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능

1-4. 일반 메서드 주입

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

일반 메서드 주입 특징

  • 한번에 여러 필드를 주입 받을 수 있다.
  • 일반적으로 잘 사용 X

2. 생성자 주입을 선택해라!

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

불변

  • 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려
    대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다.(불변해야 한다.)

  • 수정자 주입을 사용하면, setXxx 메서드를 public으로 열어두어야 한다.

  • 누군가 실수로 변경할 수 도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.

  • 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불변하게 설계할
    수 있다.

2-1. 정리

  • 생성자 주입 방식을 선택하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고, 순수한 자바 언어의
    특징을 잘 살리는 방법이기도 하다.

  • 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다.
    생성자 주입과 수정자 주입을 동시에 사용할 수 있다.

  • 항상 생성자 주입을 선택해라! 그리고 가끔 옵션이 필요하면 수정자 주입을 선택해라. 필드 주입은 사용하지
    않는게 좋다.

3. 롬복과 최신 트랜드

롬복을 사용하면 생성자나 주입 받은 값을 대입하는 코드 등을 안만들고 사용할 수 있다.

기본 코드

@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;
 	}
}
  • 롬복 라이브러리가 제공하는 @RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서
    생성자를 자동으로 만들어준다. (다음 코드에는 보이지 않지만 실제 호출 가능하다.)

롬복 사용 최종 결과 코드

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
	private final MemberRepository memberRepository;
 	private final DiscountPolicy discountPolicy;
}
  • 롬복이 자바의 애노테이션 프로세서라는 기능을 용해서 컴파일 시점에 생성자 코드를 자동으로 생성해준다.

3-1. 정리

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

나중에 롬복에 대해 따로 정리 해야겠다.(롬복 참 좋은 놈이구만)

4. 조회 빈이 2개 이상 - 문제

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

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

DiscountPolicy의 하위타입인 FixDiscountPolicy, RateDiscountPolicy 둘다 스프링 빈으로 선언해보자

@Component
public class FixDiscountPolicy implements DiscountPolicy{
	...
}
@Component
public class RateDiscountPolicy implements DiscountPolicy{
	...
}

이후 의존관계 자동 주입을 샐행하면

@Autowired
private DiscountPolicy discountPolicy;

NoUniqueBeanDefinitionException오류가 발생한다.

NoUniqueBeanDefinitionException: 하나의 빈을 기대했는데 한나의 빈이 아닌 여러개의 빈 fixDiscountPolicy , rateDiscountPolicy 2개가 발견되었다고 알려준다.

이때 하위 타입으로 의존성 주입을 할 수 있지만,

@Autowired
private FixDiscountPolicy fixDiscountPolicy;

하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다.

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

5. @Autowired 필드 명, @Qualifier, @Primary

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

  • @Autowired 필드명 매칭
  • @Qualifier -> @Qualifier끼리 매칭 -> 빈 이름 매칭
  • @Primary 사용

5-1. @Autowired 필드명 매칭

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

필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy

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

@Autowired 매칭 정리

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

5-2. @Qualifier 사용

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

빈 등록 시 @Qualifier를 붙여준다.

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

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

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

@Qualifier 정리

  1. @Qualifier끼리 매칭
  2. 빈 이름 매칭
  3. NoSuchBeanDefinitionException 예외 발생

5-3. @Primary 사용

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

rateDiscountPolicy를 우선권을 주어보자

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

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

6. 어노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안된다.

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

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

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

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

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

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

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

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

결론부터 이야기하면, 스프링이 나오고 시간이 갈 수록 점점 자동을 선호하는 추세다.

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

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

8-1. 수동 빈 등록은 언제 사용하면 좋을까?

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

업무 로직

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

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

기술 지원 로직

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

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

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

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

조회한 빈이 2개 이상일 때나 모두 필요할 때,에 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일지 코드만 보고 한번에 쉽게 파악할 수 있을까?

내가 개발했으니 크게 관계가 없지만, 만약 이 코드를 다른 개발자가 개발해서 나에게 준 것이라면 어떨까?

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

8-2. 정리

  • 편리한 자동 기능을 기본으로 사용하자
  • 직접 등록하는 기술 지원 객체는 수동 등록
  • 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해보자

References(참고자료)
https://www.inflearn.com/

profile
윤현우
개발자가 되는 그날까지
이전 포스트

스프링 핵심 원리 - 기본편 [컴포넌트 스캔]

다음 포스트

스프링 핵심 원리 - 기본편 [빈 생명주기 콜백]

0개의 댓글