[스프링 기본] 의존관계 자동 주입

chaen-ing·2024년 6월 11일
BackendSpring
0

Spring 공부

목록 보기
10/13
post-thumbnail

다양한 의존관계 주입 방법

의존관계 주입은 크게 4가지 방법이 있음

  • 생성자 주입
  • 수정자 주입(setter 주입)
  • 필드 주입
  • 일반 메서드 주입

생성자 주입

이름 그대로 생성자를 통해서 의존관계를 주입받는 방법

지금까지 진행했던 방법

컴포넌트 스캔시 → 스프링 빈 등록할때 생성자 호출 → 이때 @Autowired가 생성자에 붙어있으면 빈에서 의존관계 찾아서 주입

특징

  • 생성자 호출시점에 딱 1번만 호출되는 것이 보장
  • “불변, 필수” 의존관계에 사용 → 불변 : ex) 공연중에 배우를 절대 바꾸지 않을경우. 처음부터 다 확정하고 시작하는 경우 → 필수 : ex) final이 붙어있으므로 생성자에 값을 다 채워넣어야함. null값 X
    private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;

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

중요! 생성자가 딱 1개만 있으면 @Autowired 생략해도 괜찮음

수정자주입

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

private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;

@Autowired
public void setMemberRepository(MemberRepository memberRepository){
	System.out.println("memberRepository = " + memberRepository);
	this.memberRepository = memberRepository;
}

@Autowired
public void setDiscountPolicy(DiscountPolicy discountPolicy){
	System.out.println("discountPolicy = " + discountPolicy);
	this.discountPolicy = discountPolicy;
}

생성자주입 : 생성자를 호출해야하므로 빈 등록하면서 의존관계 주입이 동시에 일어남

수정자주입 : 빈 등록이 다 끝난 후에 의존관계 주입

특징

  • 선택, 변경 가능성이 있는 의존관계에 사용 → 선택 : @Autowired(required = false)
  • 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.

필드주입

필드에 바로 주입하는 방법

@Autowired
private MemberRepository memberRepository;

@Autowired
private DiscountPolicy discountPolicy;

특징

  • 코드가 간결하다는 장점, 외부에서 변경 불가하다는 단점이 있다 → 결국 그러면 또 setter를 만들어야함
  • DI 프레임워크가 없으면 아무것도 할 수 없다
  • 사용하지 말자! 그러나 아래의 경우에는 사용해도 ㄱㅊ음
    • 애플리케이션의 실제 코드와 관계 없는 테스트 코드
    • 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

일반 메서드 주입

일반 메서드를 통해서 주입받을 수 있다

특징

  • 한번에 여러 필드를 주입 받을 수 있다
  • 일반적으로 잘 사용 X : 생성자 주입이나 수정자 주입으로 대체가능
private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;

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

+) 당연한 이야기지만 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작 → ex) Member같은 클래스에서 @Autowired해도 아무 기능 X

옵션 처리

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

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

자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.

  • @Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨
  • org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력된다.
  • Optional<> : 자동 주입할 대상이 없으면 Optional.empty 가 입력된다.
    static class TestBean{
    
        // 1. Autowired(required = false)
        @Autowired(required = false)
        public void setNoBean1(Member noBean1){
            System.out.println("noBean1 = " + noBean1);
        }

				// 2. @Nullable
        @Autowired
        public void setNoBean2(@Nullable Member noBean2){
            System.out.println("noBean2 = " + noBean2);
        }

				// 3. Optional<>
        @Autowired
        public void setNoBean3(Optional<Member> noBean3){
            System.out.println("noBean3 = " + noBean3);
        }

Member는 스프링 빈이 아님!

noBean1은 아예 호출이 안됨

noBean2 = null

noBean3 = Optional.empty

+) @Nullable, Optional은 스프링 전반에 걸쳐서 지원됨. 생성자 자동 주입에서 특정 필드에만 사용해도됨

생성자 주입을 선택해라!

과거에는 수정자 주입과 필드 주입을 많이 사용했지만, 최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장

→ 이유 1 : 불변

  • 대부분의 의존관계 주입은 종료시점까지 변경할일이 없음. 오히려 대부분의 의존관계는 종료시점까지 변하면 안됨
  • 수정자 주입을 사용하면, setXxx 메서드를 public으로 열어둬야함 → 누군가 실수로 변경할 수도 있고, 변경하면 안되는 메소드를 열어두는것은 좋은 설계 방법이 X
  • 생성자 주입은 객체 생성시 딱 1번만 호출되므로 이후에 호출되는 일이 없음. 따라서 불변하게 설계 가능

→ 이유 2 : 누락

