[작성일: 2023. 08. 13]
다양한 의존관계 주입 방법
의존관계 주입에는 크게 생성자 주입, setter 주입, 필드 주입, 일만 메서드 주입 등이 있다.
생성자 주입
생성자 주입은 생성자 호출 시에 딱 1번만 호출되는 것이 보장되며 불변, 필수 의존관계에 사용된다. 생성자가 1개만 있으면 @Autowired를 생략 할 수 있다.(스프링 빈에만 해당)
@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;
}
}
수정자 주입
setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해 의존관계를 주입하며 선택, 변경 가능성이 있는 의존관계에 사용된다. 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다. @Autowired의 기본 동작은 주입할 대상이 없으면 오류가 발생하므로 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false)로 지정하면 된다.
자바에서는 과거에서부터 필드의 값을 직접 변경하지 않고 setXxx, getXxx라는 메서드를 통해 값을 읽거나 수정하는 규칙을 자바빈 프로퍼티 규약이라고 한다.
필드 주입
외부에서 변경이 불가능해 테스트하기 힘든 단점이 있다. 또한 DI 프레임워크가 없으면 아무것도 할 수 없다. 되도록이면 사용하지 말자.
애플리케이션의 실제 코드와 관계 없는 테스트 코드나 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용한다.
순수한 자바 테스트 코드에는 @Autowired가 동작하지 않는다. @SpringBootTest처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능하다.
일반 메서드 주입
일반 메서드를 통해 주입받을 수도 있으며 한 번에 여러 필드를 주입받을 수 있는 특징이 있다. 하지만 일반적으로는 잘 사용하지 않는다.
의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다. 스프링 빈이 아닌 Member 같은 클래스에서 @Autowired 코드를 적용해도 아무 기능도 동작하지 않는다.
옵션처리
주입할 스프링 빈이 없어도 동작해야 할 때가 있다. 그런데 @Autowired만 사용하면 required옵션의 기본값이 true로 설정되어 있어서 자동 주입대상이 없으면 오류가 발생한다.
자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.
- @Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출되지 않는다.
- @Nullable : 자동 주입할 대상이 없으면 null이 입력된다.
- Optional<> : 자동 주입할 대상이 없으면 Optional.empty가 입력된다.
public class AutowiredTest {
@Test
void AutowiredOption() {
ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
}
static class TestBean {
@Autowired(required = false)
public void setNoBean1(Member noBean1) {
System.out.println("NoBean1 = " + noBean1);
}
@Autowired
public void setNoBean2(@Nullable Member noBean2) {
System.out.println("noBean2 = " + noBean2);
}
@Autowired
public void setNoBean3(Optional<Member> noBean3) {
System.out.println("noBean3 = " + noBean3);
}
}
}
Member는 스프링 빈이 아니므로 출력 결과가 위처럼 나온다. setNoBean1은 호출 자체가 되지 않는 것을 확인할 수 있다. @Nullable, Optional은 스프링 전반에 걸쳐 지원되며 생성자 자동 주입에서 특정 필드에만 사용해도 된다.
생성자 주입으로 선택하기
최근 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다.
불변
대부분의 의존관계 주입은 한 번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려 대부분의 의존 관계는 애플리케이션 종료 전까지 불변이어야 한다.
수정자 주입을 사용하면 setXxx 메서드를 public으로 열어두어야 하며, 이럴 경우 누군가 변경할 수도 있기 때문에 좋은 설계 방법이 아니다. 생성자 주입은 객체를 생성할 때 딱 한 번 호출되므로 이후에 호출되는 일이 없어서 불변을 지키며 설계할 수 있다.
누락
생성자 주입을 사용하면 주입 데이터를 누락했을 때 컴파일 오류가 발생한다. 그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지도 알 수 있다.
final 키워드
생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다. 그래서 생성자에 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다.
java: variable discountPolicy might not have been initialized 컴파일 오류는 세성에서 제일 빠르고 좋은 오류!
생성자 주입 외의 나머지 주입 방식은 모두 생성자 이후에 호출되므로 필드에 final 키워드를 사용할 수 없다. 오직 생성자 주입 방식만 final 키워드를 사용할 수 있다.
롬복
개발을 해보면 대부분이 불변이고 생성자에 final 키워드를 사용하게 된다. 필드 주입처럼 좀 편리하게 사용하는 방법은 없을지 알아보자.
롬복 라이브러리가 제공하는 @RequiredArgsConstructor을 사용하면 final이 붙은 필드를 모아 생성자를 자동으로 만들어준다.
@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
/* @Autowired 생성자가 하나일 경우 Autowired 생략 가능
@RequiredArgsConstructor가 있어서 생성자를 작성해주지 않아도 됨.
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
*/
}
조회 빈이 2개 이상일 때?
@Autowired 필드 명 매칭
@Autowired는 타입 매칭을 시도하고 여러 빈이 있으면 필드 명, 파라미터 명으로 빈 이름을 추가 매칭한다.
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy rateDiscountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = rateDiscountPolicy;
}
필드 명이 rateDiscountPolicy이므로 정상 주입된다.
필드 명 매칭은 먼저 타입 매칭을 시도하고 그 결과에 여러 빈이 있을 때 추가로 동작하는 기능이다.
@Qualifier 사용
@Qualifier는 추가 구분자를 붙여주는 방법이다. 주입 시 추가적인 방법을 제공하며 빈 이름을 변경하는 것은 아니다.
사용 방법은 빈 등록 시 @Qualifier를 붙여주고 주입 시에도 @Qualifier와 등록한 이름을 적어주면 된다.
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {
// ...생략
}
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
@Primary 사용
@Primary는 우선 순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면 @Primary가 우선권을 가진다. @Primary를 사용하면 @Qualifier를 붙일 필요가 없다.
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {
// 생략...
}
코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈과 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션 획득 스프링 빈이 있다고 생각해보자.
메인 데이터 베이스의 커넥션을 획득하는 스프링 빈은 @Primary를 적용해서 편리하게 조회하고, 서브 데이터베이스 커넥션을 획득할 때는 @Qualifier를 지정해서 명시적으로 획득하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.
스프링은 자동보다는 수동이, 넓은 범위 보다는 좁은 범위의 선택권의 우선 순위가 높다. 그래서 @Primary보다 @Qualifier가 우선권이 높다.
애노테이션 직접 만들기
@Qualifier("mainDiscountPolicy") 처럼 문자를 적으면 컴파일 시 타입 체크가 되지 않는다. 이 문제는 애노테이션을 만들어서 해결할 수 있다.
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}
애노테이션을 만들고 @Qualifier 대신 @MainDiscountPolicy 애노테이션을 사용하면 컴파일 오류 동작하는 것을 확인할 수 있다.
조회한 빈이 모두 필요할 때
의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있다.
할인 서비스를 제공하는데 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있을 경우 스프링을 사용하면 전략 패턴을 매우 간단하게 구현할 수 있다.
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);
int rateDiscountPolicy = discountService.discount(member, 20000, "rateDiscountPolicy");
assertThat(rateDiscountPolicy).isEqualTo(2000);
}
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.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);
return discountPolicy.discount(member, price);
}
}
}
DiscountService는 Map으로 모든 DiscountPolicy를 주입 받는다. discount() 메서드는 discountCode로 fixDiscountPolicy나 rateDiscountPolicy가 넘어오면 map에서 스프링 빈을 찾아 실행한다.
Map<String, DiscountPolicy> : map의 키에 스프링 빈의 이름을 넣어주고 그 값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
List<DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다. 만약 해당하는 타입의 스프링 빈이 없으면 빈 컬렉션이나 Map을 주입한다.
자동, 수동의 올바른 실무 운영 기준
편리한 자동 기능을 기본으로 사용하자
스프링이 나오고 점점 자동을 선호하는 추세다. 스프링은 @Component 뿐만 아니라 @Controller, @Service, @Repository처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다.
최근 스프링부트는 컴포넌트 스캔을 기본으로 사용하고 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다. 그리고 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.
그럼 수동 빈 등록은 언제 사용할까?
업무 로직은 숫자도 많고 컨트롤러, 서비스, 리포지토리처럼 어느정도 유사한 패턴이 있으므로 자동 기능을 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.
기술 지원 로직은 수가 적고 보통 애플리케이션 전반에 걸쳐 광범위하게 영향을 미친다. 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 파악하기 어려운 경우가 많기 때문에 가급적으로 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.
애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 설정 정보에 바로 나타나게 하는 것이 유지보수 하기에 좋다.
또한 비즈니스 로직 중에서 다형성을 적극 활용할 때도 수동 빈 등록을 사용하면 좋다.
🐣 출처: 인프런 김영한님 강의
이 글은 인프런의 김영한님 스프링 강의를 보고 작성한 글입니다.
강의를 들으면서 정리한 글이므로 틀린 내용이나 오타가 있을 수 있습니다.