스프링 핵심 원리 - 의존관계 자동주입 — 들숨에 건강을 날숨에 재력을

※ 본 포스팅은 21.11.08에 게시된 글을 이전한 것 입니다.

1. 의존관계 주입 방법

의존관계 주입은 크게 생성자 주입, 수정장 주입, 필드 주입, 일반 메서드 주입으로 4가지 방법이 있다.

1) 생성자 주입

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

※ 특징 : 생성자 호출 시점에 딱 1번 호출을 보장하며 불변, 필수 의존 관계에 사용

생성자가 딱 한 개만 있다면 @Autowired를 생략해도 자동 주입이 된다.(스프링 빈에만 해당)

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

2) 수정자 주입 (setter 주입)

setter라고 불리는 필드의 값을 변경하는 수정자 매서드를 통해 의존관계를 주입하는 방식

이는 스프링 빈을 생성한 후 @Autowired를 보고 연관관계가 주입된다.(생성자 주입은 이런 형식이 x)

※ 특징 :선택, 변경 가능성이 있는 의존 간계에 사용

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

※ 자바 빈 프로퍼티란?

자바에서는 필드값을 직접 변경하지 않고 get / set을 이용하여 값을 읽거나 수정하는 규칙을 만들었다. 이를 자바 빈 프로퍼티라 일컫는다.

public class OrderServiceImpl implements OrderService{

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

    @Autowired
    public setMeberRepository(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    @Autowired
    public setDiscountPolicy(DiscountPolicy discountPolicy) {
        this.discountPolicy = discountPolicy;
    }
}

※@Autowired는 주입할 대상이 없으면 오류 발생 이를 방지하기 위해서는 @Autowired(required=false)로 지정하면 된다.

3) 필드 주입

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

※ 특징 : 사용하지 마 xxxxxxx

외부에서 변경이 불가능하고~ 테스트하기 힘들고~ @Configuration에서 사용할 수 있으나 굳이?ㅎ

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

4) 일반 메서드 주입

일반 메서드를 통해 주입하는 방식

※ 특징 : 한 번에 여러 필드를 주입받을 수 있으나 일반적으로 잘 사용하지 않는다.

public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

※참고:

의존관계 자동주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다!

스프링 빈이 아닌 Member 같은 클래스에서 @Autowired를 적용해도 아무 기능도 동작하지 않는다.

2. 옵션처리

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

위에서도 언급했듯이 @Autowired에서 주입할 대상이 없으면 오류가 생긴다.

고로 이렇게 옵션처리를 해주면 오류를 피해 갈 수 있다.

required = false : 자동 주입할 대상이 없으면 수정자 매서드 자체가 호출이 안된다.

@Nullable : 자동 주입할 대상이 없으면 null이 입력된다.

Optional<> : 자동 주입할 대상이 없으면 Optional.empty가 입력된다.

3. 생성자 주입을 선택하라!!

불변:

대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료 시점까지 의존관계를 변경할 일이 없다. 오히려 변경하면 안 된다!

수정자 주입을 사용하려면 변수를 private가 아닌 public으로 열어 두어야 한다. (누군가 변경할 가능성을 열어 두는 것)

생성자 주입은 객체를 생성할 때 딱 한 번만 호출되므로 불변하게 설계 가능하다.

누락:

프레임워크 없이 순수한 자바 코드를 단위 테스트하는 경우에 : 정말 많아...

수정자 의존관계인 경우 : 테스트 의존관계가 안 보인다.

생성자 주입을 사용하면 주입 데이터를 누락했을 때 컴파일 오류가 발생하여 한눈에 오류를 파악할 수 있다.

final:

필드에 final 키워드를 사용할 수 있다. 그래서 생성자에서 혹시라도 값이 설정되지 않은 오류를 컴파일 시점에 막아준다.

final 변수가 생성자에서 주입이 되지 않는 경우에는 이미 빨간 줄이 그어져있어서 뭐가 누락된 건지 바로 알 수 있다.

결론: 순수한 자바 언어의 특징을 가장 잘 살리는 방법이며,

기본으로 생성자 주입을 선택하고 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다.

4. 롬복과 최신 트렌드

※전제 : build.gradle에서 롬복을 추가해 준 뒤

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
    /**ReauiredArgsConstructor로 인해 필요 없어짐
     * final이 꼭 필요한 변수? 라서 얘네로 생성자 만들어 주는것
     * */
}

롬복 라이브러리가 제공하는 @RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어 준다.

최근에는 생성자를 딱 한 개 두고 @Autowired를 생략하는 방법을 주로 사용한다.

여기에 롬복의 @RequiredArgsConstructor 을 함께 사용하면 코드를 깔끔하게 사용할 수 있다.

5. 조회빈이 2개 이상

1) 문제

@Autowired는 타입으로 조회한다. 한참 전 포스팅에서 말했듯이 타입으로 조회할 때 선택된 빈이 두 개 이상이면 문제가 생긴다.

이때 하위 타입으로 지정할 수 있긴 하지만 이는 DIP를 위배하고 유연성이 떨어진다.

