의존관계 자동 주입

다양한 의존관계 주입 방법

- 생성자 주입

- 수정자 주입(setter 주입)

- 필드 주입

- 일반 메서드 주입

 

생성자 주입

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

- 스프링 빈을 등록하면서 의존 관계가 자동으로 주입됨

- 특징

    - 생성자 호출시점에 딱 1번만 호출되는 것이 보장됨

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

@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개만 있으면 @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;
    }
}

※ 참고: @Autowired의 기본 동작은 주입할 대상이 없으면 오류가 발생. 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false)로 지정하면 됨

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

 

 

필드 주입

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

- 특징

    - 코드가 간결해서 많은 개발자들을 유혹하지만 외부에서 변경이 불가능해서 테스트하기 힘들다는 치명적 단점

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

    - 사용하지 말자

        - 애플리케이션의 실제 코드와 관계없는 테스트 코드

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

@Component
public class OrderServiceImpl implements OrderService {

    @Autowired
    private MemberRepository memberRepository;
    @Autowired
    private DiscountPolicy discountPolicy;
}

 

 

일반 메서드 주입

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

- 특징

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

    - 일반적으로 잘 사용X

@Component
public class OrderServiceImpl implements OrderService {

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

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

※ 참고: 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작. 스프링 빈이 아닌 Member같은 클래스에서 @Autowired 코드를 적용해도 동작 X

 

 

옵션 처리

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

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

- @Autowired(required=false): 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨

- org.springframework.lang.@Nullable: 자동 주입할 대상이 없으면 null이 입력됨

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

※ 참고: @Nullable, Optional은 스프링 전반에 걸쳐 지원됨

 

 

생성자 주입을 선택

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

 

불변

- 대부분의 의존 관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없음, 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안됨(불변해야 함)

- 수정자 주입을 사용하면, setXxx 메서드를 public 으로 열어주어야 함

- 누군가 실수로 변경할 수도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 X

- 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없음. 불변하게 설계 가능

 

누락

- 생성자 주입을 사용하면 주입 데이터를 누락 했을 때 컴파일 오류 발생, 어떤 값을 필수로 주입해야 하는지 알 수 있음

- memberRepository, discountPolicy 모두 의존관계이기 때문에 누락되는 경우 NullPointException 에러를 통해 알 수 있음

- final 키워드를 통해서 해당 값이 누락되어 있는 것을 확인할 수 있음

 

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

 

정리

- 생성자 주입 방식을 선택하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법

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

생성자 주입과 수정자 주입을 동시에 사용 가능

- 항상 생성자 주입 선택, 그리고 가끔 옵션이 필요하면 수정자 주입 선택, 필드 주입은 사용하지 않기

 

 

롬복과 최신 트렌드

개발을 하다보면, 대부분이 불변, 생성자에 final 키워드를 사용

생성자 만들고, 주입받는 값을 대입하는 코드를 최적화하는 방법

 

기존 코드

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

 

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

 

최종 코드 (롬복 적용)

@Component
@RequiredArgsConstructor // final 로 만든 변수들로 생성자 자동으로 만들어줌
public class OrderServiceImpl implements OrderService {

    // final이 있으면 기본으로 할당을 받거나 생성자로 할당을 받아야 한다.
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy; // 구체화에 의존하지 않고 추상화에만 의존함
}

 

 

조회 빈이 2개 이상 - 문제

- @Autowired는 타입(Type)으로 조회

@Autowired
private DiscountPolicy discountpolicy;

 

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

- 아래 코드와 같이 동작 (실제로 더 많은 동작 수행)

ac.getBean(DiscountPolicy.class);

- 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제 발생 (NoUniqueBeanDefinitionException)

- 하위 타입으로 지정할 수 도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어짐

- 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안됨

 

 

@Autowired 필드 명, @Qualifier, @Primary

3가지 해결 방법 존재

- @Autowired 필드 명 매칭

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

- @Primary 사용

 

@Autowired 필드 명 매칭

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

 

기존 코드

@Autowired
private DiscountPolicy discountPolicy;

필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy;

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

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

 

@Autowired 매칭 정리

1. 타입 매칭

2. 타입 매칭의 결과가 2개 이상일 때 필드 명으로 빈 이름 매칭

 

 

@Qualifier 사용

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

 

빈 등록시 @Qualifier를 붙여줌

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

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

주입시 @Quilifier를 붙여주고 등록한 이름을 적어줌

 

생성자 자동 주입 예시

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

수정자 자동 주입 예시

@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
	return discountPolicy;
}