private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;
    @Autowired
    public void setMemberRepository(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    @Autowired
    public void setDiscountPolicy(DiscountPolicy discountPolicy) {
        this.discountPolicy = discountPolicy;
    }

위와같이 수정자 의존관계인 경우

@Test
 void createOrder() {
     OrderServiceImpl orderService = new OrderServiceImpl();
     orderService.createOrder(1L, "itemA", 10000);
 }

이렇게 테스트 수행하면 실행은 되나 Null Point Exception 발생

OrderServiceImpl에 memberRepository, discountPolicy모두 의존관계 주입 누락

생성자 주입을 사용하면 위와같은 경우에서 컴파일 오류가 발생하여 어떤 값을 필수로 주입해야하는지 알 수 있음 → new OrderServiceImpl()여기에 빨간줄 뜸

→ 이유 3 : final 키워드

final 키워드를 포함시키면 실수로 값을 설정하지 않는 오류를 막을 수 있음 : 컴파일 오류 발생 → final은 값이 무조건 있어야하므로

생성자 주입이 아닌 다른 방식들은 모두 생성자 이후에 호출되므로 final 사용자체가 불가능

정리

생성자 주입 방식은 프레임워크에 의존하지 않고 순수한 자바 언어의 특징을 잘 살리는 방법

기본적으로 생성자 주입을 사용하고 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면됨 → 동시 사용 가능

항상 생성자 주입을 선택하고 가끔 옵션이 필요하면 수정자 주입을 선택해라. 필드 주입은 사용하지 말자

롬복과 최신 트렌드

막상 개발을 해보면 대부분이 불변이고 그래서 생성자에 final 키워드 사용하게됨

→ 생성자도 만들고, 주입 받은 값을 대입하는 코드도 만들어야하고…

필드 주입처럼 편리하게 사용하는 방법이 없을까?!

먼저 lombok 라이브러리 gradle 수정하고 다운 받는등.. 기본 작업을 해준다!

 @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
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

@RequiredArgsConstructor → final이 붙은 변수를 파라미터로하는 생성자 자동으로 만들어줌. 여기 보이지는 않지만 실제 호출 가능

완전히 동일한 기능을 하지만 코드가 아주 간결해짐!!!

정리

최근에는 생성자를 딱 1개 두고, @Autowired를 생략하는 방법 주로 사용. 여기에 롬복 라이브러리의 @RequiredArgsConstructor를 사용하면 기능은 다 제공하면서 코드는 깔끔하게 사용가능

조회 빈이 2개 이상 - 문제

@Autowired는 타입으로 조회하므로 선택된 빈이 2개 이상이면 문제 발생

@Autowired
private DiscountPolicy discountPolicy;

// 같은 동작 

ac.getBean(DiscountPolicy.class);

예를 들어, FixDiscountPolicy, RateDiscountPolicy 2개를 모두 @Component로 등록하면 둘다 같은

discountPolicy 타입이므로 NoUniqueBeanDefinitionException발생

→ expected single matching bean but found 2: fixDiscountPolicy, rateDiscountPolicy

아래는 해결방법 3가지에 대한 내용이다

@Autowired 필드 명, @Qualifier, @Primary

  1. @Autowired 필드 명 매칭

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

    // 기존 코드
@Autowired
private DiscountPolicy discountPolicy

// 필드 명을 빈 이름으로 변경
@Autowired
private Discount policy rateDiscountPolicy

    필드명이 rateDiscountPolicy이므로 정상주입됨

    필드명 매칭은 먼저 타입 매칭을 시도하고 그 결과에 여러 빈이 있을 때 추가로 동작하는 기능이다.

    @Autowired 매칭 정리

    1. 타입 매칭
    2. 타입 매칭의 결과가 2개 이상일때 필드 명, 파라미터 명으로 빈 이름 매칭

  2. @Qualifier → Qualifier끼리 매칭 → 빈 이름 매칭

    @Qualifier는 추가 구분자를 붙여주는 방법이다. 주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.

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

    RateDiscountPolicy에는 “mainDiscountPolicy”

    fixDiscountPolicy에는 “fixDiscountPolicy”라는 구분자를 붙여준다

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

    OrderServiceImpl에서 이런식으로 사용

    만약 “mainDiscountPolicy” Qualifier를 못찾으면 어떻게될까?

    → mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다

    → Qualifier는 Qualifier를 찾는 용도로만 사용하는 것이 좋다!

    @Qualifier 매칭 정리

    1. @Qualifier끼리 매칭
    2. 빈 이름 매칭
    3. NoSuchBeanDefinitionException 예외 발생

  3. @Primary 사용

    우선순위를 정하는 방법이다

    @Autowired시에 여러번 매칭되면 @Primary가 우선권을 가짐

    @Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy{
	...
}

    @Primary만 붙여주면됨

    매우 간단 → @Qualifier보다 간단 : 모든 코드에 @Qualifier를 붙여줘야함

    메인과 보조 구현체가 있을때 메인에는 @Primary를 걸어놓는다던지 그러한 방식으로 사용

@Primary, @Qualifier 활용

코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고,

코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자.

메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary 를 적용해서 조회하는 곳에서

@Qualifier 지정 없이 편리하게 조회하고,

서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier 를 지정해서 명시적으로 획득 하는 방식으로 사용

하면 코드를 깔끔하게 유지할 수 있다.

물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 @Qualifier 를 지정해주는 것은 상관없다.

우선순위

스프링은 자동보다는 수동이, 넓은 범위의 선택권보다는 좁은범위의 선택권이 우선순위가 높음

@Primary는 기본값처럼 동작

@Qualifier는 매우 상세하게 동작 → 우선권이 높음

애노테이션 직접 만들기

@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 {

}

위와같은 방식으로 애노테이션 생성가능

여기에 @Qualifier도 있는 것을 볼 수 있음

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy{
	...
}

Qualifier와 같은 방법으로 사용

애노테이션에는 상속이라는 개념 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", Grade.VIP);
        int discountPrice = discountService.discount(member,10000,"fixDiscountPolicy");

        Assertions.assertThat(discountService).isInstanceOf(DiscountService.class);
        Assertions.assertThat(discountPrice).isEqualTo(1000);

        int rateDiscountPolicy = discountService.discount(member, 20000, "rateDiscountPolicy");
        Assertions.assertThat(rateDiscountPolicy).isEqualTo(2000);
    }

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

        public int discount(Member member, int price, String discountCode){
            DiscountPolicy discountPolicy = policyMap.get(discountCode);
            return discountPolicy.discount(member,price);
        }
    }
}

