Home 의존관계 자동주입
Post
Cancel

의존관계 자동주입

Posted Jul 18, 2023 Updated Sep 20, 2023
By
16 min read

의존관계 주입

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

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

생성자 주입

생성자를 통해서 의존 관계를 주입받는 방법.

지금까지 진행했던 방법이 생성자 주입이다.

1
2
3
4
5
6
7
8
9
10

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

	@Autowired
	public OrderServiceImpl(MemberRepository mr, DiscountPolicy dp){
		this.memberRepository = mr;
		this.discountPolicy = dp;
	}

특징

  • 생성자 호출 시점에 딱 한번만 호출되는 것이 보장된다.
  • “불변, 필수” 의존관계에 사용한다.
1
2
3

public void setDiscountPolicy(DiscountPolicy discountPolicy){
	this.discountPolicy = discountPolicy;
}

이런걸 만들어 놓으면 불변이 아니다.

1

private final MemberRepository memberRepository;

final 키워드를 사용해줌으로써 무조건 초기화를 하도록 했다.

이를 “필수”라고 볼 수 있다.

생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입 된다.

수정자 주입(setter 주입)

setter에 @Autowired를 붙이면 자동 주입된다.

1
2
3
4

@Autowired
public void setDiscountPolicy(DiscountPolicy discountPolicy){
	this.discountPolicy = discountPolicy;
}

특징

  • 선택, 변경 가능성이 있는 의존관계에 사용한다.
  • 자바빈 프로퍼티 규약의 수정자 메서드를 사용하는 방식이다.

@Autowired 어노테이션은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false)로 지정하면 된다.

필드 주입

필드에 바로 주입하는 방식이다.

1
2

@Autowired
private DiscountPolicy discountPolicy;

recommtoon.com 에 적용했던 것이 필드주입.

특징

  • 외부에서 변경이 불가능해서 테스트 하기 힘들다는 치명적인 단점이 있다.
  • DI 프레임워크가 없으면 아무것도 할 수 없다.

즉 순수한 자바코드에서는 사용할 수 없다.

사용하지 말자

일반 메서드 주입

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

1
2
3
4
5

@Autowired
public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy){
	this.memberRepository = memberRepository;
	this.discountPolicy = discountPolicy;
}

특징

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

옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때가 있다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

//호출 안됨 
@Autowired(required = false) 
public void setNoBean1(Member member) { 	
	System.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) { 	
	System.out.println("setNoBean3 = " + member); 
}

** Member은 스프링 빈으로 설정 안해놨기 때문에 자동 주입을 받을 수 없다.

생성자 주입이 좋은 이유

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

Why?

불변

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

누락

프레임워크 없이 순수한 자바 코드로 단위테스트 하는 경우가 많다.

테스트를 할 때 @Autowired가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만 순수한 자바코드로만 단위테스트를 수행한다면 Null Point Exception만 발생한다.

생성자 주입을 사용한다면 데이터를 누락했을 때 컴파일 오류가 발생하기 때문에 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.

1
2

OrderServiceImpl orderService = new OrderServiceImpl(); //오류
orderService.createOrder(1L, "itemA", 10000);

심지어 final 키워드도 사용할 수 있어 필수 필드 부분에 누락된 부분을 컴파일 때 잡을 수 있다.

컴파일 오류는 세상에서 가장 빠르고, 좋은 오류이다.

롬복과 최신 트렌드

롬복 설치하면 클래스에 @Getter, @Setter, @ToString 등 어노테이션을 붙임으로 함수 작성 없이 getter, setter 사용할 수 있는 등의 기능을 제공받을 수 있다.

막상 개발을 해보면 대부분 다 불변이고 생성자에 final 키워드를 사용하게 된다. 그래서 생성자도 만들어야 하고, 주입 받은 값을 대입하는 코드도 만들어야 하는 귀찮은 문제가 있다.

1
2
3
4
5

@Autowired
public OrderServiceImpl(MemberRepository mr, DiscountPolicy dp){
	this.memberRepository = mr;
	this.discountPolicy = dp;
}

@RequiredArgsConstructor 어노테이션을 통해 생성자 작성을 하지 않고 생성자를 사용할 수 있다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

@Component  
@RequiredArgsConstructor  
public class OrderServiceImpl implements OrderService{  
  
	private final MemberRepository memberRepository;  
	private final DiscountPolicy discountPolicy;  
  
	/* 생성자 제거 */ 

	@Override  
	public Order createOrder(Long memberId, String itemName, int itemPrice) {  
		Member member = memberRepository.findById(memberId);  
		int discountPrice = discountPolicy.discount(member, itemPrice);  
  
		return new Order(memberId, itemName, itemPrice, discountPrice);  
	}  
}

