[SpringBoot] 웹 스코프 (Request 스코프)

목차

 

서론

이전에 싱글톤, 프로토타입 스코프, Provider 과 관련된 글을 작성했습니다.

이번엔 웹 스코프에 대해 작성하겠습니다.

 

빈의 종류

종류	설명
싱글톤	기본 스코프. 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프이다.
프로토타입	스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프이다.
웹 관련	request	웹 요청이 들어오고 나갈 때까지 유지되는 스코프이다.
	session	웹 세션이 생성되고 종료될 때까지 유지되는 스코프이다.
	application	웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프이다.

 

웹 스코프의 특징

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

 

웹 스코프의 종류 중 Request 스코프와 관련된 예제로 설명하겠습니다.

세션과 애플리케이션 모두 범위만 다르고 동작 방식은 비슷합니다.

 

 

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

 

웹 환경 추가

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

 

build.gradle에 추가

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

 

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

Tomcat started on port(s): 8080 (http) with context path ''
Started CoreApplication in 2.9 seconds (JVM running for 5.805)

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

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

 

 

Request 스코프 예제

HTTP 요청이 들어올 때 객체가 생성되고, 나갈 때 소멸되는 것이 Request Scope 빈입니다.

이 빈을 사용하면 동시에 여러 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

• 기대하는 공통 포맷: [UUID][Request URL] {message}
• UUID를 사용해서 HTTP 요청을 구분하자
• Request URL 정보도 추가로 넣어 어떤 URL을 요청하여 남은 로그인지 확인하자

 

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();    //절대 겹치지 않는 고유한 랜덤 ID
        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")를 사용하여 reqeust 스코프로 지정합니다.
• 이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용하여 UUID를 생성해 저장합니다. 이 빈은 요청 당 하나씩 생성되므로 UUID를 저장해두면 다른 HTTP요청과 구분할 수 있습니다.
• 이 빈이 소멸되는 시점에 @PreDestory 를 사용하여 종료 메시지를 남깁니다.
• 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.getRequestURI().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 과 같은 웹과 관련된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 됩니다. 
  웹과 관련된 부분은 컨트롤러까지만 사용해야 합니다. 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋습니다.
• Request Scope의 MyLogger 덕분에 파라미터로 많은 정보를 넘기지 않고, 서비스 계층을 순수하게 유지하여 코드와 계층을 깔끔하게 유지할 수 있습니다.

 

이제 실행을 해봅시다.

 

실행 - 문제 발생

기대하는 출력

[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

 

오류 발생

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 스코프 빈은 스프링 컨테이너 생성 시점이 아닌 요청이 발생한 시점에 생성이 가능한데, 아직 생성되지 않은 빈을 싱글톤 빈에 주입하여 발생하는 오류입니다.

 

이에 대한 해결책은 앞에 작성한 Provider를 활용하는 것입니다.

Provider를 활용하여 요청이 발생한 시점에 스프링 컨테이너에게 Request Scope 빈을 요청하여 사용합니다.

 

 

Request 스코프와 Provider

ObjectProvider를 사용하여 해결해 봅시다.

 

LogDemoController

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> myLoggerObjectProvider;
//    private final MyLogger myLogger;

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        String requestURL = request.getRequestURI().toString();
        MyLogger myLogger = myLoggerObjectProvider.getObject();
        myLogger.setRequestURL(requestURL);

        myLogger.log("controller test");
        logDemoService.logic("testId");
        return "OK";
    }
}

 

LogDemoService

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> myLoggerObjectProvider;
//    private final MyLogger myLogger;

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

 

 

실행

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

 

잘 동작하는 것을 확인할 수 있습니다.

[abac3d20...] request scope bean create: hello.core.common.MyLogger@369beff0
[abac3d20...][/log-demo] controller test
[abac3d20...][/log-demo] service id = testId
[abac3d20...] request scope bean close: hello.core.common.MyLogger@369beff0

 

• ObjectProvider 덕분에 objectProvider.getObject()를 호출하는 시점까지 Request Scope 빈의 생성을 지연할 수 있습니다. (정확히 말하면 스프링 컨테이너에게 요청하는 것을 지연하여 스프링 컨테이너가 그 시점에 빈을 생성합니다.)
• ObjectProvider.getObject()를 호출하는 시점에는 HTTP요청이 진행중이므로 Request Scope 빈의 생성이 정상 처리됩니다.
• ObjectProvider.getObject()를 LogDemoController, LogDemoService에서 각각 한번씩 따로 호출해도 같은 HTTP요청이면 같은 스프링 빈이 반환됩니다. → 직접 이걸 구분하는 기능을 구현하려면 얼마나 힘들까..ㅠㅠ

 

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

 

 

Request Scope와 프록시

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

• MyLogger에 proxyMode = ScopedProxyMode.TARGET_CLASS 를 추가해줍시다.
  (적용 대상이 인터페이스라면 INTERFACES 를 선택, 클래스라면 TARGET_CLASS)를 선택
• 이렇게 하면 MyLogger를 상속받은 가짜 프록시 클래스를 만들어 HTTP Request와 상관없이 가짜 프록시 클래스를 빈에 미리 주입해둘 수 있습니다.
• 그리고 요청이 들어오면 이 가짜 프록시 객체는 진짜 객체를 호출합니다.

 

이제 Provider를 붙이기 전 코드로 되돌리겠습니다.

 

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.getRequestURI().toString();
        myLogger.setRequestURL(requestURL);

        myLogger.log("controller test");
        logDemoService.logic("testId");
        return "OK";
    }
}

 

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

 

문제가 발생했던 것과 달리 실행해보면 잘 동작하는 것을 확인할 수 있습니다.

코드는 Provider 사용 전과 완전히 동일하고 MyLogger에 Proxy만 붙인 것 뿐인데 어떤 원리로 동작하는 것 일까요?

 

 

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

주입된 MyLogger 클래스를 확인해봅시다.

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

 

myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$8e467dda

출력 결과를 보면 CGLIB라는 라이브러리로 내 클래스를 상속받은 가짜 프록시 객체를 상속받아 주입한 것을 볼 수 있습니다.

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

 

 

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

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

동작 정리

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

특징 정리

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

 

참고 AOP
AOP도 이와 같이 가짜를 통해서 돌아가는 원리입니다.
중요한 점은 클라이언트를 전혀 고치지 않아도 된다는 점 입니다. →  스프링 컨테이너가 가진 강점

 

 

주의점

• 마치 싱글톤처럼 동작하는 것 같지만 다르기 때문에 결국 주의해서 사용해야 합니다.
• 이런 특별한 Scope는 필요한 곳에서 최소한으로 사용해야 합니다. 무분별하게 사용하면 유지보수하기 어려워집니다.

 

---

출처 

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

스프링 핵심 원리 - 기본편 - 인프런 | 강의