개인 공부/인프런

[Spring] Web Scope

planting grass 2023. 5. 14. 13:24
728x90

해당 글은 김영한 스프링 핵심 원리 - 기본편을 보고 요약, 정리하며 개인적인 견해가 들어간 글입니다.

웹 스코프

지금까지 싱글톤과 프로토타입 스코프를 학습했다. 싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 매우 긴 스코프이고, 프로토타입은 생성과 의존관계 주입, 그리고 초기화까지만 진행하는 특별한 스코프이다.

이번에는 웹 스코프에 대해서 알아보자

웹 스코프의 특징

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

웹 스코프 종류

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

사실 세션이나, 서블릿 컨텍스트, 웹 소켓 같은 용어를 잘 모르는 분들도 있을 것이다. 여기서는 request 스코프를 예제로 설명하겠다. 나머지도 범위만 다르지 동작 방식은 비슷하다.

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

  1. 클라이언트 A나 B로부터 HTTP request 요청이 들어옵니다.
  2. 스프링 DI 컨테이너는 새로운 request 스코프를 생성하고 해당 요청과 관련된 데이터를 저장하기 위한 공간을 할당합니다.
  3. Controller@x01이 요청을 받고, 해당 요청을 처리하기 위해 A전용@x03 또는 B전용@x04를 참조합니다.
  4. A전용@x03 또는 B전용@x04는 request 스코프 내에 위치하므로, 요청에 따라 해당 스코프에서 데이터를 가져올 수 있습니다.
  5. Controller@x01은 Service@x02를 참조하여 필요한 작업을 수행합니다. 이 때, A전용@x03 또는 B전용@x04에 저장된 데이터를 사용할 수 있습니다.
  6. 요청 처리가 완료되면, 스프링 DI 컨테이너는 해당 request 스코프를 제거합니다. 이는 요청과 관련된 데이터를 정리하고, 스코프 내에 할당된 리소스를 해제하는 역할을 수행합니다.
  7. 다음 요청이 들어오면, 스프링 DI 컨테이너는 새로운 request 스코프를 생성하고 해당 요청과 관련된 데이터를 저장할 공간을 할당합니다. 이후 앞선 단계를 반복하여 요청을 처리합니다.

그림 요약

스프링 DI 컨테이너 내에서 HTTP request 요청이 발생할 때마다 독립된 request 스코프를 먼저 생성하고, 해당 스코프 내에서 컴포넌트들이 동작하는 것을 나타낸다.

각각의 요청은 자신만의 스코프를 가지며, 해당 스코프 내에서 필요한 데이터와 리소스를 공유하며 작업을 수행한다.

이를 통해 각 요청이 독립적으로 처리되고, 다른 요청과의 상호작용을 방지할 수 있다.

request 스코프 예제 만들기

웹 환경 추가

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

implementation 'org.springframework.boot:spring-boot-starter-web'

이후 리프레쉬하여 라이브러리를 다운받고 main폴더에 CoreApplication를 실행시키고 localhost:8080으로 들어가면 아래와 같이 오류 페이지가 나오면 잘 진행되고 있다는 뜻이다.

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

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

request 스코프 예제 개발

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

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

  1. UUID를 사용해서 HTTP 요청을 구분한다.
  2. requestURL 정보도 추가로 넣어 어떤 URL을 요청해서 남은 로그인지 확인하자.

MyLogger

main폴더에 common패키지를 생성하고 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);
    }
}
  • 로그를 출력하기 위한 MyLogger 클래스이다.
  • @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.web.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 값을 myLogger에 저장해둔다. myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.
  • 컨트롤러에서 controller test라는 로그를 남긴다.

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

LogDemoService 추가

package hello.core.web;

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 덕분에 이런 부분을 파라미터로 넘기지 않고, MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다

실행 결과

스프링 애플리케이션을 실행 시키면 오류가 발생한다.

스프링의 'request' 스코프는 웹 애플리케이션의 DispatcherServlet에서 요청을 처리하는 동안에만 활성화된다.

따라서 myLogger ****빈은 DispatcherServlet 내에서만 사용되어야 한다.

현재 코드에서는 myLogger 빈을 싱글톤으로 사용하고 있는데, 싱글톤 빈은 애플리케이션 시작 시점에 생성되므로 웹 요청이 아직 없는 초기화 단계에서도 생성된다.

이로 인해 'request' 스코프를 사용하는 myLogger 빈이 웹 요청과 관련된 속성에 접근하려고 할 때 해당 에러가 발생한다.

728x90
저작자표시