의존관계를 추가할때에도 변수만 추가하면 끝이다.

1
2
3

private final MemberRepository memberRepository;  
private final DiscountPolicy discountPolicy;
private final NewClass newClass;

@Autowired 사용 시 조회 빈이 2개 이상일 때?

DiscountPolicy의 하위타입인 FixDiscountPolicy, RateDiscountPolicy 둘 다 스프링 빈으로 선언이 됐다고 가정하자. (FixDiscountPolicy에 @Component 추가.)

NoUniqueBeanDefinitionException 오류가 발생한다.

하위타입으로 지정하면 구체로 지정하는 것이기 때문에 DIP를 위배하고 유연성이 떨어진다.

빈을 수동 등록해서 문제를 해결할 수 있지만, 자동 주입에서 해결하는 방법이 있다.

@Autowired 필드 명 매칭

1
2
3
4
5
6
7

@Autowired
private DiscountPolicy discountPolicy;

->

@Autowired
private DiscountPolicy rateDiscountPolicy;

@Qualifier

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

1
2
3
4
5
6
7
8
9

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

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

이렇게 해놓고

1
2
3
4
5
6
7
8
9

@Autowired
@Qualifier("mainDiscountPolicy")
private DiscountPolicy discountPolicy;

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

와 같이 사용 가능하다.

@Primary 사용

우선순위를 정하는 방법이다. 자주 사용하는 방법이기도 하다.

@Primary 어노테이션을 클래스 위에 붙이면 우선권을 부여하는 것이다.

@Primary, @Qualifier 활용

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

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

애노테이션 직접 만들기

1
2
3
4
5
6
7

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})  
@Retention(RetentionPolicy.RUNTIME)  
@Inherited  
@Documented  
@Qualifier("mainDiscountPolicy")  
public @interface MainDiscountPolicy {  
}

@Qualifier 어노테이션을 타고 올라가면 @Target, @Retention 등 필요한 것을 복사할 수 있다.

그리고 원하는 @Qualifier(“mainDiscountPolicy”)를 붙여서 어노테이션 클래스를 만들고

1
2
3

@Autowired
@MainDiscountPolicy
private DiscountPolicy discountPolicy;

이런식으로 사용 가능하다.

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

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

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,"rateDiscountPolicy");  
  
		Assertions.assertThat(discountService).isInstanceOf(DiscountService.class);  
		Assertions.assertThat(discountPrice).isEqualTo(1000);  
	}  
  
	static class DiscountService{  
		private final Map<String, DiscountPolicy> policyMap;  
		private final List<DiscountPolicy> policies;  
  
		@Autowired  
		public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies)  
		{  
			this.policies = policies;  
			this.policyMap = policyMap;  
			System.out.println("policyMap = " + policyMap);  
			System.out.println("policies = " + policies);  
		}  
  
		public int discount(Member member, int price, String discountCode) {  
			DiscountPolicy discountPolicy = policyMap.get(discountCode);  
			return discountPolicy.discount(member, price);  
		}  
	}  
}

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

편리한 자동 기능(컴포넌트 스캔, 자동 주입)을 기본으로 사용하자.

어떤 경우에 설정 정보를 통해서 수동으로 빈을 등록하고, 의존관계도 수동으로 등록해야 할까?

개발자 입장에서 스프링 빈을 하나 등록할 때 @Component만 붙이면 될 일을 @Configuration 설정 정보에 가서 @Bean을 적고 객체를 생성하고 주입할 대상을 일일이 적어주는 과정은 상당히 번거롭다.

관리할 빈이 많으면 관리하는 것 자체가 부담이다.

그리고 결정적으로 자동으로 해도 OCP, DIP를 지킬 수 있다.

그래서 수동 빈 등록은 언제?

  • 업무 로직 빈 : 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
  • 기술 지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

업무 로직은 숫자도 매우 많고 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리처럼 어느정도 유사한 패턴이 있다. 이런 경우 자동기능을 적극 사용하는 것이 좋다.

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

단 업무 로직에서 다형성을 적극 활용할 때가 있다. 이때는 수동으로 등록하거나 패키징해주는 것이 중요하다.

Map<String, DiscountPolicy> 에 주입을 받는 상황을 생각해보자. 코드를 개발한 사람이 아닌 다른 사람이 코드만 보고 DiscountPolicy에 무엇이 들어가있는지 알 수 있을까?

자동 등록을 사용하고 싶다면 DiscountPolicy에 대한 구현체들은 하나의 패키지에 모아두어야 한다.

Spring, 스프링부트 기본
java Spring SpringBoot
This post is licensed under CC BY 4.0 by the author.
Recently Updated
Contents