[스프링 핵심 원리] 09. 빈 스코프 - 웹 스코프 & request 스코프 예제 만들기

(인프런) 김영한님의 스프링 핵심 원리-기본편을 공부하고 리뷰한 글입니다.

5. 웹 스코프 

지금까지는 싱글톤, 프로토타입 스코프를 학습했다.

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

 

1. 웹 스코프의 특징 

- 웹 스코프는 웹 환경에서만 동작한다.

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

 

2. 웹 스코프 종류

1) request : HTTP 요청 하나가 들어오고~나갈 때까지 유지되는 스코프

- 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리된다.

2) session : HTTP Session과 동일한 생명주기를 가지는 스코프

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

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

 

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

6. request 스코프 예제 만들기

request 스코프를 예제로 설명하지만 session, application, websocket 도 범위만 다르지 동작 방식은 비슷하다.

1.웹 환경 추가

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

1) build.gradle 에 추가

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

 

2) hello.core.CoreApplication main 메서드 실행 확인

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

3) localhost:8080 실행 확인

 

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

(참고)

1) 웹 라이브러리가 없으면, 스프링 부트는 AnnotationConfigApplicationContext 를 기반으로 애플리케이션을 구동한다.

2) 웹 라이브러리가 추가되면, 웹과 관련된 추가 설정과 환경들이 필요하므로 AnnotationConfigServletWebServerApplicationContext 를 기반으로 애플리케이션을 구동한다.

 

<포트 변경하기>

만약 기본인 8080 포트를 다른 곳에서 사용중이어서 오류가 발생하면 포트를 변경해야 한다.

main/resources/application.properties 에 코드 추가하기

server.port=9090

 

2. request 스코프 예제 개발

동시에 여러 HTTP 요청이 와서 정확히 어떤 요청이 남긴 로그인지 구분하기 어려운 경우, request 스코프를 사용한다.

 

● 기대하는 공통 포멧: [UUID][requestURL] {message}

- UUID: HTTP 요청을 구분하기 위한 목적

- requestURL: 어떤 URL을 요청해서 남은 로그인지 확인하기 위한 목적 

 

1) 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")   // request 스코프로 지정
public class MyLogger {

    private String uuid;        // HTTP 요청을 구분하기 위한 id
    private String requestURL;  // 실제 요청한 URL

    // 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는 request 스코프이므로 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸한다. 

- MyLogger 빈이 생성되는 시점에 자동으로 @PostConstructor 초기화 메서드를 이용해 uuid를 생성해서 저장한다. 이 빈은 HTTP 요청 당 하나씩 생성되므로 uuid로 다른 HTTP 요청과 구분할 수 있다.

- MyLogger 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남긴다.

- requestURL은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 주입받는다.

 

2) LogDemoController

MyLogger가 잘 작동하는지 확인하는 테스트용 컨트롤러다.

package hello.core.web;

import hello.core.common.MyLogger;
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;

// MyLogger 가 잘 작동하는지 확인하는 테스트용 컨트롤러
@Controller
@RequiredArgsConstructor    // 자동 생성자 주입
public class LogDemoController {

    private final LogDemoService logDemoService;
    private final MyLogger myLogger;
    
    // log-demo 요청이 오면 웹 브라우저에 데이터를 문자로 반환
    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        // HttpServletRequest: 클라이언트 요청 정보
        String requestURL = request.getRequestURL().toString(); // 클라이언트가 요청한 URL 반환
        myLogger.setRequestURL(requestURL); // myLogger 의 requestURL 에 값 저장

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

}

 

- log-demo 요청이 들어오면 @RequestBody로 데이터를 문자로 반환하도록 한다. (@RequestBody에 대한 설명은 여기서)

- HttpServerletRequest 를 통해 클라이언트가 요청한 URL을 myLogger의 requestURL에 저장한다.

e.g requestURL = http://localhost:8080/log-demo

- 컨트롤러에서 controller test라는 로그를 남긴다.

 

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

 

3) LogDemoService 추가

비즈니스 로직이 있는 서비스 계층이다.

 

 

<MyLogger를 request 스코프로 설정한 이유>

만약 request 스코프를 사용하지 않고 logic(...) 파라미터로 모든 정보(uuid, requestURL)을 서비스 계층에 넘긴다면, 

1) 파라미터가 많아서 코드가 지저분해진다. 

2) requestURL 같은 웹과 관련된 정보가 웹과 관련이 없는 서비스 계층까지 넘어가게 된다. 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다. 서비스 계층은 웹 기술에 종속되지 않고 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.

 

4) 기대하는 출력

 

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

스프링 애플리케이션을 실행시키면 아래 코드에서 오류가 발생한다. 

// MyLogger 가 잘 작동하는지 확인하는 테스트용 컨트롤러
@Controller
@RequiredArgsConstructor    // 자동 생성자 주입
public class LogDemoController {

    private final LogDemoService logDemoService;
    private final MyLogger myLogger;
    ...
}

logDemoController 빈 생성 시점에 @RequiredArgsConstructor 를 통해 logDemoService와 myLogger에 자동으로 생성자 주입이 일어난다. logDemoService는 싱글톤 빈이라 문제가 없지만, myLogger 는 request 스코프이기 때문에, HTTP 요청(Http Request)가 와야 생성된다. 즉, 아직 생성되지 않은 빈을 자동으로 의존관계 주입을 하려고 하면서 오류가 생긴 것이다.

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

---

9-6. request 스코프 예제 만들기 질문 정리

Q. 내장 톰켓 서버는 어떻게 스프링 컨테이너와 엮이는가?

A. 스프링 부트의 main() 실행 → 내부에 있는 tomcat-embed-core.jar(내장 톰켓 라이브러리)를 실행, 스프링 컨테이너 생성 →​ 자동으로 둘을 엮음

build.gradle에 설정한 'spring-boot-starter-web'을 사용하면 내장 톰켓 라이브러리도 함께 다운된다.

[출처] https://www.inflearn.com/questions/160741