[Spring] request 스코프 예제 만들기

웹 환경 추가

 

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

 

"build.gradle에 추가"

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

이제 CoreApplication.java에서 main 메서드를 실행하면 다음과 같이 나온다

 

 

 

이제 주소창에 "localhost:8080"을 입력하면 다음과 같은 오류 페이지가 뜨면 된다

 

 

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

 

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

'AnnotationConfigServletApplicationContext'를 기반으로 애플리케이션을 구동한다.

만약 기본 포트인 8080 포트를 다른 곳에서 사용중이어서 오류가 발생하면 포트를 변경해야한다. 9090 포트로 변경하려면 다음 설정을 추가하자.

 

"main/resources/application.properties"

server.port=9090

 

 

request 스코프 예제 개발

 

동시에 여러 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

• 기대하는 공통 포멧 : [UUID][requestURL]{message}
• UUID를 사용해서 HTTP 요청을 구분하자
• requestURL 정보도 추가로 넣어서 어떤 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();
        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 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;

    // @ResponseBody를 사용하면 넘겨온 문자를 그대로 보낼 수 있다.
    @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 값 : 'http://localhost:8080/log-demo'
• 이렇게 받은 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 testId) {
        myLogger.log("service id = " + testId);
    }
}

• 비즈니스 로직이 있는 서비스 계층에서도 로그를 출력해보자.
• 여기서 중요한 점이 있다. request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아서 지저분해진다. 더 문제는 requestURL 같은 웹과 관련된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다. '웹과 관련된 부분은 컨트롤러까지만 사용해야 한다. 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.
• request scope의 MyLogger 덕분에 이런 부분을 파라미터로 넘기지 않고, 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 스코프 빈은 아직 생성되지 않는다.

이 빈은 실제 고객의 요청이 와야 생성할 수 있다!