[Spring] 웹 스코프(Prototype Scope) | 웹 스코프 특징 | 웹 스코프 종류 | 빈 스코프

 

 

 

● 웹 스코프의 특징 

 

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

 

웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다.

따라서 종료 메서드가 호출된다.

 

 

 

 

 

 

 

● 웹 스코프 종류

 

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

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

  - application: 서블릿 컨텍스트( ServletContext )와 동일한 생명주기를 가지는 스코프

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

 

 

 

 

 

 

웹 스코프 예제를 만들어보자.

아래는 request 스코프를 사용한 예제이다.

 

 

 

 

 

 

---

● request 스코프 예제 만들기

 

 

 

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다.

이럴때 사용하기 딱 좋은것이 바로 request 스코프이다.

 

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

 

 

[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

 

 

---

 

 

 

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

 

 

 

build.gradle에 추가

 //web 라이브러리 추가 
 implementation 'org.springframework.boot:spring-boot-starter-web'

 

 

 

이제 애플리케이션을 실행하면 웹 애플리케이션이 실행된다.

(스프링 부트는 내장 톰켓 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다)

 

 

 

 

 

 

이제 로그를 남기는 클래스를 작성해보자

 

 

 

 

 

MyLogger.java

package hello.core.common;

import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.util.UUID;

@Component
@Scope("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 been create: " + this);
    }

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

 

로그를 출력하기 위한 MyLogger 클래스이다.

@Scope(value = "request") 를 사용해서 request 스코프로 지정했다.

 

이제 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.

이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다.

 

이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.

 

이 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남긴다.

requestURL 은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력 받는다.

 

 

 

 

 

 

 

 

LogDemoController.java

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

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();

        System.out.println("myLogger = " + myLogger.getClass()); // 가짜 프록시 객체는 요청이 오면 그때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.
        myLogger.setRequestURL(requestURL); // 로그와 함께 url을 화면에 출력하기 위해

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

 

 

 

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

 

여기서 HttpServletRequest를 통해서 요청 URL을 받았다.

requestURL 값 http://localhost:8080/log-demo 이렇게 받은 requestURL 값을 myLogger에 저장해둔다.

 

myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에

값이 섞이는 걱정은 하지 않아도 된다.

 

컨트롤러에서 controller test라는 로그를 남긴다

 

 

 

 

여기서 중요한점은 ObjectProvider를 사용한 것이다.

 

ObjectProvider 덕분에 ObjectProvider.getObject() 를 호출하는 시점까지

request scope 빈의 생성을 지연할 수 있다.

 

ObjectProvider.getObject() 를 호출하시는 시점에는 HTTP 요청이 진행중이므로

request scope 빈의 생성이 정상 처리된다.

 

 

 

 

 

 

 

 

LogDemoService.java

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final ObjectProvider<MyLogger> myLoggerProvider;

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

 

 

 

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

 

 

 

 

 

---

[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

 

 

정상적으로 동작하는 것을 볼 수 있다.

 

 

 

 

여기서 ObjectProvider를 사용하지 않고 더 깔끔하게 코드를 줄일 수 있는 방법이 있다.

 

바로 프록시 방법이다.

 

 

 

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

proxyMode = ScopedProxyMode.TARGET_CLASS 를 추가해주자.

적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS 를 선택한다.

 

이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고

HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

 

 

 

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

 

@Scope 의 proxyMode = ScopedProxyMode.TARGET_CLASS) 를 설정하면

스프링 컨테이너는 CGLIB 라는 바이트코드를 조작하는 라이브러리를 사용해서,

MyLogger를 상속받은 가짜 프록시 객체를 생성한다.

 

의존관계 주입도 이 가짜 프록시 객체가 주입된다.

 

 

 

 

---

 

 

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

 

가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다.

클라이언트가 myLogger.logic() 을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.

가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic() 를 호출한다.

가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에

이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다(다형성)

 

 

 

 

 

 

동작 정리

 

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

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

가짜 프록시 객체는 실제 request scope와는 관계가 없다.

그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작한다.