의존관계 자동 주입

금성·2022년 11월 23일

스프링_핵심_원리_기본

목록 보기

7/9

목차

다양한 의존관계 주입 방법

옵션 처리

생성자 주입

롬복과 최신 트렌드

조회 빈이 2개 이상 - 문제

@Autowired 필드명, @Quilifier, @Primary

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

다양한 의존관계 주입 방법

생성자 주입

이름 그대로 생성자를 통해 의존 관계를 주입 받는 방법
지금까지 진행한 방식이 생성자 주입

@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번만 호출되는 것이 보장

생성자가 1개일 경우 @Autowired 생략해도 자동 주입

수정자 주입 (setter 주입)

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;
      }
  }
 ...

선택, 변경 가능성 있는 의존관계에 사용

자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용

자바빈 프로퍼티 규약

필드의 값을 직접 변경하지 않고, setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는 규칙

@ Autowired는 주입할 대상이 없으면 오류가 생김 ( default )
주입할 대상이 없이 동작하게 하려면 required = false로 지정하면 됨

필드 주입

이름 그대로 필드에 바로 주입하는 방법

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

애플리케이션의 실제 코드와 관계 없는 테스트 코드에서 사용

스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

일반 메서드 주입

일반 메서드를 통해서 주입받는 방법

   @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;
       }
   }
...

한번에 여러 필드를 주입 받을 수 있다.

일반적으로 잘 사용하지 않음

옵션 처리

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

@Autowired 만 사용하면 required 옵션의 기본값이 true로 되어 있어서 자동 주입 대상이 없으면 오류가 발생

자동 주입 대상을 옵션으로 처리하는 방법
- @Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨
- org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력
- Optional<> : 자동 주입할 대상이 없으면 Optional.empty 가 입력

test > autowired > AutowiredTest

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는 빈이 아니므로 @Nullable이 없으면 NoSuchBeanDefinitionException 오류 발생.
- setNoBean1() 은 @Autowired(required=false) 이므로 호출 X

생성자 주입

최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장

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

누락

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;
       }
       //...
   }

잘 보면 필수 필드인 discountPolicy 에 값을 설정해야 하는데, 이 부분이 누락되었다. 자바는 컴파일 시점에 다음 오류를 발생

java: variable discountPolicy might not have been initialized

정리
- 생성자 주입 - 프레임워크에 의존하지 않고, 순수 자바 언어의 특징을 살리는 방법
- 기본으론 생성자 주입을 사용, 불변값이 아닌경우 수정자 주입 방식 으로 옵션 선택 ( 동시 사용 가능 )
- 항상 생성자 주입 선택 / 옵션이 필요하면 수정자 / 필드 주입은 X

롬복과 최신 트랜드

막상 개발에서는 99%가 불변이고 그렇기 때문에 필드에 final 키워드를 사용 그러면서 생성자도 만들고,주입 받은 값을 대입하는 코드도 만들어야함 -> 반복작업....

편리하게 도와주는 라이브러리 -> 롬복 ( lombok )

생성자 주입 기본 코드

  @Component
   public class OrderServiceImpl implements OrderService {
       private final MemberRepository memberRepository;
       private final DiscountPolicy discountPolicy;
       
       @Autowired  //생성자가 1개 생략가능
       public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy
               discountPolicy) {
           this.memberRepository = memberRepository;
           this.discountPolicy = discountPolicy;
       }
       ...
   }

생성자가 1개만 있으면 @Autowired를 생략 가능

기본 코드에 롬복 적용 ( 최종 결과 코드 )

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

위 코드와 아래 코드는 완전히 동일

@RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서
생성자를 자동으로 생성 -> 코드 깔끔하게 사용 가능

롬복이 자바의 애노테이션 프로세서라는 기능으로 생성자 코드를 자동으로 생성 해줌

조회 빈이 2개 이상

@Autowired는 Type으로 조회한다.

DiscountPolicy 의 하위 타입인 FixDiscountPolicy , RateDiscountPolicy 둘다 스프링 빈으로 선언해보자.
```
@Component
public class FixDiscountPolicy implements DiscountPolicy {}
```
```
@Component
public class RateDiscountPolicy implements DiscountPolicy {}
```
- 의존관계 주입을 실행하면
- 오류 발생

