빈 스코프(4) - 프로토타입 스코프; 싱글톤 빈과 함께 사용시 Provider로 문제 해결

싱글톤 빈과 프로토타입 빈을 함께 사용할 때, 어떻게 하면 사용할 때 마다 항상 새로운 프로토타입 빈을 생성할 수 있을까 ? 

 

1) 스프링 컨테이너에 요청

가장 간단한 방법은 싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청하는 것이다.

import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
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 org.springframework.context.annotation.Scope;

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

public class PrototypeProviderTest {

    @Test
    void providerTest(){
        AnnotationConfigApplicationContext ac =
                new AnnotationConfigApplicationContext(PrototypeBean.class, ClientBean.class);
       ClientBean clientBean1 = ac.getBean(ClientBean.class); //클라이언트 A
        int count1 = clientBean1.logic();
        assertThat(count1).isEqualTo(1);

        ClientBean clientBean2 = ac.getBean(ClientBean.class); //클라이언트 B
        int count2 = clientBean2.logic();
        assertThat(count2).isEqualTo(1);
    }

    static class ClientBean{
        @Autowired
        private ApplicationContext ac;

        public int logic(){
            PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
            prototypeBean.addCount();
            return prototypeBean.getCount();
        }

    }

    @Scope("prototype")
    static class PrototypeBean {
        private int count=0;

        public void addCount(){
            count++;
        }

        public int getCount(){
            return count;
        }

        @PostConstruct
        public void init(){
            System.out.println("prototypeBean.init" + this);
        }

        @PreDestroy
        public void destroy(){
            System.out.println("prototypeBean.destroy");
        }
    }
}​

테스트 결과

- 실행해보면 ac.getBean()을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
- 의존관계를 외부에서 주입(DI)받는게 아니라 이렇게 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL) 의존관계       조회 (탐색)이라한다.
- 그런데 이렇게 스프링 애플리케이션 컨텍스트에 전체를 주입 받게 되면 , 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트      도  어려워 진다.
- 현재 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 DL 기능만 제공하는 무언가가 있으면 된다.

 

 

2) ObjectFactory, ObjectProvider

지정한 빈을 컨테이너가 대신 찾아주는 DL 서비스를 제공하는 것이 ObjectProvider 이다. 참고로 과거에는 ObjectFactory가 있었는데 여기에 편의기능을 추가해서 ObjectProvider가 만들어졌다.

    static class ClientBean{
        @Autowired
        private ObjectProvider<PrototypeBean> prototypeBeansProvider;

        public int logic(){
            PrototypeBean prototypeBean = prototypeBeansProvider.getObject();
            prototypeBean.addCount();
            return prototypeBean.getCount();
        }

    }​

- 실행해보면 prototypeBeansProvider.getObject() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
- ObjectProvider의 getObject()를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아 반환한다. (DL)
- 스프링이 제공하는 기능을 사용하지만, 기능이 단순한 단위테스트를 만들거나 mock코드를 만들기 쉬워진다.
- ObjectProvider는 지금 필요한 DL 정도의 기능만 제공한다.

특징
- ObjectFactory : 기능이 단순, 별도의 라이브러리 필요 없음, 스프링에 의존(ObjectProvider 조상)
- ObjectProvider:ObjectFactory상속,옵션,스트림 처리등 편의 기능이 많고 , 별도의 라이브러리 필요 없음, 스프링에 의존

 

3) JSR-330 Provider

마지막 방법은 jakarta.inject.Provider 라는 JSR-330 자바 표준 라이브러리를 사용하는 것이다.
이 방법을 사용하려면 'jakarta.inject:jakarta.inject-api:2.0.1'라이브러리를 gradle에 추가해야한다.

    static class ClientBean{
        @Autowired
        private Provider<PrototypeBean> Provider;

        public int logic(){
            PrototypeBean prototypeBean =Provider.get();
            prototypeBean.addCount();
            return prototypeBean.getCount();
        }
    }

- 실행해보면 Provider.get()을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
- Provider의 get()을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다.(DL)
- 자바 표준이고, 기능이 단순하므로 단위 테스트를 만들거나 mock 코드를 만들기 훨씬 쉽다.
- Provider는 지금 필요한 DL 정도의 기능만 제공한다.

특징
- get() 메서드 하나로 기능이 매우 단순하다.
- 별도의 라이브러리가 필요하다
- 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

 

 

정리

- 프로토타입 빈을 언제 사용할까 ? 매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다.

그러나 실무에서 싱글톤 빈으로 대부분 문제를 해결할 수 있기 때문에 프로토타입 빈을 직접적으로 사용하는 일은 드물다.

ObjectProvider,JSR330 Provider 등은 프로토타입 뿐만 아니라 DL이 필요한 경우는 언제든지 사용하 수 있다.

 

참고

스프링을 사용하다 보면 이 기능 뿐만 아니라 다른 기능들도 자바 표준과 스프링이 제공하는 기능이 겹칠때가 많이 있다.

대부분 스프링이 더 다양하고 편리한 기능을 제공해주기 때문에, 특별히 다른 컨테이너를 사용할 일이 없다면 , 스프링이 제공하는 

기능을 사용하면 된다.