웹 스코프

웹 스코프

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

웹 스코프 종류

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

HTTP request 요청 당 각각 할당되는 request 스코프

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

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

예제 코드

@Component
@Scope(value = "request")
@Setter
public class MyLogger {

    private String uuid;
    private String 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로 입력 받는다.

@RestController
@RequiredArgsConstructor
public class MyLoggerController {

    private final LogService logService;
    private final MyLogger myLogger;

    @GetMapping("log-demo")
    public String logDemo(HttpServletRequest request) {
        final String requestURL = request.getRequestURL().toString();
        myLogger.setRequestURL(requestURL);

        myLogger.log("controller test");
        logService.logic("testId");
        return "OK";

    }
}

• Logger가 잘 작동하는지 확인하는 테스트용 컨트롤러다.
• HttpServletRequest를 통해서 요청 URL을 받았다.
• 이렇게 받은 requestRRUL 값을 myLogger에 저장해준다.
• myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.
• 컨트롤러에서 controller test라는 로그를 남긴다.

cf) requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서플릿 필터 같은 곳을 활용하는 것이 좋다.

@Service
@RequiredArgsConstructor
public class LogServiceImpl implements LogService{

    private final MyLogger myLogger;

    @Override
    public void logic(String id) {
        myLogger.log("service id = " + id);
    }
}

• 비즈니스 로직이 있는 서비스 계층에도 로그를 출력하도록 했다.
• 여기서 중요한 점은 request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면 파라미터가 많아 지저분해진다.
• 더 문제는 requestURL 같은 웹과 관련된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다.
• 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다.
• 서비스 계층은 웹 기술에 종속되지 않고 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.
• request scope의 MyLogger 덕분에 이런 부분을 파라미터로 넘기지 않고 MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

발생하는 오류

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 스코프 빈은 아직 생성되지 않았다.
• 이 빈은 실제 고객의 요청이 와야 생성할 수 있다.

Scope와 Provider

• 첫번째 해결방안은 Provider를 사용하는 것이다.

예제 코드

@RestController
@RequiredArgsConstructor
public class MyLoggerController {

    private final LogService logService;
    //    private final MyLogger myLogger;
    private final ObjectProvider<MyLogger> myLoggerProvider;

    @GetMapping("log-demo")
    public String logDemo(HttpServletRequest request) {
        final MyLogger myLogger = myLoggerProvider.getObject();
        final String requestURL = request.getRequestURL().toString();
        myLogger.setRequestURL(requestURL);

        myLogger.log("controller test");
        logService.logic("testId");
        return "OK";

    }
}


@Service
@RequiredArgsConstructor
public class LogServiceImpl implements LogService{

//    private final MyLogger myLogger;
    private final ObjectProvider<MyLogger> myLoggerProvider;

    @Override
    public void logic(String id) {
        final MyLogger myLogger = myLoggerProvider.getObject();
        myLogger.log("service id = " + id);
    }
}

실행 결과

[2b812661-bcce-492b-99a1-12b6b41a33a3] request scope bean create: hyun6ik.corerepeat.domain.logger.MyLogger@7b5f7b99
[2b812661-bcce-492b-99a1-12b6b41a33a3][http://localhost:8080/log-demo]controller test
[2b812661-bcce-492b-99a1-12b6b41a33a3][http://localhost:8080/log-demo]service id = testId
[2b812661-bcce-492b-99a1-12b6b41a33a3] request scope bean close: hyun6ik.corerepeat.domain.logger.MyLogger@7b5f7b99

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

Scope와 Proxy

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

    private String uuid;
    private String 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);

    }
}

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

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

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

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

동작 정리

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

특징 정리

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