Spring / Web 스코프

웹 스코프

이전 포스팅에서 설명한 싱글톤, 프로토타입 외에 한가지 스코프가 더 있습니다. 바로 웹 환경에서 사용되는 웹 스코프입니다.

웹 스코프 특징

1. 웹 환경에서만 동작

2. 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리하기 때문에 종료 메소드가 호출된다.

 

웹 스코프 종류

1. request : HTTP 요청이 하나 들어오고 나갈 때 까지 유지되는 스코프, 각 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리된다.

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

3. application : ServletContext와 동일한 생명 주기를 가지는 스코프

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

 

이 포스팅에서는 request에 대한 스코프를 예를 들어보겠습니다.

 

request scope 예시 그림

request scope는 HTTP 요청이 들어올 때 마다 빈 인스턴스가 생성되고 관리되는 스코프입니다.

 

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 위한 예제를 request scope를 사용해서 만들어 보도록 하겠습니다.

 

예를들어 클라이언트 A가 http 요청을 시도했을 때,

[UUID] request scope bean created

[UUID] [requestURL] controller test

[UUID] [requestURL] service id = testId

[UUID] request scope bean closed

와 같은 로그를 남겨보도록 하겠습니다.

 

여기서 UUID는 universally unique identifier로 각 클라이언트를 식별할 수 있는 고유 아이디로 유저간 겹칠일이 없다고생각하시면 됩니다.

 

우선 Controller와 Service에서 Client 전용 request scope를 제공하기 위한 Logger를 만들어야겠죠.

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 msg)
    {
        System.out.println("["+uuid+"]"+"["+requestURL+ "] "+ msg );
    }

    @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);
        System.out.println();
    }
}

• request Scope이기 때문에 @Scope(value="request")로 설정해주었습니다.
• 컨테이너에 등록하기 위해 @Component를 설정해주었습니다.
• 각 logger는 고유의 uuid와 requestURL를 가지기 때문에 private하게 설정해주었습니다.
• logger가 수행하는 log 메소드는 자신의 uuid와 requestURL와 msg를 출력합니다.
• 생성되는 시점에 자동으로 @PostConstruct 초기화 메소드를 사용해서 uuid를 생성해서 저장해주었습니다.
• 소멸되는 시점에 @ProDestroy를 사용해서 종료 메시지를 남겼습니다.
• requestURL은 이 빈이 생성되는 시점에서 알 수 없죠? 요청이 어느 URL에서 들어오는지는 동적으로 정해지니까요. 그래서 setter 주입을 했습니다.

 

이제 Controller와 Service를 만들어보겠습니다.

 

우선 Controller입니다.

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
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 logger;
    
    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request)
    {
        String requestURL = request.getRequestURL().toString();
        logger.setRequestURL(requestURL);
        logger.log("controller test");
        logDemoService.logic("testID");
        return "OK";
    }
}

 

Controller는 그림은 보면 알 수 있듯이 Service와 Logger에 대한 의존관계를 가지고 있기 때문에 의존관계 주입을  final에 대한 의존관계를 자동으로 주입해주는 @RequiredArgsConstructor로 설정해주었습니다.

 

@RequestMapping을 사용해서 요청받을 url을 설정해주었습니다.

@ResponseBody

클라이언트 -> 서버로 통신하는 메시지를 request 메시지라고 하고 

서버 -> 클라이언트로 통신하는 메시지를 response 메시지라고 합니다.

 

즉, log-demo URL 요청이 오면 서버에서 클라이언트로 logDemo 메소드의 리턴형태인 String을 리턴해줍니다.

 

logDemo method

- HttpServletRequest를 통해서 요청 URL을 받은 후 requestURL값을 logger에 저장해두었습니다.

 

Service

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 logger;
    public void logic(String testID) {
        logger.log("service id = " + testID);
    }
}

 

서비스에서는 오직 Logger에게만 의존관계를 갖고 있습니다.

Service 로직임을 알려주기 위해 @Service 어노테이션으로 등록했고, @Service 어노테이션을 쓰면 컴포넌트로 자동 등록이 됩니다.

 

 

이제 모든 준비가 끝났습니다.

애플리케이션을 실행해보겠습니다.