- @Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 못찾으면?

- mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾음

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

 

 

@Qualifier 정리

1. @Qualifier끼리 매칭

2. 빈 이름 매칭

3. NoSuchBeanDefinitionException 발생

 

 

@Primary 사용

- @Primary는 우선순위를 정바는 방법. @Autowired 시에 여러 빈이 매칭되면 @Primary가 우선권을 갖음

 

 

rateDiscountPolicy가 우선권을 갖는 case

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

 

@Primary, @Qualifier 활용

- 코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획등하는 스프링 빈이 있고, 코드에서 특별한 기능을 가끔 사용하는 서트 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다면, 메인 테이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier를 지정해서 명시적으로 획득하는 방식으로 사용하면 코드를 깔끔히 유지 가능

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

 

 

우선순위

- @Priamry는 기본값처럼 동작, @Qaulifier는 매우 상세히 동작

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

- @Qualifier가 우선권 높음

 

 

애노테이션 직접 만들기

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

- 다음과 같이 애노테이션을 만들면 문제 해결 가능

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

- 애노테이션에는 상속이라는 개념이 없음

- 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능

- @Qualifier 뿐만 아니라, 다른 애노테이션들도 함께 조합 사용 가능

- 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 혼란만 가중할 수 있음

 

 

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

- 의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우 존재

- 예를 들어 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정해보면

스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현 가능

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 discountPolicy = discountService.discount(member, 10000, "fixDiscountPolicy");

        assertThat(discountService).isInstanceOf(DiscountService.class);
        assertThat(discountPolicy).isEqualTo(1000);

        int rateDiscountPolicy = discountService.discount(member, 20000, "rateDiscountPolicy");
        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로 fixDiscountPolicy가 넘어오면 map에서 fixDiscountPolicy 스프링 빈을 찾아서 실행. rateDiscountPolicy가 넘어오면 rateDiscountPolicy 실행

 

주입 분석

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

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

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

 

 

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

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

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

 

- 스프링이 나오고 시간이 갈 수록 점점 자동을 선호. 스프링은 @Component 뿐만 아니라 @Contorller, @Service, @Repository 처럼 계층에 맞추어 일반적으로 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원, 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건에 맞으면 자동으로 등록하도록 설계됨

 

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

또한 관리할 빈이 많아서 설정 정보가 커지면 부담됨. 자동 빈 등록을 사용해도 OCP, DIP 지킬 수 있음

 

수동 빈 등록은 언제 사용?

애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나뉨

- 업무 로직 빈 : 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리등의 모두 업무 로직. 보통 비즈니스 요구사항 개발할 때 추가되거나 변경

- 기술 지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용됨. 데이터베이스 연ㄷ결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들

 

- 업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느 정도 유사한 패턴이 있음

이런 경우 자동 기능을 적극 사용. 보통 문제가 발생해도 어떤 곳에 문제 발생했는지 명확히 파악 가능

- 기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플맄케이션 전반에 걸쳐서 광범위하게 영향 미침.

그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확히 잘 들어나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우 많음. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확히 들어내는 것이 좋음

 

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

 

비즈니스 로직 중에서 다형성을 적극 활용할 때 (수동 빈 등록이 좋은 경우)

의존관계 자동 주입 - 조회한 빈이 모두 필요할 때, List, Map을 다시 보자

DiscountPolicy가 의존관계 자동 주입으로 Map<String, DiscountPolicy>에 주입을 받는 상황을 생각

여기에 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일지 코드만 보고 한번에 쉽게 파악 가능?

내가 개발했으니 크게 관계가 없지만 다른 개발자가 개발해서 나에게 준 것이라면?

자동 등록을 사용하고 있기 때문에 파악하려면 여러 코드를 찾아봐야 함

 

이런 경우 수동 빈으로 등록하거나 또는 자동으로 하면 특정 패키지에 같이 묶어 두는것이 좋음. 핵심만 딱 보고 이해가 되어야 함

 

별도의 설정 정보로 만들고 수동으로 등록한 경우

@Configuration
public class DiscountPolicyConfig {

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

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

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

 

 

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

 

 

정리

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

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

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

 

 

출처 : https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard