6. 의존 관계 자동 주입

Spring/스프링 핵심 원리 - 기본편(인프런 김영한)

6. 의존 관계 자동 주입

kyung.Kh 2024. 5. 5. 19:15

다양한 의존관계 주입 방법

생성자 주입

생성자를 통해서 의존관계를 주입 받는 방법
생성자 호출 시점에 딱 1번만 호출되는 것이 보장됨
"불변, 필수" 의존관계에 사용됨

생성자가 1개만 있으면 @Autowired를 생략해도 자동 주입 된다.

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

수정자 주입(setter 주입)

setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법
"선택, 변경" 가능성이 있는 의존관계에 사용
자바 빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법@Autowired의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false)로 지정하면 된다.
@Component public class OrderSericeImpl 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; } }

자바 빈 프로퍼티 규약 예시

자바 빈 프로퍼티, 자에서는 과거부터 필드의 값을 직접 변경하지 않고, setXss, getXss라는 메서드를 통해서 값을 읽거나 수정하는 규칙을 만들었는데, 이것이 자바 빈 프로퍼티 규약이다.

class Data {
    private int age;
    public void setAge(int age) {
        this.age = age;
    }
    public int getAge() {
        return age;
    } 
}

필드 주입

필드에 주입하는 방법으로 코드는 간결하지만 외부에서 변경이 불가능하기 때문에 테스트 하기가 어렵다.
따라서 최근에는 사용하지 않는 것이 좋다.
DI 프레임워크가 없으면 아무것도 할 수 없다.
사용을 안 하는 것이 좋으나, 다음과 같은 상황이라면 사용해도 좋다.
- 애플리케이션 실제 코드와 관계 없는 테스트 코드
- 스프링 설정을 목적으로 하는 @Configuration 같은 특별한 목적으로 사용

@Component
public class OrderServiceImpl implements OrderService{

    @Autowired  // 생성자 주입이나, 수정자 주입 없이 필드에 @Autowired만 붙이면 된다.
    private  MemberRepository memberRepository;
    @Autowired
    private  DiscountPolicy discountPolicy;
...
    // 테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

일반 메서드 주입

일반 메서드를 통해서 주입하는 방법으로 한 번에 여러 필드를 주입 받을 수 있다.
일반적으로 잘 사용하지 않는다.

@Component
public class OrderServiceImpl implements OrderService{

    private  MemberRepository memberRepository;
    private  DiscountPolicy discountPolicy;

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

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

의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈(OrderServiceImpl)이어야 동작한다. 스프링 빈이 아닌 'Member' 같은 클래스에서 @Autowired를 적용해도 적용되지 않는다.

옵션 처리

주입해야 할 스프링 빈이 없어도 동작해야 할 때가 있다. 하지만 @Autowired는 사용하면 required 옵션이 기본값이 true로 되어있어서 자동 주입 대상이 없으면 오류가 발생한다.

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

Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨
org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력
Optional<> : 자동 주입할 대상이 없으면 Optional.empty가 입력됨

public class AutowiredTest {

    @Test
    void AutowiredOption() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
    }

    static class TestBean {

        // 1. 호출 안됨
        @Autowired(required = false)
        public void setNoBean1(Member noBean1) {
            System.out.println("noBean1 = " + noBean1);
        }

        // 2. null 호출(호출은 되지만 null이 들어감)
        @Autowired
        public void setNoBean2(@Nullable Member noBean2) {
            System.out.println("noBean2 = " + noBean2);
        }

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

@Nullable, Optional은 스프링 전반에 걸쳐서 지원된다. 예를 들어서 생성자 자동 주입에서 특정 필드에만 사용해되 된다.

생성자 주입을 선택해라!

생성자 주입을 선택해야 하는 이유

최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장하는데 이유는 다음과 같다.

1. 불변

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

2. 누락

생성자 주입을 사용하면 주입해야 할 데이터를 누락했을 때, 컴파일 오류가 발생한다. 그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.
// 프레임워크를 통해 순수한 자바 코드를 단위 테스트하는 경우에 다음과 같이 수정자 의존관계인 경우 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가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만 지금은 프레임워크 없이 순수한 자바 코드로만 단위 테스트를 수행하므로 실행은 된다.
테스트를 하면 실행은 되지만 NPE(Null Point Exception)이 발생한다.
생성자 주입을 사용하면 위 코드처럼 주입 데이터를 누락 했을 때, 컴파일 오류가 발생한다. 그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.

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

    ...
}

수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를 사용할 수 없다. 오직 생성자 주입 방식만 final 키워드를 사용할 수 있다.

생성자 주입 방식은 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이다. 따라서 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다. 또한 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.

항상 생성자 주입을 선택하고 가끔 옵션이 필요하면 수정자 주입을 선택하면 된다. 필드 주입은 사용하지 않는게 좋다.

롬복과 최신 트렌드

롬복의 필요성

개발할 때, 대부분이 다 불변이고, 아래의 코드처럼 필드에 final 키워드를 사용하게 된다. 그런데 생성자도 만들어야 하고, 주입 받은 값을 대입하는 코드도 만들어야 된다. 아래의 코드에서는 생성자가 1개이므로 @Autowired 생략이 가능하다.

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

롬복이란?

롬복(Lombok)이란 자바 라이브러리로 반복되는 메서드를 annotation을 사용해서 자동으로 작성해주는 라이브러리이다.

롬복의 기능

생성자 자동 생성

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

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;  // 인터페이스를 의존

