Web scope

웹 스코프

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

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

웹 환경 추가

웹 스코프는 웹 환경에서 구동된다. 웹 환경이 돌아갈 수 있도록 라이브러리를 추가해준다.

• build.gradle에 dependency 추가
  이 라이브러리를 추가하면 스프링 부트는 내장 톰캣 서버를 활용해서 웹 서버와 스프링을 함꼐 실행시킨다.

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

• 포트 번호 충돌날 경우
  main/resources/application.properties에서 아래와 같은 설정을 추가하면 된다.

server.port=12345

request 스코프

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어려운데, 이 경우에 사용하기 좋은 것이 바로 request 스코프이다.

request 스코프를 활용한 로그 남기기 예제

• 로그 포맷 : [UUID][requestURL] {message}
• 유니크한 UUID를 사용해서 HTTP 요청을 구분할 수 있도록 하고, requestURL 정보도 넣어 어떤 URL에서 요청을 했는지 확인할 수 있다.
• 클래스 하나를 생성하여 @Scope("request")로 지정해두면 이 빈은 HTTP 요청당 하나씩 생성되고 HTTP 요청이 끝나면 사라진다.

   @Component
   @Scope(value = "request")
   public class Logger {...}

• @PostConstruct를 사용해서 빈이 생성되는 시점에 UUID를 생성하여 저장하도록 한다.

   @PostConstruct
   public void init() {
       uuid = UUID.randomUUID().toString();
   }

• 웹 스코프의 빈은 소멸 메서드도 호출되므로 @PreDestory를 사용하여 종료 메시지를 남기도록 한다.

   @PreDestory
   public void close() {
       System.out.println("close");
   }

• requestURL은 빈이 생성되는 시점을 알 수 없기 때문에, 외부에서 입력받을 수 있도록 setter 메서드를 만들어 놓는다.

   public void setRequestURL(String requestURL) {
           this.requestURL = requestURL;
   }

• Logger가 잘 작동하는지 알아보기 위해 Controller를 작성한다.

   @Controller
   @RequiredArgsConstructor
   public class LogController{...}

• HttpServletRequest로 request URL를 받아오고, 그 값을 Logger로 넘긴다.
  • requestURL : http://localhost:8080/log-demo

   @RequestMapping("log-demo")
   @ResponseBody
   public String logDemo(HttpServletRequest request) {
      String requestURL = request.getRequestURL().toString();
      Logger.setRequestURL(requestURL);
      ...
   }

참고
requestURL은 Logger에 저장하는 부분은 컨트롤러보다 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다! (예제이기 때문에...)

• 비즈니스 로직이 있는 서비스 계층 생성

   @Service
   @RequiredArgsConstructor
   public class LogService {...}

• request 스코프를 사용하지 않고 파라미터로 이 모든 정보들을 서비스 계층으로 넘기면, 파라미터가 많아서 지저분해지게 되고, requestURL처럼 웹 관련 정보가 웹과 관련없는 서비스 계층으로 넘어가게 되는 문제가 있다. 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다.
  서비스 계층은 웹 기술에 종속되지 않고 순수하게 유지하는 것이 유지보수 관점에서 좋다.

  • request 스코프의 Logger 덕분에 이런 부분을 파라미터로 넘기지 않고도 Logger의 멤버 변수에 저장할 수 있으므로 코드와 계층을 깔끔하게 유지할 수 있다.

• 아직은 오류가 발생한다!
  스프링 컨테이너에게 request 스코프 빈을 요청하고 의존관계를 주입하려 했으나 HTTP request 자체가 오질 않았기 때문에 request 스코프의 빈이 생성되지 않는 것이다.(실제 고객의 요청이 와야 빈이 생성된다.)
  스프링 컨테이너에게 빈을 요청하는 단계를 실제 고객의 요청이 들어왔을 때로 미루어야 한다.