NoUniqueBeanDefinitionException 오류 발생 - 하나의 빈 기대 했으나 2개 발견

@Autowired 필드명 @Qualifier, @Primary

조회 대상 빈이 2개 이상일 때 해결 방법

@Autowired 필드명 매칭

@Qualifier -> @Qualifier 끼리 매칭 -> 빈 이름 매칭

@Primary 사용

@Autowired 필드명 매칭

@Autowired는 타입 매칭을 시도 하고 여러 빈이 존재하면 파라미터 이름으로 빈 이름을 추가적으로 매칭

@Qualifier 사용

@Qualifier는 추가 구분자를 붙여주는 방법. ( 빈이름을 바꾸는것은 아님 )

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

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

생성자 자동 주입 예시

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

수정자 자동 주입 예시

@Autowired
public DiscountPolicy setDiscountPolic(@Qualifier("mainDiscountPolicy") 
    									DiscountPolicy discountPolicy) {
	this.discountPolicy = discountPolicy;
}

@Qualifier는 @Qualifier를 찾는 용도로만 사용하는것이 명확하고 좋음

@Primary 사용

@Primary는 우선순위를 정하는 방법
@Autowired 시 여러 빈이 매칭 되면 @Primary가 우선권을 가짐

예시

@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 setDiscountPolic(DiscountPolicy discountPolicy) {
	this.discountPolicy = discountPolicy;
}

오류 없이 정상적으로 @Primary가 잘 동작하는 것을 확인

우선 순위
- @Primary 는 기본값 처럼 동작하는 것이고, @Qualifier 는 매우 상세하게 동작
- 스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선
지금까지 보면 @Primary 와 @Qualifier 중에 어떤 것을 사용하면 좋을지 고민이 될 것이다. @Qualifier 의 단점은 주입 받을 때 다음과 같이 모든 코드에 @Qualifier 를 붙여주어야 한다는 점이다.

애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안됨 (문자이기 때문에 오타가 발생해도 동작. 컴파일시 오류가 발생하지 않으나, 실행하면 오류)

main > annotation > MainDiscountPolicy

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

@Qualifier에 있는 내용을 복사해서 MainDiscountPolicy라는 새로운 파일을 생성

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

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

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

의도적으로 해당 타입의 빈이 다 필요한 경우도 존재
예를 들어 할인 서비스를 제공하는데 종류 ( rate, fix )를 선택 할수 있다고 가정해보자.

test > autowired > AllBeanTest

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);
   }
   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);
           System.out.println("discountCode = " + discountCode);
           System.out.println("discountPolicy = " + discountPolicy);
           return discountPolicy.discount(member, price);
       }
   }
}

로직 분석
- DiscountService는 Map으로 모든 DiscountPolicy를 주입 받음 이때 fix와 rate 둘다 주입 됨
- discount ( ) 메서드는 discountCode로 "fix" or "rate"가 넘어오면 map에서 "fix" or "rate" 스프링 빈을 찾아서 실행
주입 분석
- Map< String, DiscountPolicy > : map의 키에 스프링 빈의 이름을 넣어주고, 그값을 DiscountPolicy타입으로 조회한 모든 스프링 빈을 담아줌
- List< DiscountPolicy > : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아줌

금성

내일부터 공부 해야지

이전 포스트

컴포넌트 스캔

다음 포스트

의존관계 자동 주입

스프링_핵심_원리_기본

다양한 의존관계 주입 방법

생성자 주입

수정자 주입 (setter 주입)

자바빈 프로퍼티 규약

필드 주입

일반 메서드 주입

옵션 처리

자동 주입 대상을 옵션으로 처리하는 방법

생성자 주입

불변

누락

final 키워드

롬복과 최신 트랜드

조회 빈이 2개 이상

@Autowired 필드명 @Qualifier, @Primary

@Autowired 필드명 매칭

@Qualifier 사용

@Primary 사용

우선 순위

애노테이션 직접 만들기

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

컴포넌트 스캔

빈 생명주기 콜백

0개의 댓글