[스프링 핵심 원리 - 기본편] #9. 빈 스코프 (2)

[Pracrobo]

빈 스코프 - 웹 스코프

지금까지 싱글톤과 프로토타입 스코프를 학습했다. 싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 매우 긴 스코프이고, 프로토 타입은 생성과 의존관계 주입, 그리고 초기화까지만 진행하는 특별한 스코프이다.

특징

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

종류

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

request 스코프를 예제로 설명하나 나머지도 범위만 다르지 동작 방식은 비슷하다.

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

• 클라이언트 A가 요청, 로깅을 찍는다고 하면 -> A 클라이언트 전용 객체가 만들어진다.
• 동시에 클라이언트 B가 요청 -> 별도의 HttpRequest를 찍는 로고 찍는 빈 객체 생성, 서비스 로직에서 이미 만들어진거 반환
• 그러므로 각자 전용 request scope의 빈이 있다

request 스코프 예제 만들기

웹 환경 추가

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

build.gradle에 추가

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

main메소드에
core application 실행시

• port 번호가 뜬다.

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

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

request 스코프 예제 개발

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다.(여러 스레드에서 요청이 오기 때문에) 이럴때 사용하기 딱 좋은 것이 바로 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
 

• 기대하는 공통 포멧: [UUID][requestURL] {message}
• UUID를 사용해서 HTTP 요청을 구분하자. (같은 request라면 UUID가 같다)
• requestURL 정보도 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인하자.

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

package hello.core.common;

import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

import java.util.UUID;

@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(); //unique한 uuid가 생성
        System.out.println("[" + uuid + "] request scope bean create: " + this);
    }

    @PreDestroy //고객요청이 빠져나갈때 close() 호출되면서 빈이 소멸
    public void close() {
        System.out.println("[" + uuid + "] request scope bean close: " + this);
    }
}

• 로그를 출력하기 위한 'MyLogger'클래스다.
• @Scope(value = "request")를 사용해서 request 스코프로 지정했다. 이게 이 빈은 HTTP 요청당 하나씩 생성되고 HTTP 요청이 끝나는 시점에 소멸된다.
  'value='를 빼서 @scope("request")만 남겨도 된다.
• 이 빈이 생성되는 시점(requeest 하는 시점)에 자동으로 @PostConstruct초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다. 이 빈은 HTTP 요청당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
• 이 빈이 소멸되는 시점에 @PreDestroy를 사용해서 종료 메세지를 남긴다.
• requestURL은 이 빈이 생성되는 시점에는 알 수 없으므로 외부에서 setter 로 입력 받는다.

package hello.core.web;

import hello.core.common.MyLogger;
import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequiredArgsConstructor //생성자에 Autowired 자동주입
public class LogDemoController {
    private final LogDemoService logDemoService;
    private final MyLogger myLogger; // 의존관계 주입

    @RequestMapping("log-demo")
    @ResponseBody // view 화면없이 문자반환하고 싶을때 쓴다
    public String logDemo(HttpServletRequest request) { //표준서블릿 규약이 있는데 http request 정보를 받을 수 있다
        String requestURL = request.getRequestURI().toString();
        myLogger.setRequestURL(requestURL);   // http:// ~ log-demo
        myLogger.log("controller test");
        logDemoService.logic("testId");
        return "OK";
    }
}

• 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러다.
• 여기서 HttpServletRequest를 통해서 요청 URL을 받았다.
  • requestURL 값 : http://localhost:8080/log-demo
• 이렇게 받은 requestURL 값을 myLogger에 저장해둔다. myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.
• 컨트롤러에서 controller test라는 로그를 남긴다

참고: requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다. 여기서는 예제를 단순화하고, 아직 스프링 인터셉터를 학습하지 않은 분들을 위해서 컨트롤러를 사용했다. 스프링 웹에 익숙하다면 인터셉터를 사용해서 구현해보자.

package hello.core.web;

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

@Service
@RequiredArgsConstructor
public class LogDemoService {
    private final MyLogger myLogger;
    public void logic(String id) {
        myLogger.log("service id = " + id);
    }
}

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

결과

• no thread-bounded request를 찾았는데, ~ 실제 웹리퀘스터 관련되어 나왔다. (오류가 나는게 정상)
  예상과 다르게 결과값이 나오는데 고객의 실 요청이 있어야만 나올 수 있다. >> Provider를 사용해서 해결

• '이렇게 받은 requestURL 값을 myLogger에 저장해둔다. '에서 request값이 없는 것이다. 생존 범위는 고객의 요청이 들어와서 나갈때까지다. scope request가 활성화 되지 않았다는 뜻

