[Spring 스터디] 빈 스코프(Bean Scope)-2. 웹 스코프

웹 스코프(Web Scope)

웹 환경에서만 동작하는 스코프로서, 스프링이 해당 스코프의 종료시점까지 관리되어 종료 메서드가 호출됩니다.

웹 스코프의 종류

• request: HTTP 요청 하나가 들어오고 나갈 때까지 유지되는 스코프로서, 각각의 HTTP 요청마다 별도의 빈 인스턴스를 생성하고, 관리합니다.
• session: HTTP session과 동일한 생명주기를 가지는 스코프입니다.
• application: 서블릿 컨텍스트와 동일한 생명주기를 가지는 스코프입니다.
• websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프입니다.

Request 스코프

HTTP 요청 당 각각 할당되는 request 스코프입니다.

실습 - request 스코프 예제 만들기

• 웹 환경 추가
  
  웹 스코프는 웹 환경에서만 동작하므로 web 환경이 동작하도록 라이브러리를 추가합시다.

• build.gradle에 추가(라이브러리 추가)

//web 라이브러리 추가
implementation 'org.springframework.boot:spring-boot-starter-web'

이제 hello.core.CoreApplication의 main 메서드를 실행하면 웹 어플리케이션이 실행되는 것을 확인할 수 있습니다.

✅ spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰캣 서버를 활용해서 웹 서버와 스프링을 함께 실행시킵니다.

✅ 스프링 부트는 웹 라이브러리가 없으면 우리가 지금까지 학습한 AnnotationConfigApplicationContext를 기반으로 애플리케이션을 구동합니다. 웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로AnnotationConfigServletWebServiceApplicationContext를 기반으로 애플리케이션을 구동합니다

request 스코프 예제 개발

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵습니다.

이럴때 사용하기 딱 좋은것이 바로 request 스코프죠!

다음과 같이 로그가 남도록 request 스코프를 활용해서 추가 기능을 개발해봅시다.

• 기대하는 공통 포멧:

[UUID][requestURL] {message}
UUID를 사용해서 HTTP 요청을 구분해봅시다.
requestURL 정보도 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인해봅시다.

MyLogger ★로고 출력 클래스

//로그를 출력하기 위한 MyLogger 클래스.
package hello.core.common;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.util.UUID;

@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로 입력 받는다.

LogDemoController

//로거가 잘 동작하는지 확인하는 테스트용 컨트롤러
package hello.core.web;
import hello.core.common.MyLogger;
import hello.core.logdemo.LogDemoService;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;

@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에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋습니다. 여기서는 예제를 단순화하고, 아직 스프링 인터셉터를 학습하지 않은 분들을 위해서 컨트롤러를 사용했습니다. 스프링 웹에 익숙하다면 인터셉터를 사용해서 구현해보세요.

LogDemoService

//비즈니스 로직이 있는 서비스 계층에서도 로그를 출력해보자.
package hello.core.logdemo;
import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class LogDemoService {

     private final MyLogger myLogger;
     
     public void logic(String id) {
     	myLogger.log("service id = " + id);
     }
}

😒 문제점
request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아서 지저분해집니다.
더 문제는 requestURL 같은 웹과 관련된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 됩니다.

웹과 관련된 부분은 컨트롤러까지만 사용해야 해요.
서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋습니다.

첫번째 해결방안) Provider 사용하기

간단히 ObjectProvider를 사용해보자.

package hello.core.web;
import hello.core.common.MyLogger;
import hello.core.logdemo.LogDemoService;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;

@Controller
@RequiredArgsConstructor
public class LogDemoController {

     private final LogDemoService logDemoService;
     private final ObjectProvider<MyLogger> myLoggerProvider;
     
     @RequestMapping("log-demo")
     @ResponseBody
     public String logDemo(HttpServletRequest request) {
         String requestURL = request.getRequestURL().toString();
         MyLogger myLogger = myLoggerProvider.getObject();
         myLogger.setRequestURL(requestURL);
         myLogger.log("controller test");
         logDemoService.logic("testId");
         return "OK";
     }
}
package hello.core.logdemo;
import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class LogDemoService {

     private final ObjectProvider<MyLogger> myLoggerProvider;
     
     public void logic(String id) {
         MyLogger myLogger = myLoggerProvider.getObject();
         myLogger.log("service id = " + id);
     }
}

main() 메서드로 스프링을 실행하고, 웹 브라우저에 http://localhost:8080/log-demo를 입력하자.

실행 시 오류 없이 잘 작동하는 것을 확인 가능

ObjectProvider 덕분에 ObjectProvider.getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
ObjectProvider.getObject()를 호출하시는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리된다.
ObjectProvider.getObject()를 LogDemoController, LogDemoService에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다!

😮
이 정도에서 끝내도 될 것 같지만...개발자들의 코드 몇자를 더 줄이려는 욕심은 끝이 없다.

두번째 해결방안) 프록시 방식 사용하기

이번에는 프록시 방식을 사용해보자.

핵심 코드

@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {
}

proxyMode = ScopedProxyMode.TARGET_CLASS를 추가
적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS를 선택
적용 대상이 인터페이스면 INTERFACES를 선택
❕❗❕
이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

이제 나머지 코드를 Provider 사용 이전으로 돌려두자.

package hello.core.web;
import hello.core.common.MyLogger;
import hello.core.logdemo.LogDemoService;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;

@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";
     }
}
package hello.core.logdemo;
import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

@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$b68b726d
CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
@Scope의 proxyMode = ScopedProxyMode.TARGET_CLASS를 설정하면 스프링 컨테이너는 CGLIB라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성한다.
결과를 확인해보면 우리가 등록한 순수한 MyLogger 클래스가 아니라 MyLogger$ $EnhancerBySpringCGLIB이라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있다.
그리고 스프링 컨테이너에 "myLogger"라는 이름으로 진짜 대신에 이 가짜 프록시 객체를 등록한다.
ac.getBean("myLogger", MyLogger.class)로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있다.
그래서 의존관계 주입도 이 가짜 프록시 객체가 주입된다.

가짜 프록시 객체

요청이 오면 그때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.
내부에 진짜 myLogger를 찾는 방법을 알고 있다.
클라이언트가 myLogger.logic()을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.
request 스코프의 진짜 myLogger.logic()를 호출한다.
원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다(다형성)

동작 정리

CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.
가짜 프록시 객체는 실제 request scope와는 관계가 없다. 그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤처럼 동작한다.

특징 정리

프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있다.
사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점이다.
단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. 이것이 바로 다형성과 DI 컨테이너가 가진 큰 강점이다.
꼭 웹 스코프가 아니어도 프록시는 사용할 수 있다.

주의점

마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.
이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수하기 어려워진다.