의존관계 자동 주입

다양한 의존관계 주입 방법

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

- 생성자 주입

- setter 주입 (수정자 주입)

- 필드 주입

- 일반 메서드 주입

 

생성자 주입

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

- 여태 진행했던 방법이 생성자 주입이다.

- 특징은 생성자 호출시점에 딱 1번만 호출되는것이 보장된다.

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

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

 

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

 

 

Setter 주입

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

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

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

public class OrderServiceImpl implements OrderService {

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

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

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

 

setMemberRepository라는 Setter 메서드를 생성후 @Autowired를 붙여서 스프링이 자동으로 의존관계를 주입하도록 한 방법임.

MemberRepository 타입의 빈을 찾아서 memberRepository 필드에 주입하게 된다.

 

장점

- 유연한 변경 가능 : 객체 생성 후에도 의존성을 변경할 수 있다.

- 선택적 의존 관계 주입 가능 : 특정 의존성이 필수적이지 않을 때 사용한다.

 

단점

- 객체 생성 후에도 Setter 호출이 필요 -> 불변성이 깨질 위험 있음

- 의존성이 없으면 NPE 발생가능 -> 필수적인 의존성은 생성자 주입 권장

 

불변성이란? 객체가 생성 된 후 내부 상태(필드 값)이 변경되지 않는 성질이다.

 

위 내용이 무슨 말이냐 하면

MemberServiceImpl service = new MemberServiceImpl();
service.setMemberRepository(new MemoryMemberRepository());  // 초기 주입
service.setMemberRepository(new AnotherMemberRepository()); // 중간에 변경 가능

 

이 코드처럼 실행중에 Setter를 통해 의존성을 변경할 수 있다는것임. 여기서 장점의 내용과 단점의 내용이 겹치는데

이렇게 될 경우 예기치 않은 버그나 사이드 이펙트가 발생할 가능성이 높아지기에 사전에 차단한다는 개념임

 

이전 포스트에서 Stateless하게 설계되어야 한다는 내용이 이 부분에 적용될 수 있는 내용이다.

Stateless(무상태) 하게 설계를 해야 멀티스레드 환경에서도 안전하게 동작 할 수 있다는 것이다.

*복습 : Stateless 설계란 객체가 내부 상태(필드값)을 변경하지 않고 매 요청(request)마다 동일하게 동작하도록 설계하는 것

 

 

필드 주입

말 그대로 필드에 바로 주입하는 방법이다. 사용하지 않는것을 권장!

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

 

- 테스트하기 어려움

// 필드 주입 방식이라, 테스트 코드에서 값을 넣을 수 없음
public class MemberServiceTest {
    MemberServiceImpl memberService = new MemberServiceImpl(); // 직접 주입 불가!!
}

private 필드라서 객체를 생성할 때 직접 값을 주입할 방법이 없다.

setter도 없기 때문에 외부에서 memberRepository를 바꿔서 테스트할 수 없음

 

- 객체를 생성할 때 new로 만들 수 없음

MemberServiceImpl service = new MemberServiceImpl();
service.join(new Member()); // NullPointerException 발생 가능!

new 키워드로 객체를 생성하면 필드가 초기화되지 않아서 NullPointException 발생 가능

new로 직접 객체를 생성하면 memberRepository가 null이라서 join 호출시 NPE 발생할 수 있음.

필드 주입 방식에선 스프링 컨테이너가 주입해줄때까지 memberRepository가 초기화되지 않는다.

 

- 의존관계가 숨어있어 유지보수가 어려움

의존성이 보이지 않고, 스프링 컨테이너가 주입해줄 때까지 기다려야함. 이 클래스가 어떤 객체를 필요하는지 코드만 봐서 알 수 없음

생성자 주입처럼 "이 클래스는 MemberRepository가 필요하다"라고 명확히 선언을 해주는게 좋음

 

그냥 안좋음 쓰지않는게 좋다.

 

일반 메서드 주입

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

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

 

스프링이 OrderServiceImpl을 빈으로 생성한 후, init() 메서드를 호출하면서 의존성을 주입해 줌.

- 일반적인 의존성 주입과 다르게 특정 메서드에만 필요한 의존성을 주입할 때 사용 가능

(로그 출력할 때 필요한 Logger를 주입할 때, 로그 기능은 선택적인 기능이라는 가정 하에 생성자 주입이 필요 없음. 이럴 때 메서드 주입을 활용할 수 있다. Logger는 비즈니스 로직이 아니기 때문에 Logger가 없어도 동작이 되어야 하는 것)

 

단점은 불변성 보장이 어렵고 (final을 못 씀), 의존성 확인이 어렵다. (객체 생성 후 주입되기 때문에)

 

 

옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때가 있다. 그런데 @Autowired만 사용하면 required 옵션의 기본값이 true기 때문에

자동 주입대상이 없으면 오류가 발생한다.

 

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

- @Autowired(require = false) : 자동 주입할 대상이 없으면 setter 메서드 자체가 호출되지 않음

- @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는 스프링 빈이 아니기 때문에 noBean1은 출력되지 않는다.

@Nullable을 사용하면 스프링 빈이 없을경우 null을 주입하기 때문에 member의 값이 null이 된다.

Optional<>을 사용하면 스프링 빈이 없을경우 Optional.empty가 주입되므로 NPE 방지 가능

 

 

생성자 주입을 사용하자

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

 

불변

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

- setter 주입을 사용하면 setXxx 메서드를 public으로 열어둬야한다.

- 이로 인해 누군가 실수로 변경할 수 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 방법이 아니다.

 

누락

프레임워크 없이 순수한 자바 코드를 단위 테스트하는 경우에 setter 주입인 경우 의존관계 누락이 발생할 수 있다.

@Test
void createOrder() {
    OrderServiceImpl orderService = new OrderServiceImpl(); // 의존관계 누락 발생!!
    orderService.createOrder(1L, "itemA", 10000);
}

이 상태로 코드를 작성해 테스트를 하게 되면 NPE가 발생한다. 

OrderServiceImpl은 MemberRepository, DiscountPolicy를 의존하고 있는데 누락이 되었기 때문이다.

 

하지만 생성자 주입을 하게되면 컴파일 에러가 발생하므로 누락할 일이 없어진다.

그리고 final 키워드를 사용할 수 있어서 생성자에서 값이 설정되지 않는 에러도 컴파일 에러로 막아주니 안 쓸 이유가 없는 것이다.

 

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

기본적으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 Setter 주입방식을 사용하면 된다.

 

 

롬복

막상 개발을 해보면 대부분 다 불변이고, 그래서 필드에 final 키워드를 사용하게 된다.

그럴때 생성자도 만들어야 하고 주입 받은 값을 대입하는 코드도 만들어야한다.

필드 주입처럼 쉽고 간편하게 하는 방법이 있다.

 

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    @Override
    public Order createOrder(Long memberId, String itemName, int itemPrice) {
        Member member = memberRepository.findById(memberId);
        int discountPrice = discountPolicy.discount(member, itemPrice);

        return new Order(memberId, itemName, itemPrice, discountPrice);
    }
}

 