Scope와 Provider

간단히 Object Provider로 해보자.

package hello.core.web;

import hello.core.common.MyLogger;
import jakarta.servlet.http.HttpServletRequest;
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;

@Controller
@RequiredArgsConstructor
public class LogDemoController {
    private final LogDemoService logDemoService;
    private final ObjectProvider<MyLogger> myLoggerProvider; // MyLogger를 찾을 수 있는 dependency lookup이 주입이 된다.

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        String requestURL = request.getRequestURI().toString();
        MyLogger myLogger = myLoggerProvider.getObject(); // 여기부분 이 시점에 최초로 만들어진다. uuid 만들어놓음
        myLogger.setRequestURL(requestURL); // http:// loger ~
        myLogger.log("controller test");
        logDemoService.logic("testId");
        return "OK";
    }
}

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 myLogger = myLoggerProvider.getObject(); // 여기부분 추가
        myLogger.log("service id = " + id);
    }
}

결과

결과 - 출력

• 동시에 요청이 와도 여러 객체마다 관리한다.

package hello.core.web;

import hello.core.common.MyLogger;
import jakarta.servlet.http.HttpServletRequest;
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;

@Controller
@RequiredArgsConstructor
public class LogDemoController {
    private final LogDemoService logDemoService;
    private final ObjectProvider<MyLogger> myLoggerProvider;

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) throws InterruptedException {
        String requestURL = request.getRequestURI().toString();
        MyLogger myLogger = myLoggerProvider.getObject();
        myLogger.setRequestURL(requestURL);


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

-main() 메서드로 스프링을 실행하고, 웹 브라우저에 http://localhost:8080/log-demo를 입력하자.

• 드디어 잘 작동하는 것을 확인할 수 있다.

 [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 덕분에 ObjectProvider.getObject() 를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다. spring container에 요청을 지연할 수 있다. 그럼 Spring bean이 나중에 생성을 해준다.
• ObjectProvider.getObject() 를 호출하시는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리된다.
• ObjectProvider.getObject() 를 LogDemoController , LogDemoService 에서 각각 한번씩 따로 호출해도(ObejectProvider에 dependency lookup을 하는데) 같은 HTTP 요청이면(Controller에서 하든 log service에서 찾든 각각 한번씩 따로 호출해도 같은 요청이면) 같은 스프링 빈이 반환된다!
• 내가 직접 이걸 구분하려면 얼마나 힘들까 >> 어려움, 스레드 등등

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

• 전용으로 생성

• 같은 요청엔 같은 인스턴스에 접근하게 된다.

• 더 간단히 줄이기로 하자

Scope와 Proxy

Provider보다 더 간단히, Proxy 방식

package hello.core.common;

import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.stereotype.Component;

import java.util.UUID;

@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS) //파라미터 값이 두개이상이면 `value=`넣어줘야 한다, target_class 가짜를 만드는 것
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);
    }
}

package hello.core.web;

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

@Service
@RequiredArgsConstructor
public class LogDemoService {
    private final MyLogger myLogger; // proxy
    public void logic(String id) {
        myLogger.log("service id = " + id);
    }
}

• Provider를 쓰는 것이라 똑같이 동작한다.
• @scope(value = "request" , proxyMode = ScopedProxyMode.TARGET_CLASS) 여기 핵심
  • 적용 대상이 인터페이스가 아닌 클래스면 'TARGET_CLASS'를 선택
  • 적용 대상이 인터페이스면 'INTERFACES'를 선택
• 이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관없이 가짜 프록시 클래스를 다른 반에 미리 주입해둘 수 있다.

package hello.core.web;

import hello.core.common.MyLogger;
import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequiredArgsConstructor
public class LogDemoController {
    private final LogDemoService logDemoService;
    private final MyLogger myLogger; //proxy

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) throws InterruptedException {
        String requestURL = request.getRequestURI().toString();

        System.out.println("myLogger = " + myLogger.getClass()); // 출력해보기
        myLogger.setRequestURL(requestURL); // 실제 호출하는 시점에 진짜를 찾아서 동작 http://loger ~


        myLogger.log("controller test");
        Thread.sleep(100);

        logDemoService.logic("testId");
        return "OK";
    }
}

결과

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

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

동작 정리

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

특징 정리

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

참고
스프링 AOP도 같은 원리로 돌아간다. 클라이언트 코드를 고치지 않는다는 점이 스프링 컨테이너의 장점이다.

주의점

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