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

공부 내용을 정리하고 앞으로의 학습에 이해를 돕기 위해 작성합니다.

 

다양한 의존관계 주입 방법

 

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

1. 생성자 주입

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

3. 필드 주입

4. 일반 메서드 주입

 

1. 생성자 주입

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

- 불변, 필수 의존 관계에 사용한다.

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

 

2. 수정자 주입(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;
    }
}

- 수정자 주입은 필드의 값을 변경하는 수정자(setter) 메서드를 통해 의존관계를 주입하는 방법이다.

- 선택, 변경 가능성이 있는 의존관계에 사용한다.

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

 

3. 필드 주입

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

 @Bean
 OrderService orderService(MemberRepository memberRepoisitory, DiscountPolicy
 discountPolicy) {
     return new OrderServiceImpl(memberRepository, discountPolicy);
 }

- 필드에 바로 주입하는 방식이다.

- 코드가 간결하지만 외부에서 변경이 불가능하여 테스트하기 힘들다.

- DI 프레임워크가 없으면 아무것도 할 수 없다.

- 사용하지 말자

 

4. 일반 메서드 주입

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

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

- 일반적으로 잘 사용하지 않는다.

 

참고 : 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈에서만 동작한다.

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

 

옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때는 `@Autowired`의 `required` 옵션을 `false`로 설정해야 한다. 기본값이 `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 {

        @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는 스피링 빈이 아니다.

- setNoBean1은 @Autowired(required=false) 이므로 호출 자체가 안된다.

 

생성자 주입을 선택해라

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

 

불변

- 대부분의 의존관계 주입은 애플리케이션 종료 시점까지 변경되지 않아야 한다. 
- 수정자 주입은 setXxx 메서드를 public으로 열어두어야 하므로, 실수로 변경될 수 있어 좋은 설계 방법이 아니다.
- 생성자 주입은 객체 생성 시 딱 한 번만 호출되므로 이후 변경될 일이 없어, 불변하게 설계할 수 있다.

 

누락

프레임워크 없이 순수한 자바 코드를 단위 테스트 하는 경우, 다음과 같이 수정자 의존관계인 경우

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

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

이렇게 테스트를 수행하면 실행은 되지만, memberRepository와 discountPolicy의 의존관계 주입이 누락되어 NPE(Null Pointer Exception)가 발생한다.

 

하지만 생성자 주입을 사용하면 주입 데이터를 누락했을 때 컴파일 오류가 발생한다. 그리고 IDE에서 어떤 값을 필수로 주입해야 하는지 바로 알 수 있다.

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

 

final 키워드

생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다. 그래서 생성자에서 값이 설정되지 않는 오류를 컴파일 시점에 막아준다.

- 필수 필드인 discountPolicy에 값을 설정해야 하는데, 이 부분이 누락되었다. 

- 자바는 컴파일 시점에 "variable discountPolicy might not have been initialized" 오류를 발생시킨다.

- 기억하자, 컴파일 오류는 세상에서 가장 빠르고 좋은 오류다.

 

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

 

정리

- 생성자 주입은 프레임워크에 의존하지 않고 순수한 자바의 특징을 잘 살린다.

- 기본적으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입을 옵션으로 부여하면 된다.

- 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.

- 항상 생성자 주입을 선택하고, 옵션이 필요하면 수정자 주입을 사용하라. 필드 주입은 사용하지 않는 것이 좋다.

 

롬복과 최신 트랜드

개발을 하다 보면 대부분의 의존관계는 불변이므로 필드에 `final` 키워드를 사용한다. 

하지만 생성자와 주입 값을 대입하는 코드를 작성하는 것은 번거롭다. 

개발자는 귀찮음을 참지 못하므로, 코드를 최적화해 보자.

 

우선 build.gradle에 롬복 관련 설정을 해주어야 한다. 

plugins {
	id 'java'
	id 'org.springframework.boot' version '3.3.1'
	id 'io.spring.dependency-management' version '1.1.5'
}

group = 'hello'
version = '0.0.1-SNAPSHOT'

//lombok 설정 추가 시작 configurations
configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}

java {
	toolchain {
		languageVersion = JavaLanguageVersion.of(17)
	}
}

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'
	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}

tasks.named('test') {
	useJUnitPlatform()
}

그리고 Preferences -> Annotation Processors -> Enable annotation processing을 체크한다. 

이제 롬복을 사용할 수 있다.

 

getter와 setter

package hello.core;

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

@Getter
@Setter
@ToString
public class HelloLombok {

    private String name;
    private int age;

    public static void main(String[] args) {
        HelloLombok helloLombok = new HelloLombok();
        helloLombok.setName("test");

        String name = helloLombok.getName();
        System.out.println("name = " + name);
        System.out.println("helloLombok = " + helloLombok);
    }
}

- 원래는 getter와 setter를 코드로 적어 주어야 하지만 롬복을 사용하면 애노테이션으로(@Getter @Setter) 코드를 단순화할 수 있다.

 

OrderServiceImpl에 롬복을 적용해 생성자를 생략시켜 보자

 

기존

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

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

 

정리

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

 

조회 빈이 2개 이상 - 문제

@Autowired 는 타입(Type)으로 조회하기 때문에 다음 코드와 유사하게 동작한다. (실제로는 더 많은 기능을 제공)

- ac.getBean(DiscountPolicy.class)

 

이전에도 알아봤듯이 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.

 

문제를 발생시켜 보자.

@Component
public class FixDiscountPolicy implements DiscountPolicy{
..생략
}

@Component
public class RateDiscountPolicy implements DiscountPolicy{
..생략
}

- DiscountPolicy의 하위 타입인 FixDiscountPolicy와 RateDiscountPolicy를 둘 다 스프링 빈으로 선언한다.

 

실행하면 NoUniqueBeanDefinitionException 오류가 발생한다.

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

OrderServiceImpl의 생성자는 FixDiscountPolicy와 RateDiscountPolicy 중 어떤 빈을 선택해야 하는지 알 수 없다.

 

이때 하위 타입으로 지정하면 DIP를 위배하고 유연성이 떨어지며, 이름만 다른 동일 타입의 스프링 빈이 2개 있을 때 문제를 해결할 수 없다. 스프링 빈을 수동 등록하는 대신, 의존 관계 자동 주입에서 해결할 여러 방법이 있다.

 

@Autowired  필드명, @Qualifier, @Primary

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

 

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

-> 

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

- 필드명을 rateDiscountPolicy로 지정했으므로 정상 주입된다.

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

 

@Qualifier

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

----------------------------------------------------------------

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

- 빈이 중복된 구현체에 추가 구분자를 붙이고 주입 시에 넣어준다.

- @Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 못 찾으면 어떻게 될까? 그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.

- 하지만 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 게 명확하고 좋다.

 

@Primary

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy{}

-----------------------------------------------------------------

@Component
public class FixDiscountPolicy implements DiscountPolicy{}

- @Primary는 우선순위를 정한다. @Autowired시에 여러 빈이 매칭되면 @Primary가 우선권을 가진다.

 

@Primary, @Qualifier 활용

코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 했을 때, 

메인 데이터베이스의 커넥션을 획득하는 스프링 빈에는 @Primary를 적용하여, 조회할 때 @Qualifier를 지정하지 않아도 편리하게 사용할 수 있다. 서브 데이터베이스 커넥션 빈은 @Qualifier를 지정하여 명시적으로 획득한다. 이를 통해 코드의 깔끔함과 유연성을 유지할 수 있다. 물론 메인 데이터베이스 빈을 등록할 때 @Qualifier를 함께 지정해도 상관없다.

 

우선순위

@Primary는 기본값처럼 동작하고, @Qualifier는 매우 상세하게 동작한다.

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

따라서 @Qualifier가 @Primary보다 우선권이 높다.

 

애노테이션 직접 만들기

@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
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy{}

 

OrderServiceImpl

애노테이션에는 상속 개념이 없지만, 스프링은 여러 애노테이션을 모아서 사용할 수 있는 기능을 지원한다. 

@Qualifier뿐만 아니라 다른 애노테이션도 함께 조합할 수 있으며, @Autowired도 재정의할 수 있다. 

그러나 스프링 기능을 목적 없이 재정의하면 유지보수에 혼란을 초래할 수 있다.

 

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

의도적으로 특정 타입의 모든 스프링 빈이 필요한 경우가 있다. 

예를 들어, 할인 서비스를 제공하는데 클라이언트가 할인의 종류(정률, 정액)를 선택할 수 있다고 가정해 보자. 스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있다.

 

package hello.core.autowired;

import hello.core.AutoAppConfig;
import hello.core.discount.DiscountPolicy;
import hello.core.member.Grade;
import hello.core.member.Member;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import java.util.List;
import java.util.Map;

import static org.assertj.core.api.Assertions.assertThat;

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

    }

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

 

로직 분석

- ApplicationContext에 AutoAppConfig와 DiscountService 클래스를 포함하여 스프링 컨테이너를 초기화한다.

- 이 과정에서 스프링은 AutoAppConfig에 정의된 모든 빈과 DiscountService를 스캔하고 빈으로 등록한다.

- DiscountService는 Map으로 모든 DiscountPolicy를 주입받는다. (fixDiscountPolicy, rateDiscountPolicy 주입)

- discount() 메서드는 discountCode로 "fixDiscountPolicy"가 넘어오면 map에서 fixDiscountplicy 스프링 빈을 찾아서 실행한다.

 

주입 분석

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

- List <DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.

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

 

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

 

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

컴포넌트 스캔과 자동 주입을 사용하는 것이 기본적으로 편리하다. 스프링은 @Component, @Controller, @Service, @Repository 애노테이션을 통해 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있게 지원한다. 스프링 부트는 컴포넌트 스캔을 기본으로 사용하며, 다양한 스프링 빈도 조건에 맞으면 자동으로 등록되도록 설계되어 있다. 설정 정보를 통해 애플리케이션 구성과 실제 동작을 명확하게 나누는 것이 이상적이지만, 자동 빈 등록을 사용하면 더 간편하다. 설정 정보가 커지면 관리 부담이 생기고, 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

 

수동 빈 등록의 경우

수동 빈 등록은 기술 지원 로직에서 사용하기 좋다. 기술 지원 로직은 애플리케이션 전반에 광범위하게 영향을 미치며, 문제가 발생했을 때 파악이 어려운 경우가 많다. 따라서 명확하게 드러내기 위해 수동 빈 등록이 유리하다. 업무 로직은 숫자가 많고 유사한 패턴이 많기 때문에 자동 등록을 사용하는 것이 좋다.

 

비즈니스 로직 중 다형성을 활용할 때

의존관계 자동 주입에서 조회한 모든 빈이 필요할 때 List나 Map을 사용할 수 있다. 그러나 어떤 빈들이 주입될지 쉽게 파악할 수 있도록 특정 패키지에 모아두거나 수동으로 등록하는 것이 좋다. 수동으로 등록하면 설정 정보만 봐도 어떤 빈들이 주입될지 한눈에 파악할 수 있다.

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

이 설정 정보는 한눈에 빈의 이름과 주입될 빈들을 파악할 수 있게 한다. 스프링과 스프링 부트가 자동으로 등록하는 빈들은 예외로, 이를 잘 이해하고 의도대로 사용하는 것이 중요하다. 직접 기술 지원 객체를 등록할 때는 수동으로 등록해서 명확하게 드러내는 것이 좋다.

 

정리

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

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

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

 

인텔리제이 단축키

command + option + B : 인터페이스에서 단축키 입력 시 구현체 목록을 보여준다.

command + B : 현재 커서가 위치한 심벌(메서드, 변수, 클래스 등)을 선언한 목록을 보여준다.

command + F12 : 파일 구조 탐색 (클래스/인스턴스/필드 등 목록 보여줌)