빈 스코프 - 웹 스코프

◎ 웹 스코프

-> 웹 환경에서만 동작한다.

-> 웹 스코프는 스프링이 해당 스코프의 종료시점까지 관리하며 종료 메서드가 호출된다.

 

◎ 웹 스코프 종류

-> request : HTTP 요청이 들어오고 나갈 때 까지 유지되는 스코프로 각각의 HTTP 요청마다 별도의 빈 인스턴스를 생성한다.

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

- 클라이언트 A와 B가 동시에 HTTP request를 요청한다면 위 그림과 같이 별도의 빈 인스턴스가 생성되고 관리된다.

-> session : HTTP session과 동일한 생명주기를 가지는 스코프

-> application : 서블릿 컨텍스트(ServletContext)와 동일한 생명주기를 가지는 스코프

-> websocket :  웹 소켓과 동일한 생명주기를 가지는 스코프

 

◎ request 스코프 만들기

-> 웹 스코프는 웹 환경에서만 동작한다. web 환경이 동작하도록 build.gradle에 라이브러리를 추가한다,

-> 라이브러리를 추가하고 애플리케이션을 실행하면 웹 애플리케이션이 실행된다.

-> 실행해보면 기존 실행 로그에 추가적으로 Tomcat started~ 로그가 추가되었다. 이제 웹 애플리케이션이 실행되었다.

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

 

※ 참고

- web 라이브러리 사용 전까지는 AnnotationConfigApplicationContext를 기반으로 애플리케이션이 구동되었다. web 라이브러리가 추가된 이후에는 AnnotationConfigServletWebServerApplicationContext를 기반으로 애플리케이션이 구동된다.

 

-> 동시에 여러 HTTP request 요청이 들어오면 어떤 요청이 남긴 로그인지 구분하기 어렵다. 이 때 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

- 이런 로그가 남도록 request 스코프를 사용하여 개발한다.

-> 기대하는 공통 포맷 : [＊UUID][requestURL][message]

＊UUID : 소프트웨어 구축에 쓰이는 식별자 표준(범용 고유 식별자(UUID))

-> UUID를 통해 HTTP 요청을 구분한다.

-> requestURL 정보도 추가하여 어떤 URL을 요청해서 남은 로그인지 확인한다.

 

MyLogger

 

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") // request 스코프 - HTTP 요청 당 하나씩 빈이 생성되며 HTTP 요청이 끝나는 시점에 소멸된다.
public class MyLogger { // 로그를 출력하기 위한 클래스
    private String uuid;
    private String requestURL;

    public void setRequestURL(String requestURL) { // 해당 빈이 생성되는 시점에는 알 수 없기 때문에 setter로 외부에서 입력받음
        this.requestURL = requestURL;
    }

    public void log(String message) {
        System.out.println("[" + uuid + "]" + "[" + requestURL + "] " + message);
    }

    @PostConstruct
    public void init(){ // 초기화 메서드
        uuid = UUID.randomUUID().toString(); // uuid를 생성하여 저장한다.
        System.out.println("[" + uuid + "] request scope bean create:" + this);
    }

    @PreDestroy
    public void close(){ // 소멸 메서드
        System.out.println("[" + uuid + "] request scope bean close:" + this);
    }
}

 

LogDemoController

 

import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import practice.core.common.MyLogger;

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) { // HttpServletRequest를 통해 요청 URL(http://localhost:8080/log-demo)을 받는다.
        String requestURL = request.getRequestURL().toString();
        myLogger.setRequestURL(requestURL); // requestURL 값을 myLogger에 저장

        myLogger.log("controller test"); // 로그를 남긴다.
        logDemoService.logic(testId);
        return "OK";
    }
}

 

LogDemoService

 

@Service
@RequiredArgsConstructor
public class LogDemoService { // 서비스 계층
    private final MyLogger myLogger;

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

- request 스코프를 사용하지 않고 파라미터로 모든 정보를 서비스 계층으로 넘기면 파라미터가 많아져서 코드가 복잡해진다. 또한 requestURL 같은 서비스 계층과는 관련이 없는 정보도 서비스 계층에서 다뤄야한다. 

- 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다.

- 서비스 계층은 웹 기술에 종속되지 않고, 순수하게 유지해야 유지보수에도 좋다.

- request 스코프의 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;

- 이대로 애플리케이션을 실행하면 에러가 발생한다.

- 스프링 애플리케이션을 실행하는 시점에서 싱글톤 빈은 생성해서 주입이 가능하지만, request 스코프 빈은 아직 생성된 상태가 아니라서 에러가 발생하였다.

- 지금까지 만든 request 스코프 빈은 실제 클라이언트의 요청이 들어와야 실행이 되는 것이다. 현재 요청이 들어오지 않은 상태라서 request 스코프 빈이 생성되지 않았는데 사용하려고 하니 문제가 발생한 것이다.

- 따라서 request 스코프 빈을 스프링 컨테이너에 요청하는 것을 의존관계 주입 시점이 아닌 실제 클라이언트 요청이 들어오는 시점으로 미뤄야 한다.

 

☆ 참고

[인프런]스프링 핵심 원리 - 기본편