웹 스코프

웹 스코프

특징

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

종류

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

request 스코프 예제 만들기

웹 환경 추가

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

build.gradle 추가

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

request 스코프 예제 개발

package hello.core.common;

import ...

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

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

package hello.core.web;

import ...

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

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

requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다. 여기서는 예제를 단순화하기 위해 컨트롤러를 사용했다.

package hello.core.web;

import ...

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final MyLogger myLogger;

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

비즈니스 로직이 있는 서비스 계층에서도 로그를 출력해보자.

실행을 해보면 오류가 발생한다.

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

스코프와 Provider

package hello.core.web;

import ...

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final ObjectProvider<MyLogger> myLoggerProvider;

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

package hello.core.web;

import...

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 myLogger = myLoggerProvider.getObject();
        myLogger.setRequestURL(requestURL);

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

[ca1aff21-988f-4fc5-a67b-f3cd57945a2c] request scope bean create:hello.core.common.MyLogger@4cafa7a4
[ca1aff21-988f-4fc5-a67b-f3cd57945a2c][http://localhost:8080/log-demo] controller test
[ca1aff21-988f-4fc5-a67b-f3cd57945a2c][http://localhost:8080/log-demo] service id = testId
[ca1aff21-988f-4fc5-a67b-f3cd57945a2c] request scope bean close:hello.core.common.MyLogger@4cafa7a4

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

스코프와 프록시

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

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

나머지 코드를 Provider 사용 이전으로 돌려주자.

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

System.out.println("myLogger = " + myLogger.getClass());

myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$954ab5c0

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

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

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

"정리"

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

"주의점"

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