빈 스코프
빈 스코프란?
지금까지는 스프링 빈이 컨테이너의 시작과 함께 생성되어 스프링 컨테이너가 종료되는 시점까지 유지가 된다고 배웠습니다. 즉, 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문인데 스코프는 말 그대로 빈이 존재할 수 있는 범위를 뜻합니다.
스프링은 다양한 스코프를 지원하는데,
싱글톤: 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넒은 범위의 스코프입니다.
프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더이상 관리하지 않는 짧은 범위의 스코프입니다.
웹 관련 스코프
request: 웹 요청이 들어오고 나갈때 까지 유지되는 스코프입니다.
session: 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프입니다.
application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프입니다.
빈 스코프 지정하는 방법
컴포넌트 스캔 자동 등록
@Scope("prototype")
@Component
public class HelloBean {}수동 들록
@Scope("prototype")
@Bean
PrototypeBean HelloBean() {
return new HelloBean();
}프로토타입 스코프
싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환합니다.
하지만 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성하여 반환합니다.
싱글톤 스코프의 빈을 스프링 컨테이너에 요청
스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환
이후에 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환
프로토타입 스코프의 빈을 스프링 컨테이너에 요청
스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고, 필요한 의존관계 주입
스프링 컨테이너는 생성한 프토타입 빈을 클라이언트에게 반환
이후 스프링 컨테이너에 같은 요청이 들어오면 항상 새로운 프로토타입 빈을 생성하여 반환
정리하자면, 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리합니다.
클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않습니다. 즉, 프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있는 것 입니다.
그래서 @PreDestroy 같은 종료 메서드가 호출되지 않습니다.
public class SingletonTest {
@Test
void singletonBeanFind() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SingletonBean.class);
SingletonBean singletonBean1 = ac.getBean(SingletonBean.class);
SingletonBean singletonBean2 = ac.getBean(SingletonBean.class);
System.out.println("singletonBean1 = " + singletonBean1);
System.out.println("singletonBean2 = " + singletonBean2);
Assertions.assertThat(singletonBean1).isSameAs(singletonBean2);
ac.close();
}
@Scope("singleton")
static class SingletonBean {
@PostConstruct
public void init() {
System.out.println("SingletonBean.init");
}
@PreDestroy
public void destroy() {
System.out.println("SingletonBean.destroy");
}
}
}먼저 싱글톤 스코프의 빈을 테스트하면 아래와 같이 결과가 나옵니다.
빈 초기화 메서드를 실행하고, 같은 인스턴스의 빈을 조회하고, 종료 메서드까지 정상 호출되는 것을 볼 수 있습니다.
public class PrototypeTest {
@Test
void prototypeBeanFind() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
System.out.println("find prototypeBean1");
PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
System.out.println("find prototypeBean2");
PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
System.out.println("prototypeBean1 = " + prototypeBean1);
System.out.println("prototypeBean2 = " + prototypeBean2);
assertThat(prototypeBean1).isNotSameAs(prototypeBean2);
ac.close();
}
@Scope("prototype")
static class PrototypeBean {
@PostConstruct
public void init() {
System.out.println("PrototypeBean.init");
}
@PreDestroy
public void destroy() {
System.out.println("PrototypeBean.destroy");
}
}
}반면에 프로토타입 스코프의 빈을 조회하는 테스트를 실행하면,
싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드를 실행합니다. 반면에 프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고, 초기화 메서드도 실행됩니다.
프로토타입 빈을 2번 조회했는데, 서로 다른 빈을 생성하고, 초기화도 2번 되는 것을 확인할 수 있습니다.
싱글톤 빈은 스프링 컨테이너가 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행되지만, 프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입 그리고 초기화 까지만 관여하기 때문에 종료 메서드가 호출되지 않습니다.
만약 따로 close를 해주고 싶은 경우 아래 코드처럼 직접 해줘야 합니다.
prototypeBean1.destroy();
prototypeBean2.destroy();프로토타입 빈 특징
스프링 컨테이너에 요청할 때 마다 새로 생성됩니다.
스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지만 관여합니다.
종료 메서드가 호출되지 않습니다.
프로토타입 빈은 프로토타입 빈을 조회한 크라이언트가 관리해야 합니다. 즉, 종료 메서드에 대한 호출도 클라이언트가 직접 해야 합니다.
프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점
스프링 컨테이너에 프로토타입 스코프의 빈을 요청하면 항상 새로운 객체 인스턴스를 생성해서 반환합니다.
하지만 싱글톤 빈과 함께 사용할 경우 의도한 대로 동작하지 않기 때문에 주의해서 사용해야 합니다.
먼저 스프링 컨테이너에 프로토타입 빈을 직접 요청하는 상황을 보겠습니다.
프로토타입 빈 직접 요청
스프링 컨테이너에 프로토타입 빈 직접 요청1
클라이언트A는 스프링 컨테이너에 프로토타입 빈을 요청합니다.
스프링 컨테이너는 프로토타입 빈을 새로 생성하여 반환(x01)합니다. 해당 빈의 count 필드 값은 0 입니다.
클라이언트는 조회한 프로토타입 빈에
addCount()를 호출하면서 count 필드를 +1 합니다.
결과적으로는 프로토타입 빈(x01)의 count는 1이 됩니다.
스프링 컨테이너에 프로토타입 빈 직접 요청2
클라이언트B는 스프링 컨테이너에 프로토타입 빈을 요청합니다.
스프링 컨테이너는 프로토타입 빈을 새로 생성하여 반환(x02)합니다. 해당 빈의 count 필드 값은 0 입니다.
클라이언트는 조회한 프로토타입 빈에
addCount()를 호출하면서 count 필드를 +1 합니다.
결과적으로는 프로토타입 빈(x02)의 count는 1이 됩니다.
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);
}
@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이라는 싱글톤 빈이 의존관계 주입을 통해 프로토타입 빈을 주입 받아서 사용하는 예를 보겠습니다.
싱글톤에서 프로토타입 빈 사용1
clientBean은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생합니다.
clientBean은 의존관계 자동 주입을 사용합니다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청합니다.스프링 컨테이너는 프로토타입 빈을 생성하여
clientBean에 반환합니다. 프로토타입 빈의 count 필드 값은 0 입니다.
이제 clientBean은 프로토타입 빈을 내부 필드에 보관합니다. 즉, 참조값을 보관하는 것 입니다.
싱글톤에서 프로토타입 빈 사용2
클라이언트A는 clientBean 을 스프링 컨테이너에 요청해서 받습니다. 싱글톤이므로 항상 clientBean 가 반환됩니다.
클라이언트A는
clientBean.logic()을 호출합니다.clientBean은 prototypeBean의addCount()를 호출해서 프로토타입 빈의 count를 증가시킵니다.count 값이 1이 됩니다.
싱글톤에서 프로토타입 빈 사용3
클라이언트B는 clientBean 을 스프링 컨테이너에 요청해서 받습니다. 싱글톤이므로 항상 같은 clientBean 이 반환됩니다.
clientBean 이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈입니다. 즉, 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지, 사용할 때마다 새로 생성되는 것은 아닙니다.
클라이언트B는
clientBean.logic()을 호출합니다.clientBean은 prototypeBean의addCount()를 호출해서 프로토타입 빈의 count를 증가시킵니다.원래 count 값이 1이었으므로 2가 됩니다.
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(2);
}
@Scope("singleton")
static class ClientBean {
private final PrototypeBean prototypeBean; // 생성시점에 주입
@Autowired
public ClientBean(PrototypeBean prototypeBean) {
this.prototypeBean = prototypeBean;
}
public int logic() {
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
}
@Scope("singleton")
static class ClientBean2 {
private final PrototypeBean prototypeBean; // 생성시점에 주입
@Autowired
public ClientBean2(PrototypeBean prototypeBean) {
this.prototypeBean = prototypeBean;
}
public int logic() {
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
}
@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");
}
}
}스프링은 일반적으로 싱글톤 빈을 사용하므로, 싱글톤 빈이 프로토타입 빈을 사용하게 됩니다.
하지만 싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 유지되는 것이 문제입니다.
참고로 여러 빈에서 같은 프로토타입 빈을 주입 받으면, 주입 받는 시점에 각각 새로운 프로토타입 빈이 생성됩니다.
예를 들어 client1, client2가 각각 의존관계 주입을 받으면 각각 다른 인스턴스의 프로토타입 빈을 주입 받습니다.
client1 → prototypeBean@x01
client2 → prototypeBean@x02
물론 사용할 때 마다 새로 생성되는 것은 아닙니다.
프로토타입 스코프 - 싱글톤 빈과 함께 사용시 Provider로 문제 해결
싱글톤 빈과 프로토타입 빈을 함께 사용할 때 마다 항상 새로운 프로토타입 빈을 생성하는 방법
스프링 컨테이너에 요청
간단한 방법으로는 싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청을 하는 것 입니다.
public class PrototypeProviderTest {
@Test
void providerTest() {
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);
}
static class ClientBean {
@Autowired
private ApplicationContext ac;
public int logic() {
PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
}
@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 정도의 기능만 제공하는 것 입니다.
ObjectFactory, ObjectProvider
지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 ObjectProvider입니다.
참고로 과거에는 ObjectFactory가 있었는데, 여기에 편의 기능이 추가되어 나온 것이 ObjectProvider입니다.
@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;
public int logic() {
PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
실행해보면 prototypeBeanProvider.getBean() 을 통해서 항상 새로운 프로토타입 빈을 생성하는 것을 확인할 수 있습니다.
ObjectProvider의 getObject() 를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환합니다.(DL)
스프링이 제공하는 기능을 사용하지만, 기능이 단순하기 때문에 단위테스트를 만들거나 mock 코드를 만들기에는 훨씬 쉬워집니다.
ObjectProvider 는 지금 딱 필요한 DL 정도의 기능만 제공하고 있습니다.
특징
ObjectFactory: 기능이 단순, 별도의 라이브러리가 필요 없음, 스프링에 의존
ObjectProvider: ObjectFactory 상속, 옵션, 스트림 처리 등의 편의 기능이 많고, 별도의 라이브러리 필요 없음, 스프링에 의존
JSR-330 Provider
마지막으로는 javax.inject.Provider라는 JSP-330 자바 표준을 사용하는 방법입니다.
스프링 부트 3.0은 jakarta.inject.Provider 를 사용합니다.
먼저 라이브러리를 gradle에 추가해야 합니다.
저는 3.0 미만이기 때문에 아래 코드를 추가했습니다.
implementation 'javax.inject:javax.inject:1'@Autowired
private Provider<PrototypeBean> provider;
public int logic() {
PrototypeBean prototypeBean = provider.get();
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}실행하면 provider.get()을 통해 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있습니다.
provider의 get()을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환합니다.(DL)
자바 표준이고, 기능이 단순하기 때문에 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 좋습니다.
Provider는 지금 딱 필요한 DL 정도의 기능만 제공합니다.
특징
get() 메서드 하나로 기능이 매우 단순합니다.
별도의 라이브러리가 필요합니다.
자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용이 가능합니다.
정리하자면,
매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요할 때 프로토타입 빈을 사용하면 됩니다.
ObjectProvider, JSR330 Provider 등은 프로토타입 뿐만 아니라 DL이 필요한 경우 언제든지 사용할 수 있습니다.
웹 스코프
웹 스코프 특징
웹 환경에서만 동작합니다.
프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리합니다. 따라서 종료 메서드가 호출됩니다.
웹 스코프 종류
request: HTTP 요청 하나가 들오고 나갈 때 까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리됩니다.
session: HTTP Session과 동일한 생명주기를 가지는 스코프
application: 서블릿 컨텍스트(
ServletContext)와 동일한 생명주기를 가지는 스코프websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프
request 스코프
웹 환경 추가
먼저 웹 스코프는 웹 환경에서만 동작하기때문에 web 환경이 동작하도록 라이브러리를 추가해야 합니다.
build.gradle에 추가
implementation 'org.springframework.boot:spring-boot-starter-web'애플리케이션을 실행하면 웹 애플리케이션이 실행되는 것을 확인할 수 있습니다.
Tomcat started on port(s): 8080 (http) with context path ''
Started CoreApplication in 0.914 seconds (JVM running for 1.528)참고로 spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용하여 웹 서버와 스프링을 함께 실행시킵니다.
스프링 부트는 웹 라이브러리가 없으면 AnnotationConfigApplicationContext을 기반으로 애플리케이션을 구동합니다.
웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하기 때문에 AnnotationConfigServletWebServerApplicationContext을 기반으로 애플리케이션을 구동합니다.
request 스코프 예제 구현
동시에 여러 HTTP 요청이 들어오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵습니다.
이때 사용하기 좋은 것이 바로 request 스코프입니다.
아래 로그와 같은 형식으로 나오게 구현을 진행하겠습니다.
[d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId
[d06b992f...] request scope bean close@Component
@Scope(value = "request")
public class MyLogger {
private String uuid;
private String requestURL;
public void setRequestURL(String requestURL) {
this.requestURL = requestURL;
}
public void log(String message) {
System.out.println("[" + uuid + "]" + "[" + requestURL + "] " + message);
}
@PostConstruct
public void init() {
uuid = UUID.randomUUID().toString();
System.out.println("[" + uuid + "] request scope bean create:" + this);
}
@PreDestroy
public void close() {
System.out.println("[" + uuid + "] request scope bean close:" + this); }
}해당 클래스는 로그를 출력하기 위한 클래스입니다.
@Scope(value = “request”)를 사용해서 request 스코프로 지정했습니다. 이제 해당 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸됩니다.
이 빈은 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용하여 uuid를 생성해서 저장합니다.
즉, HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있습니다.
해당 빈이 소멸되는 시점에 @PreDestroy를 사용하여 종료 메시지를 남깁니다.
requestURL은 이 빈이 생성되는 시점에는 알 수 없기 때문에, 외부에서 setter로 입력 받습니다.
@Controller
@RequiredArgsConstructor
public class LogDemoController {
private final LogDemoService logDemoService;
private final MyLogger myLogger;
@RequestMapping("log-demo")
@ResponseBody
public String logDemo(HttpServletRequest request) {
String requestURL = request.getRequestURL().toString();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}해당 컨트롤러는 로그가 잘 작동하는지 확인하는 테스트용 컨트롤러입니다.
여기서 HttpServletRequest를 통해 요청 URL을 받습니다.
requestURL 값 http://localhost:8080/log-demo
이렇게 받은 requestURL 값을 myLogger에 저장하고, myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 됩니다.
컨트롤러에서는 controller test라는 로그를 남깁니다.
참고로 requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는게 좋다고 합니다.
@Service
@RequiredArgsConstructor
public class LogDemoService {
private final MyLogger myLogger;
public void logic(String id) {
myLogger.log("service id = " + id);
}
}비즈니스 로직이 있는 서비스 계층에서도 로그를 출력하는 코드를 작성했습니다.
여기서 중요한 점은 request scope를 사용하지 않고, 파라미터로 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아서 코드가 지저분해집니다.
더 문제는 requestURL 같은 웹과 관련된 정보가 웹과 관련 없는 서비스 계층까지 넘어가게 됩니다.
웹과 관련된 부분은 컨트롤러까지만 사용해야 하고, 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는게 유지보수 측면에서 좋습니다.
request scope의 MyLogger 덕분에 이러한 부분을 파라미터로 넘기지 않고, MyLogger의 멤버변수에 저장하여 코드와 계층을 깔끔하게 유지할 수 있습니다.
하지만 지금 상태에서 애플리케이션을 실행시키면 아래와 같이 에러가 발생합니다.
Error creating bean with name 'myLogger': Scope 'request' is not active for the
current thread; consider defining a scoped proxy for this bean if you intend to
refer to it from a singleton;즉, 현재 실제 고객의 요청이 오지 않아서 이러한 에러가 발생하는 것 입니다.
스코프와 provider
앞서서 사용한 Provider를 이용해 위 문제를 해결할 수 있습니다.
ObjectProvider를 사용하면,
@Controller
@RequiredArgsConstructor
public class LogDemoController {
private final LogDemoService logDemoService;
private final ObjectProvider<MyLogger> myLoggerProvider;
@RequestMapping("log-demo")
@ResponseBody
public String logDemo(HttpServletRequest request) {
MyLogger myLogger = myLoggerProvider.getObject();
String requestURL = request.getRequestURL().toString();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}@Service
@RequiredArgsConstructor
public class LogDemoService {
private final ObjectProvider<MyLogger> myLoggerProvider;
public void logic(String id) {
MyLogger myLogger = myLoggerProvider.getObject();
myLogger.log("service id = " + id);
}
}ObjectProvider.getObject() 를 호출하는 시점에는 HTTP 요청이 진행 중이므로 request scope 빈의 생성이 정상 처리됩니다.
ObjectProvider.getObject() 를 LogDemoController, LogDemoService에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환됩니다.
ObjectProvider 덕분에 ObjectProvider.getObject() 를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있습니다.
스코프와 프록시
@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {}위에 추가한 proxyMode = ScopedProxyMode.TARGET_CLASS에 대해서 설명하자면,
적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS를 선택합니다.
적용 대상이 인터페이스면 INTERFACES를 선택합니다.
이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어주고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있습니다.
이렇게 적용하면, 예전 간단한 코드로 돌아올 수 있습니다.
@Controller
@RequiredArgsConstructor
public class LogDemoController {
private final LogDemoService logDemoService;
private final MyLogger myLogger;
@RequestMapping("log-demo")
@ResponseBody
public String logDemo(HttpServletRequest request) {
String requestURL = request.getRequestURL().toString();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}@Service
@RequiredArgsConstructor
public class LogDemoService {
private final MyLogger myLogger;
public void logic(String id) {
myLogger.log("service id = " + id);
}
}실행하면 아까와 똑같이 잘 동작하는 것을 확인할 수 있습니다.
코드를 보면 LogDemoController, LogDemoService가 Provider 사용 전과 동일하게 돌아간 것을 볼 수 있는데, 이부분을 좀더 알아보겠습니다.
웹 스코프와 프록시 동작 원리
먼저 주입된 myLogger를 확인해보면,
System.out.println("myLogger = " + myLogger.getClass());myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726dCGLIB라는 라이브러리로 해당 클래스에 상속 받은 가짜 프록시 캑체를 만들어서 주입하는 것 입니다.
@Scope의proxyMode = scopedProxyMode.TARGET_CLASS를 설정하면 스프링 컨테이너는 CGLIB 라는 바이트코드를 조작하는 라이브러리를 사용해 MyLogger를 상속받은 가짜 프록시 객체를 생성합니다.위에 결과를 보면 직접 등록한 순수한 MyLogger 클래스가 아니라
MyLogger$$EnhancerBySpringCGLIB라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있습니다.그리고 스프링 컨테이너에 “myLogger”라는 이름으로 가짜 프록시 객체를 등록합니다.
ac.getBean("myLogger", MyLogger.class)로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있습니다.그래서 의존관계 주입도 해당 가짜 프록시 객체가 주입이됩니다.
가짜 프록시 객체는 요청이 오면 그때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있습니다.
가짜 프록시 객체는 내분에 진짜 myLogger를 찾는 방법을 알고 있습니다.
클라이언트가
myLogger.log()를 호출하면 사실은 가짜 프록시 객체의 메서드를 호출하는 것 입니다.가짜 프록시 객체는 request 스코프의 진짜
myLogger.log()를 호출합니다.가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있습니다.(다형성)
동작 정리
CGLIB라는 라이브러리로 해당 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입합니다.
이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있습니다.
가짜 프록시 객체는 실제 request scope와는 관계가 없습니다. 그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작합니다.
특징 정리
프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있습니다.
Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점입니다.
단지 어노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있습니다. 이것이 바로 다형성과 DI 컨테이너가 가진 큰 장점입니다.
웹 스코프가 아니여도 프록시는 사용할 수 있습니다.
주의점
마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 주의해서 사용해야 합니다.
이런 scope는 꼭 필요한 곳에 최소한으로 사용해야 합니다.
참고 자료
Last updated