실행해보면 기대와 다르게 실행하면 오류가 발생합니다.

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요청이 실제로 들어와야 빈이 생성될 수 있는데 실제요청이 없어 오류가 나는 듯 합니다.

 

하지만 앞에서 배운 Provider를 사용해서 request를 만들어주면 되겠죠?

만들어보겠습니다.

 

Controller

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
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 ObjectProvider<MyLogger> myloggerProvider;

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request)
    {
        String requestURL = request.getRequestURL().toString();
        MyLogger logger = myloggerProvider.getObject();
        logger.setRequestURL(requestURL);
        logger.log("controller test");
        logDemoService.logic("testID");
        return "OK";
    }
}

 

Service

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class LogDemoService {
    private final ObjectProvider<MyLogger> myloggerProvider;
    public void logic(String testID) {
        MyLogger logger = myloggerProvider.getObject();
        logger.log("service id = " + testID);
    }
}

 

자 이제 애플리케이션을 실행해보면

 

로그가 남는것을 확인할 수 있습니다.

 

> ObjectProvider 덕분에 ObjectProvider.getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있습니다.

> 또 호출하는 시점에는 HTTP요청이 진행중이므로 request scope 빈 생성이 정상 처리됩니다.

> ObjectProvider.getObject()를 LogDemoController, LogDemoService에서 각각 한번씩 따로 호출해도 같은 HTTP요청이면 같은 스프링 빈이 반환됩니다.

 

 

이 방법 외에도 프록시 방법이 존재하는데 프록시 방식을 사용해보겠습니다.

---

프록시 방식

코드를 먼저 살펴보면 

@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {

MyLogger 클래스에 Scope 어노테이션의 파라미터로 proxyMode를 추가해주면 됩니다.

적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS

적용 대상이 인터페이스면 INTERFACES를 선택합니다.

 

이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있습니다.

 

+ Service, Controller 단계의 ObjectProvider는 원래 MyLogger로 바꿔주어야 합니다.

 

실행해보면 잘 동작하는 것을 볼 수 있습니다.

---

프록시 동작 원리

 

@Scope의 proxyMode = ScopedProxyMode.TARGET_CLASS 를 설정하면 스프링 컨테이너는 CGLIB라는 바이트코드를 조작하는 라이브러리를 사용해서 MyLogger를 상속받은 가짜 프록시 객체를 생성합니다.

 

Mylogger.getClass()를 출력해보면 순수 MyLogger 클래스가 아니라 EnhancerBySpringCGLIB라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있습니다.

 

▶︎ 이렇게 가짜 프록시 객체가 스프링 컨테이너에 등록되고, 의존관계 주입도 이 가짜 프록시 객체가 주입됩니다.

 

하지만 가짜 프록시 객체는 request가 오면 그 때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있습니다!

가짜 프록시 객체는 내부에 진짜 logger를 찾는 방법을 알고 있어서

클라이언트가 logger.logic()을 호출하면 사실 표면상으로는 가짜 프록시 객체의 메소드를 호출한 것이지만,

가짜 프록시 객체가 request scope의 진짜 logger.logic()을 호출합니다.

 

+ 가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다(다형성)

 

동작 정리

• CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어 주입한다.
• 실제 요청이 오면 실제 빈을 요청하는 위임 로직이 들어있다.
• 가짜 프록시 객체는 실제 request scope와 관계가 없고, 그냥 가짜임. 내부에 단순 위임 로직만 있고 싱글톤처럼 동작.

특징 정리

• 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯 편하게 request scope를 사용할 수 있음.
• Provider를 사용하던, 프록시를 사용하던 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점!

• 어노테이션 설정 변경 만으로 원본 객체를 프록시 객체로 대체 가능 -> 다형성과 DI 컨테이너가 가지는 큰 장점.
• 웹 스코프가 아니여도 프록시는 사용가능.

주의점

• 싱글톤을 사용하는 것 같지만, 다르게 동작하기 때문에 결국 주의해서 사용하자.
• 이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용하자. 무분별하게 사용하면 유지보수가 어렵다.

<참고자료>

https://mungto.tistory.com/436

[Spring] @RequestMapping이란?

 

https://cheershennah.tistory.com/179

[Spring] @RequestBody / @ResponseBody 어노테이션 이란?