DiscountService는 Map으로 모든 DiscountPolicy를 주입받음

→ fixDiscountPolicy, rateDiscountPolicy가 주입됨

discount()메서드는 discountCode로 만약 rateDiscountPolicy가 넘어오면 map에서 rateDiscountPolicy 스프링빈을 찾아서 실행

Map<String, DiscountPolicy> : map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
List<DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.

만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다

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

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

어떤 경우에 컴포넌트 스캔과 자동 주입을 사용하고, 어떤 경우에 설정 정보를 통해 수동으로 빈을 등록하고, 의존관계도 수동으로 주입해야할까?

→ 스프링이 나오고 시간이 갈수록 점점 자동을 선호하는 추세

@Component뿐 아니라 @Controller, @Service, @Repository처럼 계층에 맞춰 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원

설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작 부분을 명확하게 나누는 것이 이상적이지만 개발자입장에서 스프링 빈을 하나 등록할 때 @Component만 넣어주면 끝나는일을 @Configuration 설정정보에 가서 @Bean을 적고 기타등등…매우 번거로움!

또 관리할 빈이 많아서 설정 정보가 커지면 관리자체가 부담이됨

결정적으로 자동 빈 등록을 사용해도 OCP, DIP 지킬 수 있음!

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

애플리케이션은 크게 업무 로직, 기술 지원 로직으로 나눌 수 있음

  • 업무 로직 빈 : 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
  • 기술 지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

업무 로직은 숫자도 매우 많고, 한번 개발해야하면 컨트롤러, 서비스, 리포지토리처럼 어느정도 유사한 패턴이 있다 → 자동 기능 적극 사용 권장 → 문제도 찾기 쉬움

기술 지원 로직은 업무 로직과 비교해서 수가 매우 적고 광범위하게 영향을 미침. 또한 문제가 어디서 발생했는지 적용은 잘 되고 있는지도 파악하기 어려움 → 수동 빈 등록을 통해 명확하게 들어내는 것이 좋다

애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 딱! 설정 정보에 바로 나타나게 하는것이 유지보수 하기 좋다.

비즈니스 로직 중에서 다형성을 적극 활용할 때

의존관계 자동 주입 - 조회한 빈이 모두 필요할 때 → List, map

DiscountService 가 의존관계 자동 주입으로 Map<String,DiscountPolicy> 에 주입을 받는 상황같은 경우에는 수동등록이 낫다.

자동으로 할경우 특정 패키지에 같이묶어두는것이 좋다.

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

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

정리

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

직접 등록하는 기술 지원 객체는 수동 등록

다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해보자

인프런 스프링 핵심 원리 기본편 - 김영한 강의를 듣고 정리한 내용입니다

profile
chaen-ing
💻 개발 공부 기록장
이전 포스트

[스프링 기본] 컴포넌트 스캔

다음 포스트

[스프링 기본] 빈 생명주기 콜백

0개의 댓글

관련 채용 정보