[Spring Boot] 웹 스코프

April 22, 2022 3 분 소요

웹 스코프의 특징

웹 스코프는 웹 환경에서만 동작한다.
웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. 따라서 종료 메서드가 호출된다.

웹 스코프 종류

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

HTTP request 요청당 각각 할당되는 request 스코프
request

request 스코프 예제 만들기

웹 환경 추가

웹 스코프는 웹 환경에서만 동작하므로 라이브러리를 추가해야 한다.

build.gradle에 추가

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

[참고] spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용하여 웹 서버와 스프링을 함께 실행시킨다.

[참고] 웹 라이브러리가 없으면 AnnotationConfigApplicaionContext를 기반으로 애플리케이션을 구동하지만, 웹 라이브러리가 추가되면 웹 관련 추가 설정과 환경이 필요하므로 AnnotationConfigServletWebServerApplicaionContext를 기반으로 애플리케이션을 구동한다.

request 스코프 예제

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어려운데, 이때 사용하기 좋은것이 request 스코프이다.

MyLogger

@Component
@Scope(value = "request")
public class MyLogger {
    @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);
    }
}

로그를 출력하기 위한 MyLogger 클래스
Scope(value = "request")를 사용해서 request 스코프로 지정했다.
이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
빈이 생성되는 시점에 자동으로 @PostConstruct초기화 메서드를 사용해서 uuid를 생성해 저장해둔다.
이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
빈이 소멸되는 시점에 @preDestroy를 사용해서 종료 메시지를 남긴다.

[참고] UUID(Universally Unique IDentifier)는 범용 고유 식별자라고 하며, 네트워크 상에서 고유성이 보장되는 id를 만들기 위한 표준 규약이다.

LogDemoController

@Controller
@RequiredArgsConstructor
public class LogDemoController {
    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에 저장해둔다.

실제는 기대와 다르게 애플리케이션 실행 시점에 오류 발생

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;

스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만, request 스코프 빈은 아직 생성되지 않는다. request 스코프 빈은 실제 고객의 요청이 들어와야 생성할 수 있다.

스코프와 Provider

@Controller
@RequiredArgsConstructor
public class LogDemoController {

    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";
    }
}

출력 코드

[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

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와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.
나머지 코드(LogDemoController, LogDemoService)를 처음 코드로 되돌린 후 실행해보면 잘 동작한다.

웹 스코프와 프록시 동작 원리

주입된 myLogger

System.out.println("myLogger = " + myLogger.getClass());

출력 결과

myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726d

CGLIB 라이브러리로 클래스를 상속 받는 가짜 프록시 객체를 만들어저 주입한다.

@Scope의 proxyMode = ScopedProxyMode.TARGET_CLASS)를 설정하면 스프링 컨테이너는 바이트코드를 조작하는 라이브러리(CGLIB)를 사용해서 MyLogger를 상속받는 가짜 프록시 객체를 생성.
스프링 컨테이너에 “myLogger”라는 이름으로 진짜 대신에 이 가짜 프록시 객체를 등록한다.

CGLIB

가짜 프록시 객체는 요청이 오면 그때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.

가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다.
클라이언트가 myLogger.logic()을 호출하면 가짜 프록시 객체의 메서드를 호출하게 되고, 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()를 호출한다.
가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 동일하게 사용할 수 있다.(다형성)

프록시 동작 정리

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

프록시 특징 정리

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

주의점

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

<출처 : 인프런 - 스프링 핵심 원리 기본편(김영한)>

Twitter Facebook LinkedIn