다양한 의존관계 주입 방법
1. 생성자 주입
2. 수정자 주입
3. 필드 주입
4. 일반 메서드 주입
생성자 주입
이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법
특징
-> 생성자 호출시점에 딱 1번만 호출되는 것이 보장
-> 불변 필수 의존관계에 사용
@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 생략 가능
수정자 주입
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) 지정
+) 자바빈 프로퍼티 규약이란? => setXXX, getXXX
필드 주입
이름 그대로 필드에 바로 주입하는 것
특징
-> 코드가 간결해서 좋아 보이지만, 외부에서 변경이 불가능해서 test 하기 어려움
-> DI framework X -> 아무것도 할 수 없음
-> 사용하지 말자!!!!
애플리케이션의 실제 코드와 관련 없는 테스트 코드
스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용
@Component
public class OrderServiceImpl implements OrderService {
@Autowired
private MemberRepository memberRepository;
@Autowired
private DiscountPolicy discountPolicy;
}순수한 자바 테스트 코드에서는 당연히 @Autowired 작동X, SpringbootTest 처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능
@Bean에서 파라미터에 의존관계는 자동 주입, 수동 등록시 자동 등록된 빈의 의존관계가 필요할 때 문제를 해결 가능
@Bean
OrderService orderService(MemberRepository memberRepoisitory, DiscountPolicy
discountPolicy) {
new OrderServiceImpl(memberRepository, discountPolicy)
}일반 메서드 주입
일반 메서드를 통해서 주입 받을 수 있다
특징
-> 한번에 여러 필드를 주입 받을 수 있다.
-> 일반적으로 사용 X
@Component
public class OrderServiceImpl implements OrderService {
private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;
@Autowired
public void init(MemberRepository memberRepository, DiscountPolicy
discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}Option 처리
주입할 스프링 빈이 없어도 동작해야 할 때가 있다.
@Autowired만 사용하면 required 옵션의 기본 값이 true이기 때문에 자동주입 대상이 없다면 오류가 발생한다.
자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다
Autowired(required = false) : 자동 주입할 대상이 없다면, 수정자 메서드 자체 호출 X
org.springframework.lang.@Nullable : 자동 주입 대상이 없다면 null 입력
Optional<> : 자동 주입 대상이 없다면 Optional.empty가 입력
//호출 안됨
@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> member) {
System.out.println("setNoBean3 = " + member);
}setNoBean1은 @Autowired(required = false) => 호출 자체 X
생성자 주입을 선택하자 !!!
왜???
1. 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지의 의존관계를 변경할 일이
없다. 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 X
2. 수정자 주입을 사용하면 setXXX -> public 하게 열어두어야 한다.
3. 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법X
4. 생성자 주입은 객체를 생성할 때 딱 한번만 호출됨, 이후에 호출되는 일 X
누락
프레임워크 없이 순수한 자바코드를 테스트하는 경우
수정자 의존관계인 경우
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가 framework 안에서 동작할때는 의존관계가 없으면 Error, 지금은 framework 없이 순수한 자바 코드만으로 단위 테스트 수행
@Test
void createOrder() {
OrderServiceImpl orderService = new OrderServiceImpl();
orderService.createOrder(1L, "itemA", 10000);
}=> NullPointException -> memberRepository, discountPolicy 모두 의존관계 주입이 누락
but 생성자 주입을 사용하면 주입 데이터를 누락시, Compile 시점에 잡을 수 있다.
final 키워드
생성자 주입을 사용하면 필드에 final 키워드를 사용, 생성자에서 혹시라도 값이 설정 X -> 컴피일 시점에서 막아준다.
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy
discountPolicy) {
this.memberRepository = memberRepository;
}
//...
}잘 보면 필수 필드인 discountPolicy 에 값을 설정해야 하는데, 이 부분이 누락되었다. 자바는 컴파일 시점에 다음 오류를 발생시킨다.
java: variable discountPolicy might not have been initialized
기억하자! 컴파일 오류는 세상에서 가장 빠르고, 좋은 오류다!
롬복과 최신 트렌드
@RequiredArgsConstructor기능을 사용하면 final 붙은 필드를 모아서 생성자를 자동으로 형성,
@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
}조회 빈이 2개 이상 -> 문제
@Autowired는 타입으로 조회
@Autowired
private DiscountPolicy discountPolicy스프링 빈 조회에서 학습했듯 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제 발생
DisountPolicy의 하위 타입인 Fix, Rate 둘다 스프링 빈으로 선택.
@Component
public class FixDiscountPolicy implements DiscountPolicy {}@Component
public class RateDiscountPolicy implements DiscountPolicy {}의존관계 주입을 실행
@Autowired
private DiscountPolicy discountPolicy결과
NoUniqueBeanDefinitionException 오류가 발생한다
하위 타입을 지정하면 유연성이 떨어진다.
@Autowired 필드명, @Qualifier, @Primary
조회 대상 빈이 2개 이상,
@Autowired 필드 명 매칭
@Qualifier -> @Qualifier 끼리 매칭 -> 빈 이름 매칭
@Primary
@Autowired 필드 명 매칭
@Autowired는 타입 매칭을 시도, 여러 빈이 있다면, 필드 이름, 파라미터 이름으로 빈 이름 추가 매칭
//필드 명을 빈 이름으로 변경
@Autowired
private DiscountPolicy rateDiscountPolicy필드명이 rateDisocountPolicy -> 정상 주입
필드명 매칭은 먼저 타입 매칭을 시도, 결과에 여러 빈이 있을 때 추가로 동작
@Autowired 매칭 정리
1. 타입 매칭
2. 타입 매칭 결과가 2개 이상 일때, 파라미터명으로 빈 이름 매칭
@Qualifier 사용
@Qualifier는 추가 구분자를 붙여주는 방법. 주입시 추가적인 방법을 제공, 빈 이름 변경 X
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}주입시 @Qualifier를 붙여주고 등록한 이름을 적어준다.
생성자 자동 주입 예시
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
@Qualifier("mainDiscountPolicy") DisocountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}수정자 자동 주입 예시
@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy")
DiscountPolicy discountPolicy) {
this.discountPolicy = discountPolicy;
}@Qulifier로 주입할때 @Qualifier("mainDisountPolicy")를 못찾는다면??
mainDisocountPolicy라는 이름의 스프링 빈을 추가로 찾는다.
하지만 @Qulifier는 @Qulifier를 찾는 용도로만 사용하는 것을 추천
@Qualifier 정리
1. @Qualifier끼리 매칭
2. 빈 이름 매칭
3. NoSuchBeanDefinitionException 예외 발생
@Primary 사용
우선순위를 정하는 방법, @Autowired 시에 여러 빈이 매칭된다면 @Primary가 우선권을 갖는다.
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}
@Component
public class FixDiscountPolicy implements DiscountPolicy {}
RateDiscountPolicy가 우선권을 갖는다.
@Qualifier의 단점은 주입시 모든 코드에 @Qualifier를 붙여주어야 한다.
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}@Primary 사용 -> @Qualifier를 붙일 필요 X
@Primary, @Qualifier 활용
코드에서 주로 사용하는 메인 DB Connection을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능으로 가끔 사용하는 subDB Connection을 획득하는 스프링 빈이 있다.
메인 DB connection을 획득하는 스프링 빈 @Primary를 적용해서 조회하는 곳어세 @Qualifirer지정 없이 편리하게 조회, subDB Connection 빈을 획득할 때는 @Qualifirer을 지정해서 명시적으로 획득하는 방식으로 사용.
애노테이션 직접 생성
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@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) {
this.discountPolicy = discountPolicy;
}애노테이션에는 상속이라는 개념 X, 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원
조회한 빈이 모두 필요할 때, List, Map
의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우가 있다.
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", VIP);
int discountPrice = discountService.discount(member, 1000, "fixDiscountPolicy");
assertThat(discountService).isInstanceOf(DiscountService.class);
assertThat(discountPrice).isEqualTo(1000);
}
static class DiscountService {
//Map의 경우 키의 값에 해당 하는 값들을 넣어주고
private final Map<String, DiscountPolicy> policyMap; //DiscountService -> Map으로 모든 DiscountPolicy 주입 (rate, fix)
//List의 경우 모든 값을 넣어준다.
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);
System.out.println("discountCode = " + discountCode);
System.out.println("discountPolicy = " + discountPolicy);
return discountPolicy.discount(member, price);
}
}
}로직 분석
DiscountService는 Map으로 모든 DiscountPolicy를 주입, fixDiscountPolicy, rateDiscountPolicy 주입
discount() 매서드는 discountCode로 fixDiscountPolicy가 넘어오면 map에서 fixDiscountPolicy 스프링 빈을 찾아서 실행한다.
물론 “rateDiscountPolicy”가 넘어오면 rateDiscountPolicy 스프링 빈을 찾아서 실행한다
주입 분석
Map <String, DiscountPolicy>
map의 키에 스프링 빈 이름 넣어주고ㅡ 그 값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
List< DiscountPolicy >
DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담는다.
만약 해당 타입X -> 빈 컬렉션이나 Mapdmf wndlq
참고)
스프링 컨테이너를 생성하면서 스프링 빈 등록
스프링 컨테이너는 생성자 클래스 정보를 받는다. 여기에 클래스 정보를 넘기면 해당 클래스가 스프링 빈으로 자동 등록
new AnnotationConfigApplicationContext(AutoAppConfig.class,DiscountService.class);두가지로 이해 할 수 있다.
new AnnotationConfigApplicationContext()를 통해 스프링 컨테이너를 생성
AutoAppConfig.class , DiscountService.class를 파라미터로 넘기면서 해당 클래스를 자동으로 스프링 빈 등록
자동, 수동 올바른 실무 운영 기준
편리한 자동기능을 기본을 사용
스프링은 @Component 뿐만 아니라 @Controller, Service, Repository 처럼 계층에 맞춰진 일반적이 애플리케이션 로직을 자동으로 scan,
스프링 부트는 컴포넌트 스캔을 기본으로 사용, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동을 등록하도록 설계
개발자 입장에서 스프링 빈을 하나 등록할 때 @Component 만 넣어주면 끝나는 일을
@Configuration 설정 정보에 가서 @Bean 을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정은 상당히 번거롭다.
또 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 된다.
그리고 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.
그렇다면 수동 빈은 언제 사용??
애플리케이션은 업무 로직과 기술 로직
업무 로직 빈 : 웹을 지원하는 컨트롤러, 비즈니스 로직, 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등이 모두 업무 로직
기술 로긱 빈 : 기술적 문제나, AOP를 처리할때 주로 사용, DB 연결, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 기술, 공통 기술 처럼 업무로직을 지원하기 위한 하부 기술이나 공통 기술들 있다.
업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.
기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다. 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 드러나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.
비즈니스 로직중 다형석 적극활용
의존관계 자동 주입 - 조회한 빈이 모두 필요할 때, List, Map을 다시 보자.
DiscountService 가 의존관계 자동 주입으로 Map<String, DiscountPolicy> 에 주입을 받는 상황을 생각해보자. 여기에 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일지 코드만 보고 한번에 쉽게 파악할 수 있을까?
내가 개발했으니 크게 관계가 없지만, 만약 이 코드를 다른 개발자가 개발해서 나에게 준 것이라면
어떨까?
자동 등록을 사용하고 있기 때문에 파악하려면 여러 코드를 찾아봐야 한다
이런 경우 수동 빈으로 등록하거나 또는 자동으로하면 특정 패키지에 같이 묶어두는게 좋다! 핵심은 딱 보고 이해가 되어야 한다
