스코프란, 빈이 존재할 수 있는 범위를 뜻한다.
앞서, Spring Container
는 Bean
들을 싱글톤으로 생성하여, 관리 하는 것을 알아보았다.
이것은 Spring Bean
이 기본적으로 싱글톤 스코프로 생성되기 때문이다.
하지만 이 외에도 스프링은 여러가지 스코프를 제공한다.
Singleton
: 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프이다.Prototype
: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프이다.싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다. 반면에 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환 한다.
일반적인 싱글톤 스코프.
싱글톤 스코프의 빈을 스프링 컨테이너에 요청하면, 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환한다.
이후에 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환한다.
프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다.
스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고, 필요한 의존관계를 주입한다.
스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환한다.
이후에 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다.
핵심은 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다는 것
클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다. 프로 토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다. 그래서 @PreDestory
같은 종료 메서드가 호출되지 않는다.
clientBean
이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용한다고 하자.
clientBean
은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생한 다.
clientBean
은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청 한다.
스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean
에 반환한다. 프로토타입 빈의 count
필드 값은 0이다.
이제 clientBean
은 프로토타입 빈을 내부 필드에 보관한다.
클라이언트 A는 clientBean
을 스프링 컨테이너에 요청해서 받는다.싱글톤이므로 항상 같은 clientBean
이 반환된다.
클라이언트 A는 clientBean.logic()
을 호출한다.
clientBean
은 prototypeBean
의 addCount()
를 호출해서 프로토타입 빈의 count
를 증가한다. count
값이 1이 된다.
클라이언트 B는 clientBean
을 스프링 컨테이너에 요청해서 받는다.싱글톤이므로 항상 같은 clientBean
이 반환된다.
clientBean
이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다. 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지, 사용 할 때마다 새로 생성되는 것이 아니다.
클라이언트 B는 clientBean.logic()
을 호출한다.
clientBean
은 prototypeBean
의 addCount()
를 호출해서 프로토타입 빈의 count
를 증가한다. 원래 count
값이 1이었으므로 2가 된다.
@Test
void singletonClientUsePrototype() {
AnnotationConfigApplicationContext ac =
new AnnotationConfigApplicationContext(PrototypeBean.class, ClientBean.class);
ClientBean clientBean1 = ac.getBean(ClientBean.class);
int count1 = clientBean1.logic();
assertThat(count1).isEqualTo(1);
System.out.println("clientBean1 = " + clientBean1);
ClientBean clientBean2 = ac.getBean(ClientBean.class);
int count2 = clientBean2.logic();
assertThat(count2).isEqualTo(2);
System.out.println("clientBean2 = " + clientBean2);
}
@Scope // default = singleton
static class ClientBean{
private final PrototypeBean prototypeBean;
@Autowired
public ClientBean(PrototypeBean prototypeBean) {
this.prototypeBean = prototypeBean; }
public int logic() {
prototypeBean.addCount();
System.out.println("prototypeBean = " + prototypeBean);
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");
}
}
}
실행결과 싱글톤 빈인 clientBean
은 당연히 싱글톤으로 같은 객체 이지만, 프로토타입으로 설정한 prototypeBean
또한 같은 객체이다.
그래서 count
가 2가 되는것..
싱글톤 빈과 프로토타입 빈을 함께 사용할 때, 어떻게 하면 사용할 때 마다 항상 새로운 프로토타입 빈을 생성할 수 있을까?
가장 간단한 방법은 싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청하는 것이다.
@Autowired
private ApplicationContext ac;
public int logic() {
PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
logic()
메소드를 위와 같이 수정하여 애플리케이션 컨텍스트 객체에서 매번 주입 받는 방식으로 할 수 있다.
하지만 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.
위와 같이 의존관계를 외부에서 주입(DI) 받는게 아니라 이렇게 직접 필요한 의존관계를 찾는 것을 Dependency Lookup (DL) 의존관계 조회(탐색) 이라한다.
지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 ObjectProvider
이다.
@Scope
static class ClientBean{
@Autowired
private ObjectProvider<PrototypeBean> prototypeBeans;
public int logic() {
PrototypeBean prototypeBean = prototypeBeans.getObject();
prototypeBean.addCount();
return prototypeBean.getCount();
}
}
실행결과 ClientBean
은 같은 객체, PrototypeBean
는 prototypeBeanProvider.getObject()
을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
ObjectProvider
의 getObject()
를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL)
스프링이 제공하는 기능을 사용하지만, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.
웹 스코프는 웹 환경에서만 동작한다.
웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. 따라서 종료 메서드가 호출된다.
request
: HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고, 관리된다.session
: HTTP Session과 동일한 생명주기를 가지는 스코프application
: 서블릿 컨텍스트( ServletContext
)와 동일한 생명주기를 가지는 스코프websocket
: 웹 소켓과 동일한 생명주기를 가지는 스코프