롬복 라이브러리를 적용 후 @RequiredArgsConstructor 어노테이션을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다. (코드에는 보이지 않지만 실제로 호출이 가능함)

보다 간결한 코드 작성에 도움이 되는 것이다.

 

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

 

조회 빈이 2개 이상일 때

@Autowired는 타입으로 조회한다.

타입으로 조회하기 때문에, 마치 다음 코드와 유사하게 동작한다 - ac.getBean(DiscountPolicy.class)

스프링 빈 조회에서 학습했듯이 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.

 

DiscountPolicy의 하위타입인 FixDiscountPolicy, RateDiscountPolicy 둘 다 스프링 빈으로 등록하게 된 후

의존관계 자동주입을 실행하면 에러가 발생한다. (NoUniqueBeanDefinitionException)

 

오류 메세지는 하나의 빈을 기대했지만 fixDiscountPolicy, rateDiscountPolicy 2개가 발견되었다고 알려준다.

이 떄 하위 타입으로 지정할 수 도 있지만, 하위 타입으로 지정하는것은 DIP를 위반하고 유연성이 떨어진다.

그리고 이름만 다르고, 완전히 같은 타입의 스프링 빈이 2개 있을 때는 해결할 수 없다.

이런 경우 의존 관계 자동주입에서 해결하는 여러 방법이 있다.

@Autowired 필드 명, @Qualifier, @Primary

 

@Autowired 필드 명 매칭

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

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

 

이 경우, DiscountPolicy 타입의 빈이 2개이상 조회될 때, 파라미터의 값인 rateDiscountPolicy를 찾아서 의존관계를 주입한다.

(스프링부트 3.2 , JDK 17 이상 버전은 컴파일 시 -parameters 옵션을 설정해줘야함)

 

@Qualifier 사용

@Qualifier는 추가 구분자를 붙여주는 방법이다. 빈 등록시 @Qualifier를 붙여준다.

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

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

@Qualifier("mainDiscountPolicy")를 못찾으면 어떻게 될까? 그러면 mainDiscountPolicy라는 스프링 빈 이름으로 찾는다.

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

@Qualifier 정리

- @Qualifier 끼리 매칭

- 빈 이름 매칭

- 없을 시 NoSuchBeanDefinitionException 발생

 

@Primary

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

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

 

위 상황에선 rateDiscountPolicy가 우선순위를 가지게 된다.

 

@Qualifier와 @Primary중 어떤걸 사용해야하나?

@Qualifier는 주입 받을 때 모든 코드에 @Qualifier를 붙여줘야하는 단점이 있다.

반면에 @Primary를 사용하면 @Qualifier를 붙이지 않아도 된다.

 

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

메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary를 적용해서 조회하는곳에서 편리하게 사용할 수 있고, 서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier를 지정해서 명시적으로 획득 하는 방식으로 사용할 수 있다.

 

우선순위

