웹 스코프

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

이번에는 웹 스코프에 대해 알아보자.

웹 스코프의 특징

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

웹 스코프 종류

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

사실 세션이나, 서블릿 컨텍스트, 웹 소켓 같은 용어를 잘 모르는 분들도 있을 것이다. 여기서는 request 스코프를 예제로 설명하겠다. 나머지도 범위만 다르지 동작 방식은 비슷하다.

request 스코프 예제 만들기

웹 환경 추가

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

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

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

참고:

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

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

server.port = 9090

request 스코프 예제 개발

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

다음과 같이 로그가 남도록 request 스코프를 활용해서 추가 기능을 개발해보자

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

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 create: " + this);
    }
}

• 로그를 출력하기 위한 'MyLogger'클래스이다.
• '@Scope(value = "request")'를 사용해서 request 스코프로 지정했다. 이게 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
• 이 빈이 생성되는 시점에 자동으로 '@PostConstruct'초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다. 이 빈은 HTTP요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
• 이 빈이 소멸되는 시점에 '@PreDestroy'를 사용해서 종료 메세지를 남긴다.
• 'requestURL'은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력 받는다.

스프링 애플리케이션을 실행시키면 오류가 발생한다. 메시지 마지막에 싱글톤이라는 단어가 나오고.. 스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만, request 스코프 빈은 아직 생성되지 않는다. 이 빈은 실제 고객의 요청이 와야 생성할 수 있다.

해결방안 1. Provider

    private final ObjectProvider<MyLogger> myLoggerObjectProvider;


    @RequestMapping("log-demo")
    @ResponseBody
    private String logDemo(HttpServletRequest request) {
        MyLogger myLogger = myLoggerObjectProvider.getObject();
        String requestURL = request.getRequestURL().toString();
        myLogger.setRequestURL(requestURL);

• 'ObjectProvider' 덕분에 'ObjectProvider.getObject()'를 호출하는 시점까지 request scope 빈의 생성을 지연 할 수 있다.
• 'ObjectProvider.getObejct()'를 호출하는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리된다.
• 'ObejctProvider.getObejct()'를 'LogDemoController','LogDemoService'에서 각각 한번 씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다!

해결방안 2. 스코프와 프록시

• 여기가 핵심이다. 'proxyMode = ScopedProxyMode.TARGET_CLASS'를 추가해주자.
  -적용 대상이 인터페이스가 아닌 클래스면 'TARGET_CLASS'를 선택
  -적용 대상이 인터페이스면 'INTERFACES'를 선택
• 이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

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

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

• '@Scope'의 'proxyMode' = ScopedProxyMode.TARGET_CLASS'를 설정하면 스프링 컨테이너는 CGLIB라는 바이트 코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성한다.
• 결과를 확인해보면 우리가 등록한 순수한 MyLogger 클래스가 아니라 'MyLogger$$EnhancerBySpringCGLIB'이라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있다.
• 그리고 스프링 컨테이너에 "myLogger"라는 이름으로 가짜 대신에 이 가짜 프록시 객체를 등록한다
• 'ac.getBean("myLogger",MyLogger.class)'로 조회해도 객체가 조회되는 것을 확인할 수 있다.
• 그래서 의존관계 주입도 이 가짜 프록시 객체가 주입된다
  

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

• 이 가짜 프록시 빈은 내부에 실제 MyLogger를 찾는 방법을 가지고 있다.
• 클라이언트가 'myLogger.logic()'을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.
• 가짜 프록시 객체는 request스코프의 진짜 'myLogger.logic()'를 호출한다.
• 가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다(다형성)

동작 정리

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

특징 정리

• 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있다.
• 사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점이다.
• 단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. 이것이 바로 다형성과 DI컨테이너가 가진 큰 강점이다.
• 곡 웹 스코프가 아니어도 프록시는 사용할 수 있다.

주의점

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

출처:https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC/dashboard