[Spring] 웹 스코프와 request

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

 

그리고 두개와 다른 웹스코프라는 것이 존재한다.

 

웹 스코프의 특징

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

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

 

웹 스코프 종류

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

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

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

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

 

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

@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
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);
    }
}

프록시를 이용하여 구현한다.

프록시를 사용하지 않으면 스프링 어플리케이션을 실행하는 시점에 request 스코프 빈은 아직 생성되지 않아 실행되지 않는다.

- proxyMode = ScopedProxyMode.TARGET_CLASS를 추가한다.

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

    - 적용 대상이 인터페이스면 INTERFACES를 선택

 

 

LogDemoController

@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";
    }
}

- 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러이다.

- 여기서 HttpServletRequest를 통해서 요청 URL을 받았다.

    - requestURL값 http://localhost:8080/log-demo

- 이렇게 받은 requestURl값을 myLogger에 저장해둔다. myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.

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

 

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

 

LogDemoService

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

 

실행해보면 잘 동작하는 것을 확인할 수 있다.

 

웹 스코프와 프록시 동작 원리

 

먼저 주입된 myLogger를 확인해보자

 

myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726d

 

CGLIB라는 라이브러리로 내 클래스를 상속받은 가짜 프록시 객체를 만들어서 주입한다.

 

 

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

- 가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다.

- 클라이언트가 myLogger.logic() 을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.

- 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic() 를 호출한다.

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

 

동작 정리

- CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.

- 이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.

- 가짜 프록시 객체는 실제 request scope와는 관계가 없다. 그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작한다.

 

특징 정리

- 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있다.

- 사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점이다.

- 단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. 이것이 바로 다형성과 DI 컨테이너가 가진 큰 강점이다.

- 꼭 웹 스코프가 아니어도 프록시는 사용할 수 있다.

 

주의점

- 마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.

- 이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수하기 어려워진다.

 

출처 : 스프링 핵심 원리 - 기본편 - 인프런 | 학습 페이지 (inflearn.com)