    /* @RequiredArgsConstructor 가 자동으로 만들어줌
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {  // 생성자
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
    */
    ...
}

상단의(롬복의 필요성) 코드와 이 코드는 동일한 기능을 한다. 롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해주는 것이다.

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

조회 빈이 2개 이상 - 문제

보통 @Autowired는 타입(Type)으로 조회한다. 하지만 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.

예시

DiscountPolicy의 하위 타입인 FixDiscountPolicy, RateDiscountPolicy 둘 다 스프링 빈으로 선언

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

그리고 의존관계 자동 주입을 실행하면 오류가 발생한다.

@Autowired
private DiscountPolicy discountPolicy

하나의 빈을 기대했는데 fixDiscountPolicy, rateDiscountPolicy 2개가 발견되었다고 알려준다.

해결 방법

하위 타입으로 지정할 수도 있지만, 하위 타입으로 지정하는 것은 DIP에 위배하고 유연성이 떨어진다. 그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때, 해결이 되지 않는다.

스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존 관계 자동 주입에서 해결하는 여러 방법이 있다. 다음 문단에서 설명하겠다.

@Autowired 필드 명, @Qualifier, @Primary

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

@Autowired 필드 명 매칭
@Qulifier → @Qualifer 끼리 매칭 → 빈 이름 매칭
@Primary 사용

@Autowired 필드 명 매칭

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

기존 코드

@Autowired
private DiscountPolicy discountPolicy

필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy

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

정리

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

@Qualifer 사용

@Qualifier는 추가 구분자를 붙여주는 방법으로 주입 시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.
사용 방법은 빈 등록 시 @Qualifier을 붙여주고, 주입할 때마다 @Qualifier를 붙여주고 등록한 이름을 붙여준다.

빈 등록 시 @Qualifier 붙이기

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

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

생성자 자동 주입 - 예시1

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

생성자 자동 주입 - 예시2

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

@Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 못 찾으면 어떻게 될까?

mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾지만 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 것이 명확하고 좋다.
스프링 빈도 못 찾으면 NoSuchBeanDefinitionException 예외가 발생한다.

다음과 같이 빈 등록 시에도 @Qualifier를 동일하게 사용할 수 있다.

@Bean
@Qualifier("mainDiscountPolicy")
public DiscountPolicy discountPolicy() {
    return new ...
}

@Primary 사용

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

우선순위

@Primary는 기본값처럼 동작하는 것이고, @Qualifier은 매우 상세하게 동작한다.
스프링은 자동보다는 수동이, 넓은 범위의 선택권 보다는 좁은 범위의 선택권이 우선순위가 높다. 따라서 여기서도 @Qualifier가 우선순위가 높다.

어노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 처럼 문자를 적으면 컴파일 시 타입 체크가 안되는 문제점이 있다. 이런 경우에는 다음과 같이 어노테이션을 만들어서 문제를 해결할 수 있다.

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@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;
}

어노테이션에는 상속이라는 개념이 없다. 이렇게 여러 어노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다. @Qualifier 뿐만 아니라 다른 어노테이션들도 함께 조합해서 사용할 수 있다. 단적으로 @Autowired도 재정의할 수 있다. 물론 스프링이 제공하는 기능을 뚜렷한 목적없이 무분별하게 재정의하는 것은 유지보수에 더 혼란만 가중할 수 있다.

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

의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있다.
ex) 할인 서비스를 제공하는데 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정

public class AllBeanTest {

    @Test
    void findAllBean() {
        // DiscountService.class를 스프링 빈으로 등록
        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);

    }

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

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

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

로직 분석

DiscountPolicy는 Map으로 모든 DiscountPolicy를 주입받는다. 이 때, fixDiscountPolicy와 rateDiscountPolicy가 주입된다.
discount() 메서드는 discountCode로 "fixDiscountPolicy"가 넘어오면 map에서 fixDiscountPolicy 스프링 빈을 찾아서 실행한다.

주입 분석

Map<String, DiscountPolicy> : map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
List<DiscountPolicy] : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.

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

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

스프링이 나온 뒤, 점점 자동을 선호하는 추세

스프링은 @Component, @Controller, @Service, @Repository 처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원함
스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계되어있음
결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

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

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

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

업무 로직은 숫자도 매우 많고, 한 번 개발하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있다. 이런 경우에는 자동 기능을 적극 사용하는 것이 좋으며 보통 문제가 발생해도 어디서 문제가 발생했는지 명확하기 파악하기 쉽다. 하지만 기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다. 따라서 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.

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

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

이런 경우 수동 빈으로 등록하거나 또는 자동으로하면 특정 패키지에 같이 묶어두는게 좋다! 핵심은 딱 보고 이해가 되어야 한다! 이 부분을 별도의 설정 정보로 만들고 수동으로 등록하면 다음과 같다

@Configuration
public class DiscountPolicyConfig {

    @Bean
    public DiscountPolicy rateDiscountPolicy() {
        return new RateDiscountPolicy();
    }
    @Bean
    public DiscountPolicy fixDiscountPolicy() {
        return new FixDiscountPolicy();
    }
}

설정 정보만 봐도 한눈에 빈의 이름은 물론이고, 어떤 빈들이 주입될지 파악할 수 있다.
그래도 빈 자동 등록을 사용하고 싶으면 파악하기 좋게 DiscountPolicy 의 구현 빈들만 따로 모아서 특정 패키지에 모아두는게 좋다.

참고로 스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 예외다.
이런 부분들은 스프링 자체를 잘 이해하고 스프링의 의도대로 잘 사용하는게 중요하다.
스프링 부트의 경우 DataSource 같은 데이터베이스 연결에 사용하는 기술 지원 로직까지 내부에서 자동으로 등록하는데, 이런 부분은 메뉴얼을 잘 참고해서 스프링 부트가 의도한 대로 편리하게 사용하면 된다.
반면에 스프링 부트가 아니라 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 드러내는 것이 좋다.

[출처]

인프런 김영한님의 스프링 기본편을 바탕으로 작성했습니다.

728x90