2) 해결

- 1.@Autowired 필드명 매칭

@Autowired는 타입 매칭을 시도하고, 이때 여러빈이 있으면 필드 이름, 파라미터 이름으로 빈이름을 추가 매칭한다.

@Autowired
//private DiscountPolicy discountPolicy;
private DiscountPolicy rateDiscountPolicy;

필드명 매칭은 먼저 타입 매칭을 시도했지만 여러빈이 있을 때 추가로 동작하는 기능이다.

- 2.@Qualifier 사용

이는 추가 구분자를 붙여주는 방법이다. 다시 말해 빈이름을 변경하는 것이 아닌 옵션을 제공하는 방법이다.

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

생성자 자동주입 예시

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

단. 위와 같이 모든 코드에 @Qualifier를 붙여야 한다.

순서 : @Quailfier끼리 매칭 → 빈 이름 매칭 → 예외 발생

- 3. @Primary 사용

이는 우선순위를 정하는 방법이다. 여러빈이 매칭되면 @Primary가 우선권을 가진다.

@Component
@Primary
public class RateDiscountPolicy iplememts DiscountPolicy{}

@Component
public class FixDiscountPolicy iplememts DiscountPolicy{}

이렇게 하면 Fix와 Rate가 모두 컴포넌트 스캔할 때 등록이 되지만 @Primary가 붙은 Rate가 우선권을 가지게 된다.

※ @Primary , @Qualifier 활용

메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Priamary를 적용하고

서브 데이터베이스의 커넥션 빈을 획득할 때는 @Qualifier를 지정해서 명시적으로 획득하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.

6. 애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일 시 타입 체크가 안된다.

이런 문제는 애노테이션을 직접 만들어서 해결할 수 있다.

package hello.core.annotation;

import org.springframework.beans.factory.annotation.Qualifier;

import java.lang.annotation.*;

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

@Component
public class OrderServiceImpl implements OrderService{

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

애노테이션에는 상속이라는 개념이 없다.

이렇게 애노테이션을 모아서 사용하는 기능은 스프링이 제공하는 기능이다.

이를 사용하는 것은 좋지만 뚜렷한 목적 없이 무분별하게 사용할 경우에는 혼란만 가중시킬 수 있어서 가능한 제공하는 에노테이션을 사용하는 것이 좋다.

7. 조회한 빈이 모두 필요할 때

→ 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");
    }

    static class DiscountService{
        //Map으로 모든 DiscountPolicy를 주입받는다.
        // 키에 스프링 빈의 이름을 넣어주고 값으로 타입으로 조회한 모든 스프링 빈을 담아 준다.
        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);

            System.out.println("discountCode = " + discountCode);
            System.out.println("discountPolicy = " + discountPolicy);

            return discountPolicy.discount(member,price);
        }
    }
}

자동 , 수동 올바른 실무 운영 기준

편리한 자동기능을 기본으로 사용하자.

자동 빈을 사용해도 우리가 원하는 OCP / DIP를 모두 지킬 수 있다.

수동 빈 등록은 언제 사용하면 좋은가?

업무 로직 빈은 수도 매우 많고 컨트롤러 서비스 리포지토리 처럼 어느 정도 유사한 패턴이 있다. 그러므로 자동 기능을 적극 사용하는 것이 좋다.

하지만 기술 지원 로직은 업무 로직에 비해 수가 매우 적고 광범위하게 영향을 미쳐 적용이 잘 되고 있는지 확인하기가 어려운 경우가 많다.

그러므로 가급적 수동 빈 등록을 사용하여 명확하게 드러나도록 한다.

※ 업무 로직 빈, 기술 지원 빈 이란?

업무 로직 빈: 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지 토리등이 모두 업무로직

기술 지원 빈: 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다.

데이터베이스 연결이나 공통 로그 처리처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술이다.

비즈니스 로직 중 다형성을 적극 활용 → 한눈에 보일 수 있도록 특정 패키지에 같이 묶어 두는 것이 좋다.

@Configuration
public class DiscountPolicyConfig{
    @Bean
    public DiscountPolicy rateDiscountPolicy(){~}
    @Bean
    public DiscountPolicy fixDiscountPolicy(){~}
}

참고로 스프링과 스프링 부트가 자동으로 등록하는 수많은 빈들은 예외다.

이 부분은 스프링의 의도대로 잘 사용하는 것이 중요!!!!

반면에 스프링 부트가 아니라 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 드러내는 것이 좋다.

Uploaded by

N2T

'📑 개발 이론 > 🌱 SPRING' 카테고리의 다른 글

스프링 핵심 원리 - 빈 스코프(1) (0)	2023.06.26
스프링 핵심 원리 - 빈 생명주기 콜백 (0)	2023.06.26
스프링 핵심 원리 - 컴포넌트 스캔 (0)	2023.06.26
스프링 핵심 원리 - 싱글톤 (0)	2023.06.17
스프링 핵심 원리 - 스프링 빈 (0)	2023.06.17