김영한 선생님의 스프링 핵심 원리 - 기본편 강의를 듣고 정리하였습니다.
의존관계 자동 주입에는 다음의 방법들이 있다.
생성자를 통해 의존관계를 주입받는다.
@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;
}
}
스프링빈은 크게 1) 스프링 빈을 생성하는 단계, 2) @Autowired
애노테이션이 걸린 것들을 자동으로 주입한다.
setter라 불리는 필드의 값을 변경하는 수정자 메서를 통해 의존관계를 주입한다.
+) 수정자 주입 시, final
을 사용할 수 없다. final
로 선언된 변수는 반드시 선언과 함께 초기화 되어야 하므로 setter 주입과 같이 의존관계를 주입할 때는 final 선언을 할 수 없다.
@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;
}
}
필드에서 바로 주입하는 방식이다. 필드 주입은 권장하지 않는다.
Product product = new Pencil(); Store store = new Store(product);
처럼 두 객체 간에 관계(의존성)를 맺어주는 것을 말한다.@Configuration
같은 곳에서만 특별한 용도로 사용한다.@Component
public class OrderServiceImpl implements OrderService {
@Autowired
private MemberRepository memberRepository;
@Autowired
private DiscountPolicy discountPolicy;
}
일반 메서드를 통해서 한번에 여러 필드를 주입받을 수 있다. 일반적으로 잘 사용하지 않는다.
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public init(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}
+) 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다.
스프링 빈은 주입하는 것이 자동 로직으로 되어있지만, 주입할 스프링 빈이 없어도 동작해야 할 때가 있다.
@Autowired
는 required
옵션의 기본값이 true
로 되어있어 자동주입 대상이 없다면 오류가 발생한다. 자동 주입 여부는 다음 방법과 같이 옵션으로 처리할 수 있다.
@Autowired(required=false)
: 자동 주입할 대상이 없으면 수정자 메서드가 호출되지 않는다.org.springframework.lang.@Nullable
: 자동 주입할 대상이 없으면 null이 입력된다.Optional<>
: 자동 주입할 대상이 없으면 Optinal.empty
가 입력된다.import hello.core.member.Member;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.lang.Nullable;
import java.util.Optional;
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 // 호출은 되지만 null로 들어온다.
public void setNoBean2(@Nullable Member noBean2) {
System.out.println("noBean2 = " + noBean2);
}
@Autowired
public void setNoBean3(Optional<Member> noBean3) {
System.out.println("noBean3 = " + noBean3);
}
}
}
/* 결과
noBean2 = null
noBean3 = Optional.empty
*/
대부분 DI 프레임워크는 다음과 같은 이유로 생성자 주입을 사용할 것을 권장한다.
의존관계는 애플리케이션 종료 전까지 변하면 안된다. 생성자 주입은 객체 생성 시, 딱 1번만 호출되고 이후에 호출되지 않아 불변하게 설계할 수 있다.
수정자 주입을 사용하면, setXxx 메서드를 public으로 열어두기 때문에 변경될 수 있다는 위험성이 있다. 실수로 변경할 수 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.
프레임워크 없이 순수한 자바 코드를 단위 테스트하는 경우에, 의존관계 누락이 발생할 수 있다.
수정자 의존 관계를 사용한 경우
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
가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만, 프레임워크 없이 순수한 자바 코드로만 단위 테스트를 수행한다.
만약 다음과 같이 테스트를 수행한다면, 컴파일 오류가 없기 때문에 실행 시도는 될 것이다.
@Test
void createOrder() {
OrderServiceImpl orderService = new OrderServiceImpl();
orderService.createOrder(1L, "itemA", 10000);
}
실행 결과를 보면 NPE(Null Point Exception)이 발생한다. 이유는 memberRepository
, discountPolicy
모두 의존관계 주입이 누락되었기 때문이다.
생성자 주입을 사용하면 다음처럼 주입 데이터를 누락했을 때, 컴파일 오류가 발생한다. 따라서 IDE에서 테스트 실행 전, 어떤 값을 필수로 주입해야 하는지 알 수 있다.
void createOrder() {
OrderServiceImpl orderService = new OrderServiceImpl(); // 컴파일 오류 발생!!!
orderService.createOrder(1L, "itemA", 10000);
}
생성자 주입을 사용하면 필드에 final
키워드를 사용할 수 있다. 따라서 생성자에 혹시라도 값이 설정되지 않을 때 발생하는 오류를 컴파일 시점에서 막아준다.
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPoliciy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
}
...
}
OrderServiceImpl
생성자를 보면, 필수 필드인 discountPolicy
에 값이 설정되어 있지않다. 자바는 컴파일 시점에 다음 java: variable discountPolicy might not have been initialized
와 같은 컴파일 오류를 발생시킬 것이다.
그런데 final
키워드는 왜 사용이 불가할까?
수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출된다. 따라서 필드에 final
키워드를 사용할 수 없다. 오직 생성자 주입 방식은 생성과 동시에 주입할 수 있으므로 final
키워드를 사용할 수 있다.
Summary
- 생성자 주입 방식을 선택하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고 순수한 자바 언어의 특징을 잘 살리는 방법이기도 하다.
- 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에만 수정자 주입 방식을 옵션으로 부여하면 된다. 생성자 주입과 수정자 주입을 유연하게 동시에 사용한다.
- 일단 생성자 주입을 선택하고, 옵션이 필요하면 수정자 주입을 사용한다. 필드 주입은 사용하지 않는다.
Lombok은 Java 언어를 통한 개발 시 기계적으로 작성해야하는 코드들을 자동화해주는 필수 라이브러리이다.
장점
@Getter
, @Setter
@AllArgsConstructor
@NoArgsConstructor
@RequiredArgsConstructor
@NonNull
애노테이션을 붙여서 해당 변수를 생성자의 인자로 추가한다.final
로 선언하여 의존성 주입을 받는다.@EqualsAndHashCode
@EqualsAndHashCode(of = {"nameA", "nameB"}, callSuper = false)
public class USer extends Common {
@NonNull
private String nameA;
@NonNull
private String nameB;
}
nameA와 nameB가 동일하다면, 같은 객체로 인식하도록 해주었다. 또한 Common을 상속하고 있는데, 상위 클래스의 경우 적용시키지 않기 위해 callSuper=flase로 지정한다. @ToString
@ToString.Exclude
애노테이션을 붙이면 출력을 제외한다. 또한 상위 클래스에도 toString을 적용하고자한다면 상위 클래스에 @ToString(callSuper = true)
를 적용시킨다.@Data
@ToString
, @EqualsAndHashCode
, @Getter
, @Setter
, @RequiredArgsConstructor
를 자동완성 시켜준다. 무겁고, 객체 안정성을 지키기 위해 활용을 지양한다.@Builder
@Delegate
// 기존의 작성 방식
store.getReviewList().add(review);
// @Delegate를 활용한 방식
store.add(review);
@Log
관련 어노테이션기존코드
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
this.memberReository = memberRepository;
this.discountPolicy = discountPolicy;
}
}
Lombok 적용
@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
}
이처럼 Lombok을 사용하여 코드를 간결하게 작성할 수 있다. 이러한 코드는 롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해주기 때문에 가능하다.
Summary
최근에는 생성자를 딱 1개 두고,@Autowired
를 생략하는 방법을 주로 사용한다. 또한 Lombok라이브러리를 사용하면 필요한 기능들은 모두 제공받고, 코드는 깔끔하게 작성할 수 있다.
@Autowired
는 타입으로 빈을 조회한다. 스프링 빈 조회에서 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.
예를 들어, DiscountPolicy
의 하위 타입인 FixDiscountPolicy
와 RateDiscountPolicy
둘다 스프링 빈으로 선언한다. 만약 두 정책 모두 @Component
어노테이션으로 @Bean
에 등록되었다면 의존관계 자동 주입을 하여 오류가 발생한다.
@Component
public class FixDiscountPolicy implements DiscountPolicy {}
@Component
public class RateDiscountPolicy implements DiscountPolicy {}
그리고 의존관계 자동 주입을 실행한다.
@Autowired
private DiscountPolicy discountPollicy;
확인해보면 NoUniqueBeanDefinitionException
오류가 발생하며, 어떤 곳에서 발생하였는지 친절하게 알려준다.
이를 하위 타입으로 지정할 수도 있지만, 하위 타입으로 지정한다면 DIP를 위배하고 유연성이 떨어진다. 이름만 다르고, 똑같은 하위 타입의 스프링 빈이 두개 있어 발생하는 문제는 어떻게 해결할 수 있을까? 스프링 빈을 수동 등록해서 문제를 해결할 수 도 있지만, 의존 관계 자동주입에는 이 외에도 여러 해결 방법들이 있다.
조회 대상 빈이 2개 이상이라면 다음과 같은 방법으로 해결할 수 있다.
@Autowired
필드 명 매칭@Qualifier
사용@Primary
사용@Autowired
는 타입 매칭을 시도하고, 여러 빈이 있으면 필드 이름과 파라미터 이름으로 빈 이름을 추가 매칭한다.
기존 코드
@Autowired
private DiscountPolicy discountPolicy
필드명을 이름으로 변경
@Autowired
private DiscountPolicy rateDiscountPolicy
필드명이 rateDiscountPolicy이므로 정상주입된다. 필드명 매칭은 타입 매칭을 시도하고, 결과에 여러 빈이 있을 때 추가 동작한다.
Summary
1. 타입 매칭을 진행한다.
2. 타입 매칭의 결과가 두 개 이상일 때, 필드명과 파라미터명으로 빈 이름을 매칭한다.
추가 구분자를 붙여주는 방법으로, 주입 시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.
@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;
}
수정자 자동 주입 예시
@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
return discountPolicy;
}
직접 빈 등록 예시
@Bean
@Qualifier("mainDiscountPolicy")
public DiscountPolicy discountPolicy() {
return new ...
}
@Qualifier
주입 시, @Qualifier("mainDiscountPolicy")
를 찾지 못하면, mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. 만약 찾지 못하면 NoSuchBeanDefinitionException
예외가 발생한다.
하지만, @Qualifer
는 @Qualifier
를 찾는 용도로만 사용하는게 좋다.
@Primary
우선권을 갖는다. 일단 @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
를 적용하면, 조회하는 곳에서 @Qualifier
지정 없이 편리하게 조회할 수 있다. 스프링 빈 등록 시, @Qualifier
를 지정해줘도 된다.
서브데이터베이스 커넥션 빈을 획득할 때는 @Qualifier
를 지정해서 명시적으로 획득하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.
둘의 우선 순위는 다음과 같다.
@Primary
는 기본값처럼 동작하고, @Qualifier
는 상세하게 동작한다. 스프링은 자동보다는 수동이, 넓은 범위의 선택권보다 좁은 범위의 선택권이 우선 순위가 높기 때문에 @Qualifier
가 우선순위가 높다.
문자는 컴파일 타임에 오타 등을 감지할 수 없다.
예를 들어 @Qualifier("mailDiscountPolicy")
처럼 문자를 적으면 컴파일시 타입 체크가 안된다. 따라서 다음처럼 애노테이션을 만들어 문제를 해결할 수 있다.
package hello.core.annotation;
import org.springframework.beans.factory.annotation.Qualifier;
import java.lang.annotation.*;
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, 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
뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다.
의도적으로 해당 타입의 스프링 빈이 필요한 경우, 스프링을 사용하면 전략 패턴을 간단하게 구현할 수 있다.
ex. 클라이언트가 할인의 종류(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.Assertions;
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(discountPrice).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);
return discountPolicy.discount(member, price);
}
}
}
로직 분석
DiscountPolicy
를 주입받는다. 이때 fixDiscountPolicy
, rateDiscountPolicy
가 주입된다.discount()
메서드는 discountCode로 fixDiscountPolicy
가 넘어오면 map에서 fixDiscountPolicy
스프링 빈을 찾아 실행한다. rateDiscountPolicy
가 넘어오면, rateDiscountPolicy
스프링 빈을 찾아 실행한다.주입 분석
Map<String, DiscountPolicy>
DiscountPolicy
타입으로 조회한 모든 스프링 빈을 담아준다.List<DiscountPolicy>
DiscountPolicy
타입으로 조회한 모든 스프링 빈을 담아준다.편리한 자동 기능을 기본으로 사용하자.
수동 빈 등록은 언제 하는게 좋을까?
애플리케이션은 업무 로직과 기술 지원 로직으로 나눌 수 있다.
비즈니스 로직 등에서 다형성을 활용할 때
조회한 빈이 모두 필요한 경우, 어떤 빈들이 주입될지 각 빈들의 이름을 무엇으로 할지 코드로 한번에 파악하기 어렵다. 자동 등록을 사용하면 여러 코드를 찾아봐야 한다.
이때 한번에 이해할 수 있도록, 수동 빈으로 등록하거나 자동으로 한다면 특정 패키지에 같이 묶어 둔다.
@Configuration
public class DiscountPolicyConfig {
@Bean
public DiscountPolicy rateDiscountPolicy() {
return new RateDiscountPolicy();
}
@Bean
public DiscountPolicy fixDiscountPolicy() {
return new FixDiscountPolicy();
}
}
설정 정보만 봐도 빈의 이름고, 어떤 빈들이 주입될지 파악할 수 있다. 만약 빈 자동 등록을 하고 싶으면, DiscountPolicy
의 구현 빈들을 따로 모아 특정 패키지에 모아둔다. 한눈에 보이면, 빼고 더해야하는 것들을 바로 파악할 수 있어 유지보수에 도움된다.
+) 스프링과 스프링 부트가 자동으로 등록하는 빈들은, 스프링 자체를 잘 이해하고 의도대로 사용한다. 반면에 스프링 부트가 아닌 직접 기술 지원 객체를 스프링 빈으로 등록한다면, 수동으로 등록해서 명확하게 나타낸다.
Summary
- 편리한 자동 기능을 기본으로 사용한다.
- 직접 등록하는 기술 지원 객체는 수동 등록한다.
- 다형성을 적극 활용하는 비즈니스 로직을 수동 로직을 고려한다.
Reference