웹 스코프

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

 

 

웹 스코프의 종류는 다음과 같다.

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

---

웹 스코프를 테스트해보기 위해서는 웹 환경을 추가해줘야 한다.

다음 의존성을 추가하자.

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

참고로 spring-boot-starter-web 라이브러리를 추가하면 웹과 관련된 추가 설정과 환경들이 필요해지기 때문에 기존에 사용하던 AnnotationConfigApplicationContext가 아닌 AnnotationConfigServletWebServerApplicationContext 를 기반으로 애플리케이션을 구동한다.

 

---

request 스코프를 테스트해보기 위한 예제로 HTTP 요청이 들어왔을 때 어떤 출저의 요청인지 로그를 남기는 예제를 작성해보자. 즉 다음과 같은 로그를 남기는 공통 로깅 기능을 구현할 것이다.

[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][request URL] {message}

 

먼저 웹 스코프를 가지는 MyLogger 클래스를 정의하자.

import java.util.UUID;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import lombok.Setter;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

@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() {
        this.uuid = UUID.randomUUID().toString();
        System.out.println("[" + uuid + "] request scope bean create:" + this);
    }

    @PreDestroy
    public void destroy() {
        System.out.println("[" + uuid + "] request scope bean close:" + this);
    }
}

 

그리고 MyLogger를 사용하는 간단한 컨트롤러와 서비스를 생성하자.

import javax.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequiredArgsConstructor
public class LogController {

    private final MyLogger myLogger;
    private final LogService logService;

    @RequestMapping(value = "/")
    public void homeController(HttpServletRequest request) {
    
        String requestUrl = request.getRequestURL().toString();
        myLogger.setRequestURL(requestUrl);
        myLogger.log("home controller");
        logService.homeService();
    }
}

import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class LogService {

    private final MyLogger myLogger;

    public void homeService() {
        myLogger.log("home service");
    }
}

 

코드를 다 작성하고 애플리케이션을 실행해보면 다음과 같은 에러를 뱉으면서 실행조차 되지않는 것을 알 수 있다. 에러가 굉장히 친절한데, 현재 스레드에서는 request 스코프가 활성화되어 있지 않다고 한다. 사실 우리는 아직 HTTP 요청을 보내지 않았기 때문에 Request 스코프 빈이 없는 것이 당연하다.

Error creating bean with name 'myLogger': Scope 'request' is not active for the current thread;

그럼 어떻게 해야할까?

 

먼저 프로토타입 스코프 빈을 제공받을 때 사용했던 Provider 또는 ObjectProvider 사용하는 방법이 있다. 컨트롤러와 서비스 코드를 수정해주자.

...

public class LogController {

    private final ObjectProvider<MyLogger> myLoggerProvider; // 수정!
    private final LogService logService;

    @RequestMapping(value = "/")
    public void homeController(HttpServletRequest request) {

        MyLogger myLogger = myLoggerProvider.getObject();

        String requestUrl = request.getRequestURL().toString();
        myLogger.setRequestURL(requestUrl);
        myLogger.log("home controller");
        logService.homeService();
    }
}

...

실행해보면 로그가 잘 출력되는 것을 볼 수 있다.

[d270c08d-392b-435d-980d-c0eba08bc1f9] request scope bean create:hello.core.common.MyLogger@69006287
[d270c08d-392b-435d-980d-c0eba08bc1f9][http://localhost:8080/] home controller
[d270c08d-392b-435d-980d-c0eba08bc1f9][http://localhost:8080/] home service
[d270c08d-392b-435d-980d-c0eba08bc1f9] request scope bean close:hello.core.common.MyLogger@69006287

 

 

 

다음으로 프록시 패턴을 이용하는 방법이 있다. 이 방법 또한 스프링에서 지원하는 방법이다. 프록시 패턴은 가짜 프록시 객체를 주입받아서 실행하다가 실제로 해당 객체를 사용하는 시점에 다시 주입받는 방식이다. 가짜 프록시 객체는 스프링이 CGLIB를 이용해서 조작한 MyLogger를 상속받은 객체인데, 객체 내부에서는 진짜 빈을 요청하는 위임 로직이 들어있다. 그리고 이 가짜 프록시 객체의 동작을 보면 마치 싱글톤처럼 동작하는 것 처럼 보이는데, 실제로는 싱글톤과 다르게 동작한다는 점을 유의해야 한다.

 

( + 프록시 패턴은 스프링 내부에서도 매우 자주 유용하게 쓰이는 패턴이다)

 

사용하는 방법은 간단하다. 컨트롤러와 서비스 코드를 원복 하고 MyLogger 클래스의 @Scope만 수정해주면 된다.

import java.util.UUID;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import lombok.Setter;
import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.stereotype.Component;

@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS) // 적용 대상이 클래스면 TARGET_CLASS, 인터페이스면 INTERFACE
@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() {
        this.uuid = UUID.randomUUID().toString();
        System.out.println("[" + uuid + "] request scope bean create:" + this);
    }

    @PreDestroy
    public void destroy() {
        System.out.println("[" + uuid + "] request scope bean close:" + this);
    }
}

 

---

 

정리

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

 

주의할 점

• 마치 싱글톤 처럼 동작하지만 실제로는 다르게 동작하기 때문에 주의해야 한다.
• 특별한 Scope는 꼭 필요한 곳에만 사용해야 한다. 자칫 유지 보수하기 어려워질 수 있다.

 

---

reference

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

스프링 핵심 원리 - 기본편 - 인프런 | 강의