프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점 / 해결법

스프링 컨테이너에 프로토타입 스코프의 빈을 요청하면 항상 새로운 객체 인스턴스를 생성해서 반환한다.

하지만 싱글톤 빈과 함께 사용할 때는 의도한 대로 잘 동작하지 않으므로 주의해야 한다.

 

 

프로토타입 빈 직접 요청

1. 클라이언트 A는 스프링 컨테이너에 프로토타입 빈을 요청
2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x01)한다. 해당 빈의 count 필드 값은 0이다.
3. 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하여 count필드를 +1한다.

결과적으로 프로토타입 빈(x01)의 count 필드의 값은 1이다.

1. 클라이언트 B는 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 새로 생성하여 반환(x02)한다. 해당 빈의 count 필드 값은 0이다.
3. 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하면서 count필드를 +1한다.

결과적으로 프로토타입 빈(x02)의 count 필드의 값은 1이다.

---

싱글톤 빈에서 프로토타입 빈 사용

clientBean이라는 싱글톤 빈이 DI를 통해 프로토타입 빈을 주입받아서 사용하는 예를 보자.

clientBean은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생

1. clientBean은 의존관계 자동 주입을 사용, 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청
2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환. 프로토타입 빈의 count필드 값은 0

이제 clientBean은 프로토타입 빈을 내부 필드에 보관한다.(정확히는 참조값을 보관)

 

클라이언트A는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean반환

  3. 클라이언트 A는 clientBean.logic()을 호출

  4. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가한다. count값이 1이된다.

 

 

클라이언트 B는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환

여기서 중요한 점! clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈.

주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지, 사용할 때마다 새로 생성되는 것이 아님.

  5. 클라이언트 B는 clientBean.logic()을 호출

  6. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가시킴. 원래 1이므로 2가된다.

 

 

package hello.core.scope;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

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

public class SingletonWithPrototypeTest1 {

    @Test
    void prototypeFind() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
        PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
        prototypeBean1.addCount();
        assertThat(prototypeBean1.getCount()).isEqualTo(1);

        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
        prototypeBean2.addCount();
        assertThat(prototypeBean2.getCount()).isEqualTo(1);
    }

    @Test
    void singletonClientUsePrototype() {
        AnnotationConfigApplicationContext ac =
                new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
        ClientBean clientBean1 = ac.getBean(ClientBean.class);
        int count1 = clientBean1.logic();
        assertThat(count1).isEqualTo(1);

        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int count2 = clientBean2.logic();
        assertThat(count2).isEqualTo(2);
    }

    @Scope("singleton") // 생략가능
    static class ClientBean {
        private final PrototypeBean prototypeBean;

        @Autowired // 생성자 하나이므로 생략가능
        public ClientBean(PrototypeBean prototypeBean) {
            this.prototypeBean = prototypeBean;
        }

        public int logic() {
            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");
        }
    }
}

클라이언트 1에 의해 count가 1이되고, 클라이언트 2에 의해 count가 2가 되었다.

clientBean생성 시점에 prototypeBean이 이미 주입되어버림. 계속 같은 prototypeBean

 

스프링은 일반적으로 싱글톤 빈을 사용하므로, 싱글톤 빈이 프로토타입 빈을 사용하게 된다.

그런데 싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는 문제가 발생한다.

 

---

해결법

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

 

가장 간단한 방법은 말 그대로 로직을 호출할 때마다 새로운 prototypeBean을 만드는 것이다.

실행해보면 ac.getBean()을 통해 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.

의존관계를 외부에서 주입(DI)받는게 아니라 이렇게 직접 필요한 의존관계를 찾는 것을

Dependency Lookup(DL) - 의존관계 조회(탐색)이라고 한다.

 

하지만 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.

 

지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 DL 기능만 제공하는 무엇가가 필요한데 이는 스프링에 이미 준비가 되어있다.

 

ObjectFactory, ObjectProvider

지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 ObjectProvider이다.

과거에는 ObjectFactory를 사용했지만, 현재는 편의 기능을 추가한 ObjectProvider가 만들어짐

 

ClientBean을 ObjectProvider를 사용하여 수정하였다. 생성자 주입을 사용해도 되지만, 테스트이므로 간단하게 필드주입을 사용하였다.

getObject메소드를 호출하면 스프링 컨테이너에서 프로토타입 빈을 찾아서 반환해준다. (DL)

 

테스트를 실행해보면 두 번의 호출마다 새로운 프로토타입 빈이 생성된 것을 확인할 수 있다.

ObjectFactory : 기능이 단순, 별도의 라이브러리 필요 없음, 스프링에 의존

 

ObjectProvider : ObjectFactory 상속, 옵션, 스트림 처리등 편의 기능이 많고, 별도의 라이브러리 X, 스프링에 의존

 

---

JSR-330 Provider(자바 표준)

마지막 방법은 javax.inject.Provider 라는 JSR-330 자바 표준을 사용하는 방법이다.

이 방법을 사용하기 위해서는 javax.inject:javax.inject:1 라이브러리를 gradle에 추가해야함.

 

 

build.gradle

Provider와 get으로 바꾸기만 하면 코드의 변경은 끝이난다.(매우 간단)

새로운 프로토타입 빈이 생성되어 테스트또한 성공

get()메서드 하나로 기능이 매우 단순하고, 별도의 라이브러리가 필요하다. 딱 DL정도의 기능만 제공하고 자바 표준이기때문에 스프링이 아닌 다른 컨테이너에서도 사용할 수 있는 장점이 있다.

 

---

그러면 프로토타입 빈을 언제 사용할까? 매번 사용할 때마다 의존관계 주입이 완료된 새로운 객체가 필요하다면 사용하자. 하지만 실제로는 싱글톤 빈으로 대부분의 문제를 해결할 수 있기 때문에 프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다.

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

참고로 @Lookup 애노테이션을 사용하는 방법도 있음.

 

스프링을 사용하다 보면 이 기능 뿐만 아니라 다른 기능들도 자바 표준과 스프링이 제공하는 기능이 겹칠때가 많이 있다. 대부분 스프링이 제공하는 기능이 더 다양하고 편리하기 때문에, 특별히 다른 컨테이너를 사용할 일이 없다면 스프링이 제공하는 기능을 사용하자!!