빈 스코프란?
- 스프링 빈은 스프링 컨테이너의 시작과 함께 생성되어 컨테이너 종료 시 까지 유지된다. 이것은 스프링 빈이 싱글톤 스코프로 생성되기 때문이다. 스코프는 말 그대로 빈이 존재할 수 있는 범위를 뜻한다.
- 스프링은 다음과 같은 다양한 스코프를 지원한다.
싱글톤 : 기본 스코프, 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위 스코프
프로토타입 : 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위 스코프
웹 관련 스코프 :
- request : 웹 요청이 들어오고 나갈 때 까지 유지되는 스코프
- session : 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프
- application : 웹의 서블릿 컨텍스와 같은 범위로 유지되는 스코프
프로토타입 스코프
- 싱글톤 스코프 빈을 조회하면 항상 같은 인스턴스의 빈을 반환한다고 배웠다. 반면 프로토타입 스코프는 항상 새로운 인스턴스를 생성해 반환한다.
싱글톤 빈 요청의 경우 로직이
- 싱글톤 스코프의 빈을 스프링 컨테이너에 요청한다.
- 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환한다.
- 이후에 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환한다.
그러나 프로토타입 빈 요청의 경우
- 프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다.
- 스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고, 필요한 의존관계를 주입한다.
- 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환한다.
- 이후에 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다.
-
즉 생성된 빈을 반환하고 이후에 관리하지 않는다. 반환하면 끝이다.
-
핵심은 스프링 컨테이너는 프로토타입 빈을 생성하고 의존관계 주입, 초기화까지만 처리한다는 것이다.
-
프로토타입 빈을 관리할 책임은 이를 받은 클라이언트에 있다. 그래서 @PreDestroy 같은 종료 메소드가 호출되지 않는다. 스프링 컨테이너는 책임이 없기 때문이다.
- 스코프를 싱글톤으로 지정한 테스트다. 사실 싱글톤은 디폴트라 안 적어도 된다.
- 빈을 두 번 조회하면 같은 인스턴스가 반환된다. 당연히 isSameAs 테스트 통과.
- init, destroy도 정상 호출된다.
- 생성시점에 인스턴스가 생성되므로 init이 제일 먼저 찍혀있다.
- 이번에틑 프로토타입 빈 스코프 테스트다. 역시 프로토타입 조회를 두 번 한다.
- 이번에는 두 인스턴스가 달라야 테스트를 통과한다.
- 결과를 보면 init이 두 번 찍힌 것을 볼 수 있다. 생성이 두 번 됐다는 것이다.
- 또 find prototypeBean1 이 찍히고 init이 실행됐다. 즉 컨테이너 생성 시점이 아닌 빈 조회 시점에 인스턴스가 생성된 것이다.
- 또 Destroy가 호출되지 않았다. 프로토타입 빈에서 컨테이너에는 책임이 없기 때문이다.
조금 구체화하자면
- 싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행 되지만, 프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고, 초기화 메서드도 실행된다.
- 프로토타입 빈을 2번 조회했으므로 완전히 다른 스프링 빈이 생성되고, 초기화도 2번 실행된 것을 확인할 수 있다.
- 싱글톤 빈은 스프링 컨테이너가 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행되지만, 프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입 그리고 초기화 까지만 관여하고, 더는 관리하지 않는다. 따라서 프로토타입 빈은 스프링 컨테이너가 종료될 때 @PreDestroy 같은 종료 메서드가 전혀 실행되지 않는다.
프로토타입 빈 특징 정리
- 스프링 컨테이너에 요청할 때 마다 새로 생성된다.
- 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지만 관여한다.
종료 메서드가 호출되지 않는다. - 그래서 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다. 종료 메서드에 대한 호출도
클라이언트가 직접 해야한다.
프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점
- 스프링 컨테이너테 프로토타입 스코프 빈을 요청하면 항상 새로운 객체 인스턴스를 생성하지만 싱글톤 빈과 함께 사용할 때는 그러지 않을 수 있다.
- 클라이언트 A가 프로토타입 빈을 요청하고 반환 받았다. 받을 때마다 addCount()가 호출되어 빈에서 카운트가 올라간다고 가정해보자, 그럼 현재 카운트는 1이다.
- 그런데 클라이언트 B가 또 요청 후 빈을 반환받았는데 완전히 새로운 인스턴스가 생겼으므로 카운트는 역시 1이다. 모든 인스턴스의 카운트가 1인 것이다.
- 직접 테스트코드를 통해 확인해보자
- 빈 조회 시 마다 카운트가 1이어야 한다.
- 전혀 다른 인스턴스가 조회되며 카운트 역시 두 빈 모두 1이다.
- 이번에는 'clientBean' 이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용하는 예를 보자
- clientBean은 싱글톤이므로 스프링 컨테이너 생성 시점에 생성되고 의존관계 주입도 발생한다
- clientBean는 의존관계 자동 주입을 사용하므로 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다
- 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환한다. 프로토타입 빈의 count 필드 값은 0이다.
- 이제 clientBean은 프로토타입 빈을 내부 필드에 보관한다(정확히는 참조값 보관).
- 만약 클라이언트 A가 clientBean을 요청하면, 싱글톤이므로 항상 같은 clientBean이 반환된다.
- 그리고 클라이언트 A가 clientBean.logic()을 호출한다.
- clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가한다. count 값이 1이 된다.
- 그런데 여기서 클라이언트 B가 clientBean을 요청한다. 이 때 기존에 있던 프로토타입 빈을 그대로 사용해 count가 2로 증가한다.
- 여기서 중요한 점은, clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다. 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지, 사용할 때마다 새로 생성되는 것이 아니다.
- 따라서 클라이언트 B는 clientBean.logic()을 호출하고, clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가한다. 이제 1에서 2로 증가한다.
- 이제 테스트를 만들어주자, 이때 컴포넌트 스캔 대상으로 ClientBean과 PrototypeBean을 모두 넣어준다.
- ClientBean1과, ClientBean2를 조회할 때, ClientBean1의 count1이 1이고, ClientBean2의 count2가 2이면 성공이다.
-
이해가 잘 안 갈 수 있으니 다시 설명하면 위 싱글톤 빈의 경우 스프링 빈이 등록되면서 @Autowired로 인해 PrototypeBean이 요청되어 스프링 내부에서 prototypeBean이 만들어져 주입된다. 즉 생성 시점에 주입된다. 따라서 이미 주입이 끝난, 계속 같은 프로토타입이 사용된다.
-
스프링은 일반적으로 싱글톤 빈을 사용하므로, 싱글톤 빈이 프로토타입 빈을 사용하게 된다. 그런데 싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는 것이 문제다.
-
그러나 우리가 원하는 것은 프로토타입 빈을 사용할 때마다 새로 생성해서 사용하는 것을 원한다.
-
참고로 여러 빈에서 같은 프로토타입 빈을 요청 받으면 각각 다른 프로토타입 빈이 생성된다. 주입 받을 때마다 새로 생성되기 때문이다.
프로토타입 스코프 - 싱글톤 빈과 함께 사용시 Provider로 문제 해결
-
프로토타입 빈을 사용할 때 마다 새로 생성해서 사용하게 하는 여러 방법이 있다.
-
가장 간단한 방법은 싱글톤 빈이 프로토타입을 사용할 때 마다 @Autowired로 스프링 컨테이너에 새로 요청하는 것이다.
static class ClientBean {
@Autowired
private ApplicationContext ac;
public int logic() {
PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
} }- 위와같이 로직을 호출할 때마다 컨테이너에서 새로 받는다.
- 실행하면 ac.getBean()을 통해 항상 새로운 프로토타입 빈이 생성된다.
- 이렇게 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL)이라 한다.
- 그런데 이렇게 애플리케이션 컨텍스트 전체를 주입받으면 스프링 컨테이너에 종속적인 코드가 되고 단위 테스트도 어려워진다.
- 지금 필요한 것은 프로토타입 빈을 컨테이너에서 대신 찾아주는 기능만 제공하는 무언가가 필요하다. 이것이 스프링에 있다.
ObjectFactory, ObjectProvider
- 지정한 빈을 컨테이너에서 대신 찾아주는 DL을 제공하는 것이 ObjectProvider다.
ObjectProvider<PrototypeBean>- 위와 같이 ObjectProvider를 통해 프로토타입 빈을 찾고, getObject()를 통해 빈을 조회한다.
- 이제 count1 과 count2가 모두 1이므로 새로운 프로토타입 빈이 생성된 것이다.
- ObjectProvider를 ObjectFactory로 바꿔도 동작한다. ObjectProvider가 ObjectFactory를 상속받은 것인데, ObjectFactory는 getObject() 메소드 하나만 지원하는 반면 ObjectProvider는 여러 가지 메소드가 있다.
JSR-330 Provider
- 마지막 방법은 javax.inject.Provider 라는 JSR-330 자바 표준을 사용하는 방법이다. 이 방법을 사용하려면 javax.inject:javax.inject:1 라이브러리를 gradle에 추가해야 한다.
implementation 'javax.inject:javax.inject:1'- build.gradle에 의존성 추가
- 다음처럼 Provider를 사용하고 get() 메소드를 이용하면 똑같이 동작한다.
- 주의할 점은 Provider가 상당히 많은데 javax의 Provider를 import 하자.
정리
-
그러면 프로토타입 빈을 언제 사용할까? 매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 프로토타입 빈을 사용한다. 사실 자주 사용하는 예시는 아니다.
-
ObjectProvider , JSR330 Provider 등은 프로토타입 뿐만 아니라 DL이 필요한 경우는 언제든지 사용할 수 있다.
-
ObjectProvider를 쓸지, JSR330 Provider를 쓸지 고민 될 수 있다. ObjectProvider는 DL을 위한 편의 기능을 많이 제공해주고 스프링 외에 별도의 의존관계 추가가 필요 없기 때문에 편리하다. 만약 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 JSR-330 Provider를 사용해야한다. 그러나 이럴 일은 거의 없다.
-
참고로 스프링을 사용하다 보면 자바 표준과 스프링이 제공하는 기능이 겹칠때가 많은데, 대부분 스프링이 더 다양하고 편리한 기능을 제공하므로 특별히 다른 컨테이너를 사용할 일이 없다면 스프링이 제공하는 기능을 사용하라(물론 예외도 있다. 표준인 @PostConstruct나 @Predestroy는 스프링에서 표준 사용을 권장한다)
