웹 스코프

웹 스코프는 웹 애플리케이션에서 객체의 생명주기를 관리하는 스코프 중 하나다. 이는 객체가 생성되고, 언제 사용되고 언제 파기되는지를 관리한다.

웹 스코프의 특징

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

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

웹 스코프의 종류

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

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

• apllication: 서블릿 컨텍스트와 동일한 생명주기를 가지는 스코프

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

request 스코프

먼저 웹 스코프는 웹 환경에서만 동작하기 때문에 web 라이브러리를 추가해줘야 한다.

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

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

• 기대하는 공통 포멧: [UUID][requestURL][message]

• UUID를 사용해서 HTTP 요청을 구분

• requestURL 정보도 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인

package hello.core.common;

...

@Component
@Scope(value = "request") // request 스코프로 지정
public class MyLogger {
    private String uuid;
    private String requsetURL;

    public void setRequsetURL(String requsetURL) { // URL 설정
        this.requestURL = requsetURL;
    }

    public void log(String message) { // 로그를 찍는 함수
        System.out.println("[" + uuid + "]" + "[" + requsetURL + "] " + 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로 입력받는다.

package hello.core.web;

@Controller
@RequiredArgsConstructor // lombok에서 final이 붙은 객체를 참고해서 생성자를 자동으로 만들어준다
public class LogDemoController {

    private final LogDemoService logDemoService;
    private final ObjectProvider<MyLogger> myLoggerProvider; // myLogger를 찾을 수 있는 DL

    @RequestMapping("log-demo") // request 요청 URL
    @ResponseBody // 반환하는 문자를 그대로 보낸다
    public String logDemo(HttpServletRequest request) { // http request 정보를 받는다
        String requestURL = request.getRequestURL().toString(); // requestURL을 가져온다
        MyLogger myLogger = myLoggerProvider.getObject(); // myLogger를 찾아온다 이 시점에서 myLogger 빈이 최초로 생성된다
        myLogger.setRequsetURL(requestURL);

        myLogger.log("controller test"); // 로그 출력
        logDemoService.logic("testId");
        return "OK";
    }
}

로거 작동 확인 테스트용 컨트롤러다. 여기서 HttpServletRequest를 통해서 요청 URL을 받았다.(http://localhost:8080/log-demo)

이렇게 받은 requestURL 값을 myLogger에 저장해둔다. myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다. 컨트롤러에서 Controller test라는 로그를 남긴다.

package hello.core.web;

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final ObjectProvider<MyLogger> myLoggerProvider; // myLogger를 찾을 수 있는 DL

    public void logic(String id) {
        MyLogger myLogger = myLoggerProvider.getObject(); // myLogger를 찾아온다
        myLogger.log("service id = " + id);
    }
}

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

여기서 중요한 점은 request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면 파라미터가 많아서 지저분해진다. 더 문제는 requestURL 같은 웹과 관려된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다. 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다. 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지되는 것이 유지보수 관점에서 좋다.

request scope의 MyLogger 덕분에 이런 부분을 파라미터로 넘기지 않고, MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

[ea43a69c-26f9-4752-a441-36d8eea93204] request scope bean create: hello.core.common.MyLogger@316472aa
[ea43a69c-26f9-4752-a441-36d8eea93204][http://localhost:9090/log-demo] controller test
[ea43a69c-26f9-4752-a441-36d8eea93204][http://localhost:9090/log-demo] service id = testId
[ea43a69c-26f9-4752-a441-36d8eea93204] request scope bean close: hello.core.common.MyLogger@316472aa

이제 동작을 확인할 수 있는데 ObjectProvider 덕분에 getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.

ObjectProvider.getObject()를 호출하는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리된다. 컨트롤러와 서비스에 각각 한번씩 따로 요청하지만 같은 HTTP 요청이라면 같은 스프링 빈이 반환된다.

스코프와 프록시

프록시 방식을 사용해본다.

proxyMode 속성은 Spring의 프록시 동작을 설정하는데 사용된다. 이는 프록시를 어떻게 생성할지 지정하는데 사용된다.

@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS) // request 스코프로 지정, 프록시를 만든다
public class MyLogger {}

적용할 대상이 인터페이스가 아닌 클래스라면 TARGET_CLASS를 추가해주고 적용 대상이 인터페이스라면 INTERFACE를 선택한다.

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

private final MyLogger myLogger;

주입하는 부분을 수정해준다.

이렇게 만들어진 MyLogger를 출력해보면 가짜 프록시 객체가 나오는 것을 확인할 수 있다.

myLogger = class hello.core.common.MyLogger$$SpringCGLIB$$0

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

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

스프링 컨테이너에 MyLogger라는 이름으로 진짜 대신에 가짜 프록시 객체를 등록한다. 그래서 의존관계 주입도 이 가짜 프록시 객체가 주입된다.

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

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

정리

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

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

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

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

• 싱글톤처럼 사용하는 것 같지만 다르게 동작하기 때문에 주의해서 사용해야 한다.

• 꼭 필요한 곳에 사용해야 한다. 무분별하게 사용하면 유지보수가 어려워진다.