Spring 빈 스코프(Bean Scope) - 싱글톤, 프로토타입

빈 스코프란?

스코프는 번역 그대로 빈이 존재할 수 있는 범위를 뜻한다.

스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때 까지 유지될 수 있는 이유는 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다.

 

스프링은 다음과 같은 다양한 스코프를 지원한다.

• 싱글톤(Singleton): 기본 스코프. 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프
• 프로토타입(Prototype): 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관하고 더는 관리하지 않는 매우 짧은 범위의 스코프
• 웹 관련 스코프
  • request: 웹 요청이 들어오고 나갈때 까지 유지되는 스코프
  • session: 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프
  • application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프

 

빈 스코프 지정 방법

• 컴포넌트 스캔 자동 등록

@Scope("prototype")
@Component
public class HelloBean{}

• 수동 등록

@Scope("prototype")
@Bean
PrototypeBean HelloBean(){
    return new HelloBean();
}

 

싱글톤 스코프

 

싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 빈을 반환한다.

 

프로토타입 스코프

 

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

 

프로토타입의 빈을 스프링 컨테이너에 요청하면 스프링 컨테이너는 프로토타입의 빈을 생성하고, 필요한 의존관계를 주입한다.

싱글톤 빈은 컨테이너 생성 시점에 같이 생성되고 초기화되지만, 프로토타입 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고 초기화 메서드도 실행된다.

 

스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다.

클라이언트에게 빈을 반환한 이후에는 생성된 프로토타입 빈을 관리하지 않는다.

프로토타입 빈을 관리할 책임은 클라이언트에게 있다. 따라서 @PreDestory와 같은 종료 콜백 메서드가 호출되지 않는다.

 

• 프로토타입 빈의 특징 정리
  • 스프링 컨테이너에 요청할 때 마다 새로 생성된다.
  • 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지만 관여한다.
  • 종료 메서드가 호출되지 않는다.
  • 그래서 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야한다. ( prototypeBean.close() )

프로토타입 빈의 문제점

만약 싱글톤 빈과 프로토타입 빈을 같이 사용하면 어떻게 될까?

 

프로토타입 빈 직접 요청

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

1. 이번엔 클라이언트 B가 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환한다. (0x02) 해당 빈에는 count 필드가 있는데, 초기값은 0이다.
3. 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하여 count필드의 값을 +1 한다.
   • 현재 프로토타입 빈(0x01)의 count는 1이 된다.

 

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

clientBean 이라는 싱글톤 빈에서 프로토타입 빈을 주이받아서 사용하는 경우

• clientBean은 싱글톤이므로, 스프링 컨테이너가 생성되는 시점에 함께 생성되며, 의존관계 주입도 받는다.
  1. 의존관계 주입 과정에서 clientBean은 스프링 컨테이너에 프로토타입 빈을 요청한다.
  2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 주입한다. 이 때 count의 값은 0이다.
• 이 때 clientBean은 프로토타입 빈을 내부 필드에 보관한다. (정확히는 참조값을 보관)

• 클라이언트 A는 clientBean을 조회한다. clientBean은 싱글톤이므로 항상 같은 clientBean이 반환된다.
• 이제 클라이언트 A는 clientBean.logic()을 호출한다.
  • clientBean.logic()을 호출하면, prototypeBean의 addCount()를 호출해서 prototypeBean의 count를 증가시킨다. 
  • count는 1이 된다.

• 클라이언트 B는 clientBean을 조회한다.clientBean은 싱글톤이므로 항상 같은 clientBean이 반환된다.
• 그런데 이 때 주의할 점은 prototypeBean이 새로 생성되는 게 아니라는 점이다. prototypeBean은 이미 과거에 주입이 끝났기 때문이다. clientBean의 의존관계 주입 시점에 스프링 컨테이너에 prototypeBean을 요청해서 생성된 것이지, 사용할 때마다 생성되는 게 아니다.
• 이제 클라이언트 B는 clientBean.logic()을 호출한다.
  • clientBean.logic()을 호출하면, prototypeBean의 addCount()를 호출해서 prototypeBean의 count를 증가시킨다. 
  • count는 2가 된다.

 

정리

각 요청마다 count 값을 1로 반환받는 것을 기대했지만 2를 반환받게 된다. 결국 싱글톤과 프로토타입을 함께 사용하는 경우 기대한 대로 동작하지 않는 것이다.

 

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

그런데 싱글톤 빈은 생성 시점에만 의존관계를 주입받는다.

스프링 싱글톤 빈이 생성되는 시점에 프로토 타입 빈도 새로 생성되어서 주입되긴 하지만, 싱글톤 빈과 함께 계속 유지되는 것이 문제다.

 

따라서 프로토타입 빈을 주입 시점에만 새로 생성하는 것이 아니라, 사용할 때마다 새로 생성해서 사용해야 한다.

 

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

싱글톤 빈과 프로토타입 빈을 같이 사용할 때, 프로토타입 빈을 사용할 때마다 항상 새로운 프로토타입 빈을 생성하려면 어떻게 해야 할까?

 

 

스프링 컨테이너에 요청

가장 간단한 방법은 스프링 컨테이너를 주입하고, 매번 새로 getBean하면 된다.

• ac.getBean()을 통해 항상 새로운 프로토타입 빈이 생성된다.
• 의존관계를 외부에서 주입(DI)받는 게 아닌, 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL), 의존관계 탐색이라고 한다.
• 그런데 스프링 컨테이너를 주입받게 되면, 컨테이너에 의존하게 되고 단위테스트도 어려워진다.
• 지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 DL 정도의 기능만 제공하는 무언가가 있으면 된다. (이미 스프링에서 제공하고 있다.)

 

ObjectFactory, ObjectProvider

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

public class SingletonWithPrototypeTest1 {
    @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(1);
    }

    @Scope("singleton") //default
    static class ClientBean {

        @Autowired
        private ObjectProvider<PrototypeBean> prototypeBeanProvider;

        public int logic() {
            PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
            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");
        }
    }
}

• 실행하면 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
• ObjectProvider의 getObject()를 호출하면, 스프링 컨테이너에 해당 빈을 조회하는 것과 같은 효과를 낸다. (DL)
• 스프링이 제공하는 기능을 의존하지만, 기능이 단순해서 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.
• ObjectProvider는 지금 딱 필요한 DL 정도의 기능만 제공한다.

 

특징

• ObjectFactory: 기능이 단순하고, 별도 라이브러리 필요없다. 사용하면 스프링에 의존하게 된다.
• ObjectProvider: ObjectFactory를 상속하여 기능을 추가했다. (옵션, 스트림 처리 등) 별도 라이브러리 필요없다. 사용하면 스프링에 의존하게 된다.