다양한 의존관계 주입 방법
의존관계 주입은 크게 4가지 방법이 있다.
1. 생성자 주입
2. 수정자 주입(setter 주입)
3. 필드 주입
4. 일반 메서드 주입
생성자 주입
@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;
}
위의 경우가 생성자 주입이 일어나는 상황이라고 보면 됨.
불변
생성자를 통해서만 의존관계가 주입되고, 그 이후로는 외부에서 절대 수정할 수 없음.
DiscountPolicy 역시 애플리케이션 조립 시에만 값이 들어오고 그 이후로는 고정
필수
생성자에는 값을 집어넣어야 한다.
수정자 주입(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;
}
이러한 방식이 수정자 주입
스프링 컨테이너에는 2가지 라이프 사이클이 있는데, 하나는 스프링 빈을 등록하는 것이고 그 다음이 연관관계를 자동으로 주입하는 것이다. - Autowired가 달린 것들을 자동으로 주입해 주는 것
생성자 주입의 경우에는 스프링이 OrderServiceImpl 객체를 생성해서 빈에 등록하려면 생성자를 호출하게 되고, 이 때 의존관계가 주입된다. 그래서 생성자 주입은 스프링 빈을 등록할 때 주입이 함께 일어나게 된다.
그 반면 수정자 주입 등은 2번째 단계에서 의존관계가 주입된다.
필드 주입
이름 그대로 필드에 그대로 주입하는 방법
일반 메서드 주입
아무 메서드에나 @Autowired를 붙일 수 있음
일반 메서드를 통해서 주입 받을 수 있다.
특징으로는 한번에 여러 필드를 주입 받을 수 있다는 점이 있는데, 보통 생성자 주입이나, 수정자 주입 안에서 다 처리할 수 있기 때문에 일반 메서드 주입을 사용하는 일은 거의 존재하지 않는다.
@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;
}
옵션 처리
public class AutowiredTest {
@Test
void autowiredOption(){
ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
}
static class TestBean{
//호출 안됨
@Autowired(required = false) //이렇게 해두면 의존관계가 없을 때 메서드 호출 자체가 안됨
public void setNoBean1(Member noBean1){
//Member - 스프링 컨테이너가 관리하는 빈 아님
//그냥 없는걸 집어넣었다고 생각
System.out.println("noBean1 = " + noBean1);
}
//null 호출
@Autowired
public void setNoBean2(@Nullable Member noBean2){
System.out.println("noBean2 = " + noBean2);
}
//Optional.empty 호출
@Autowired
public void setNoBean3(Optional<Member> noBean3){
System.out.println("noBean3 = " + noBean3);
}
}
}
참고: @Nullable, Optional은 스프링 전반에 걸쳐서 지원된다. 예를 들어서 생성자 자동 주입에서 특정 필드에만 사용해도 된다.
생성자 주입을 선택해라!
@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 가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만, 지금은 프레임워크
없이 순수한 자바 코드로만 단위 테스트를 수행하고 있다.
class OrderServiceImplTest {
@Test
void creatorOrder(){
OrderServiceImpl orderService = new OrderServiceImpl();
orderService.createOrder(1L, "itemA", 10000);
}
}
이렇게 코드를 짜고 테스트를 하면 실행은 된다. 하지만 실행 결과는 NPE(Null Point Exception)이 발생하는데, memberRepository, discountPolicy 모두 의존관계 주입이 누락되었기 때문이다.
생성자 주입을 사용하면 다음처럼 주입 데이터를 누락 했을 때 컴파일 오류가 발생한다. 그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.
class OrderServiceImplTest {
@Test
void creatorOrder(){
OrderServiceImpl orderService = new OrderServiceImpl(new MemoryMemberRepository(), new RateDiscountPolicy());
orderService.createOrder(1L, "itemA", 10000);
}
}
생성자 주입을 사용하면 위처럼 생성자에 값을 넣어서 테스트를 실행해 볼 수 있다.
final 키워드
또 생성자 주입을 사용하면 좋은 것이 final 키워드를 사용할 수 있다. 그래서 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다. 다음 코드를 보자.
@Component
public class OrderServiceImpl implements OrderService{
private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
// this.memberRepository = memberRepository;
// this.discountPolicy = discountPolicy;
}
final을 넣어주지 않으면 위의 단계에서 컴파일 오류를 잡아주지 않는다. 하지만 필드에 final을 사용해주면 생성자 안에서 값이 빠진 것을 표시해준다. (this가 빠진 것)
수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를 사용할 수 없다. 오직 생성자 주입 방식만 final 키워드를 사용할 수 있다.
롬복과 최신 트랜드
기본 코드
@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;
}
최종 코드
@Component
@RequiredArgsConstructor //필수값인 final이 붙은 것으로 생성자를 만들어줌
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
//이 생성자를 @RequiredArgsConstructor로 대신 생성함
// @Autowired
// public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
// this.memberRepository = memberRepository;
// this.discountPolicy = discountPolicy;
// }
이 최종결과 코드와 이전의 코드는 완전히 동일하다. 롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해준다. 실제 class 를 열어보면 다음 코드가 추가되어 있는 것을 확인할 수 있다.
롬복 라이브러리 적용 방법
build.gradle 에 라이브러리 및 환경 추가
plugins {
id 'org.springframework.boot' version '2.7.0'
id 'io.spring.dependency-management' version '1.0.11.RELEASE'
id 'java'
}
group = 'hello'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'
//lombok 설정 추가 시작
configurations {
compileOnly {
extendsFrom annotationProcessor
}
}
//lombok 설정 추가 끝
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter'
//lombok 라이브러리 추가 시작
compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
testCompileOnly 'org.projectlombok:lombok'
testAnnotationProcessor 'org.projectlombok:lombok'
//lombok 라이브러리 추가 끝
testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
tasks.named('test') {
useJUnitPlatform()
}
1. Preferences(윈도우 File Settings) plugin lombok 검색 설치 실행 (재시작)
2. Preferences Annotation Processors 검색 Enable annotation processing 체크 (재시작)
3. 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인
@Getter
@Setter
@ToString
//롬복은 어노테이션을 통해서 생성자 관련된 것, getter, setter메서드 등 여러가지를 자동으로 만들어주는 것
public class HelloLombok {
private String name;
private int age;
public static void main(String[] args) {
HelloLombok helloLombok = new HelloLombok();
helloLombok.setName("asdf");
String name = helloLombok.getName();
System.out.println("helloLombok = " + helloLombok);
}
}
조회 빈이 2개 이상일 때의 문제
//정액 할인 정책
@Component
public class FixDiscountPolicy implements DiscountPolicy{//정률할인
@Component
public class RateDiscountPolicy implements DiscountPolicy{
@Autowired 필드 명, @Qualifier, @Primary
@Autowired 필드 명 매칭
@Autowired 는 타입 매칭을 시도하고, 이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.
기존 코드
private final DiscountPolicy discountPolicy;
현재는 DiscountPolicy에 같은 타입의 2가지 빈이 존재한다.
필드 명을 빈 이름으로 변경
private final DiscountPolicy rateDiscountPolicy;
파라미터 이름으로 빈 이름 매칭
@Component
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy rateDiscountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = rateDiscountPolicy;
}
@Qualifier 사용
@Qualifier 는 추가 구분자를 붙여주는 방법이다. 주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy{
이런 식으로 원하는 이름을 설정해서 어노테이션을 붙이고,
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
이런식으로 넣어주면 된다.
위에서는 생성자에 넣어주는 예시였고, 수정자에 주입해줄 때에도 그냥 파라미터 넣는 것에 위와 같이 어노테이션을 붙여서
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy")
이런식으로 만들어주면 된다.
@Qualifier 로 주입할 때 @Qualifier("mainDiscountPolicy") 를 못찾으면 어떻게 될까? 그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.
@Qualifier 는@Qualifier 를 찾는 용도로만 사용하는게 명확하고 좋다.(이 어노테이션을 쓰는 애들끼리만 사용하는게 명확하고 좋음)
@Primary 사용
@Primary 는 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면 @Primary 가 우선권을 가진다.
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy{
정액 할인 말고 정률할인에 위와 같이 어노테이션을 달아주면 RateDiscountPolicy를 우선순위로 두고 의존관계를 주입시켜 준다.
어노테이션 직접 만들기
어노테이션 생성
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}
정률 할인에 어노테이션 붙여줌
@MainDiscountPolicy //내가 만든 어노테이션, 가져다 쓰는 곳에도 얘를 붙여줘야 함
public class RateDiscountPolicy implements DiscountPolicy{
생성자에서 사용
@Component
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @MainDiscountPolicy DiscountPolicy discountPolicy) {
@Primary로 해결이 된다면 그냥 @Primary 사용하는게 편함
조회한 빈이 모두 필요할 때, 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", Grade.Vip);
int discountPrice = discountService.discount(member,10000,"fixDiscountPolicy");
assertThat(discountService).isInstanceOf(DiscountService.class);
assertThat(discountPrice).isEqualTo(1000);
int rateDiscountPrice = discountService.discount(member,20000,"rateDiscountPolicy");
assertThat(rateDiscountPrice).isEqualTo(2000);
}
//Map으로 모든 DiscountPolicy를 주입받음(2개) - 생성자를 통해서
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);
}
//discountCode로 "fixDiscountPolicy"가 넘어오면
//map에서 찾아서 key가 fixDiscountPolicy인 빈을 찾아서 실행
public int discount(Member member, int price, String discountCode) {
DiscountPolicy discountPolicy = policyMap.get(discountCode);//discountCode : fixDiscount
return discountPolicy.discount(member, price);
}
}
}
자동, 수동의 올바른 실무 운영 기준
static class DiscountService{
private final Map<String, DiscountPolicy> policyMap;
private final List<DiscountPolicy> policies;
@Autowired
public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies) {
위의 코드를 별도의 설정 정보로 만들고 수동으로 등록하면
이와 같이 나타낼 수 있는데, 이렇게 하면 DiscountPolicy와 관련된 것들이 무엇이 있는지 한눈에 볼 수 있다.
