Post

[Lecture - 김영한님(스프링 핵심 원리 - 기본편)] 웹 스코프

Posted
By Yn3 9 min read

inflearn에서 김영한님 강의를 들으면서 내용을 정리해보자.
스프링 핵심 원리 - 기본편

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

웹 스코프의 특징

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

웹 스코프 종류

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

request 스코프를 예제로 설명한다. 나머지는 범위만 다르지 동작 방식은 비슷하다.


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

request 스코프

request 스코프 예제

웹 환경 추가

웹 스코프는 웹 환경에서만 동작하므로 web 환경이 동작하도록 gradle에 implementation 'org.springframework.boot:spring-boot-starter-web' 라이브러리를 추가해야 한다.

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

1
2

Tomcat started on port 8080 (http) with context path ''
Started CoreApplication in 0.902 seconds (process running for 1.317)

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

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

만약 기본 포트인 8080 포트를 다른 곳에서 사용중이어서 오류가 발생하면 포트를 변경해야 한다. 예를 들어 9090 포트로 변경하려면 main/resources/application.properties에 server.port=9090 설정을 추가하면 된다.

예제 개발

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

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


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

@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() {
        String 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로 입력 받는다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

@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";
    }
}
  • 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러이다.
  • 여기서 HttpServletReqeust를 통해서 요청 URL을 받았다.
    • requestURL 값 http://localhost:8080/log-demo
  • 이렇게 받은 requestURL 값을 myLogger에 저장해둔다.
    • myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.
  • 컨트롤러에서 controller test라는 로그를 남긴다.

requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다.
여기서는 예제를 단순화한 것이다.


1
2
3
4
5
6
7
8
9
10

@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의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.


실제 기대와 다르게 애플리케이션 실행 시점에 아래와 같은 오류가 발생했다.

1
2

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를 사용하는 것이다.

Lecture - 김영한님(스프링 핵심 원리 - 기본편)
lecture inflearn 김영한님 스프링 핵심 원리 - 기본편 spring spring boot request scope
This post is licensed under CC BY 4.0 by the author.

© Yn3. Some rights reserved.