@Primary는 기본값처럼 동작하는 것이고, @Qualfiier는 상세하게 동작한다. 스프링은 자동보다는 수동이, 넓은 범위 보다는 좁은 범위의 선택권이 우선순위가 높기 때문에 @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 {

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

 

*타입체크가 안되는 이유 : 문자열 기반 매칭이기 때문에 존재하지 않는 빈 이름을 적어도 컴파일 단계에서는 에러가 발생하지 않는다는 뜻

@Qualifier("mainDiscountPolicy")는 런타임 시점에서 문자열 기반으로 의존성을 주입하기 때문에 문제 발생 가능성이 있다.

 

어노테이션은 상속 개념이 없다. 이렇게 여러 어노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다. @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 discountPrice = discountService.discount(member, 10000, "fixDiscountPolicy");

        assertThat(discountService).isInstanceOf(DiscountService.class);
        assertThat(discountPrice).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
        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를 주입받는다. (rateDiscoutPolicy, fixDiscountPolicy)

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

 

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

- List<DiscountPolicy> : discountPolicy 타입으로 조회한 모든 스프링 빈을 담는다. (키가 없으므로 값만 조회)

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

 

참고 - 스프링 컨테이너를 생성하면서 빈 등록하기

스프링 컨테이너에서는 생성자에 클래스 정보를 받는다. 여기에 클래스 정보를 넘기면 해당 클래스가 스프링 빈으로 자동 등록된다.

 

new AnnotationConfigApplicationCOntext(AutoAppConfig.class, DiscountService.class);는

- new AnnotationConfigApplicationContext()를 통해 스프링 컨테이너를 생성하고,

- AutoAppConfig.class, DiscountService.class를 파라미터로 넘기면서 해당 클래스를 자동으로 스프링 빈으로 등록함

한마디로 스프링 컨테이너를 생성하면서, 해당 컨테이너에 동시에 AutoAppConfig, DiscountService를 스프링 빈으로 등록한다.

 

자동 / 수동 실무 운영 관점에서?

대부분의 경우엔 편리한 자동 기능을 기본으로 사용하는것을 권장한다.

스프링은 점점 자동을 선호하는 추세이다. @Component 뿐 아니라 @Controller, @Service, @Repostiory 처럼 계층을 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다. 거기에 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 다양한 빈들도 조건이 맞는다면 자동으로 등록하도록 설계했다.

 

설정 정보를 기반으로 구성하는 부분과 실제 동작하는 부분을 명확하게 분리하는것이 이상적이다. 하지만 이것을 모두 다 지키긴 현실적으로 어렵다. @Component 하나만 넣어주면 끝나는 일을 @Configuration 설정 정보에 일일이 @Bean을 적고, 객체 생성, 주입 등등 과정이 너무 번거로워지게 된다. 관리할 빈이 많아지면 더욱 번거롭다.

그리고 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다!

 

 

그럼 수동 빈 등록은 언제해야되는데?

 

비즈니스 로직에 관련된 빈은 자동 등록을 권장

- 컨트롤러, 서비스, 리포지토리 등 보통 비즈니스 요구사항을 개발할 때 추가하거나 변경된다. 이 경우엔 숫자도 매우 많고, 한번 개발해야하면 어느정도 유사한 패턴이 있기 때문에 자동 등록 빈 사용을 권장한다. 문제가 발생해도 비즈니스 로직은 어디서 문제가 발생했는지 명확하게 파악하기 쉽다.

 

기술 지원 빈은 수동 등록 권장

기술 지원빈은 기술적인 문제나 AOP를 처리할 때 사용된다. DB 연결이나 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다. 기술 지원 로직은 비즈니스 로직보다 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐 광범위하게 영향을 준다. 비즈니스 로직은 문제 발생 시 명확하게 잘 드러나지만, 기술 지원 로직은 적용이 잘 되고 있는지 안되고 있는지 파악하기 어려운 경우가 많다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는것을 권장한다.

 

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

DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies) {
    this.policyMap = policyMap;
    this.policies = policies;
    System.out.println("policyMap = " + policyMap);
    System.out.println("policies = " + policies);
}

 

위 코드에서, Map의 DiscountPolicy는 내가 코드를 직접 작성했기 때문에 rateDiscountPolicy, fixDiscountPolicy가 들어온다는 것을 알고 있지만, 다른 사람이 봤을 때 DiscountPolicy에 어떤 값이 들어오는지 한눈에 확인할 수 없다. DiscountPolicy에 직접 접근을 해서 하나씩 봐야하는 경우이다.

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

 

이런경우에 수동 빈으로 등록해서 한눈에 딱 들어오게 별도의 설정 정보를 만들고 수동으로 관리하면 좋다.

핵심은 한눈에 딱 보고 이해가 되어야 한다는 것.

자동 등록으로 관리하게 된다면 특정 패키지에 묶어두는게 좋다.

 

요약

- 생성자 주입을 주로 사용하고, setter 방식은 선택해서 사용

- @Primary와 @Qualifier 상황에 따라 활용

- 롬복을 활용하면 코드가 간결해진다.

- 스프링의 자동기능을 잘 활용할 것, 수동 빈 등록은 필요에 따라서.