[Spring] 빈 스코프 2

✅ 웹 스코프

웹 환경에서만 동작하는 스코프

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

웹 스코프의 종류

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

• 클라이언트 A와 B가 동시에 요청을 보낸다면,
• 클라이언트 A와 B가 다른 인스턴스가 할당된다. (각 클라이언트 전용 객체가 생성된다)
• 스프링 컨테이너가 해당 스코프의 종료시점까지 관리힌다.

✅ request 스코프 예제 만들기

웹 환경 추가

build.gradle에 추가하고, CoreApplication의 main 메서드가 잘 실행되는지 확인한다.

request 스코프 예제 개발

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

- 기대하는 공통 포맷 : [UUID][requestURL]{message}
- UUID를 사용해서 HTTP 요청 구분
- requestURL 정보도 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인

MyLogger

@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 요청이 끝나는 시점에 소멸
• 빈이 생성되는 시점에 자동으로 @PostConstructor 초기화 메서드를 사용해 uuid 생성해서 저장
• HTTP 요청 당 하나씩 생성, uuid 저장해두면 다른 HTTP 요청과 구분할 수 있음

LogDemoController

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

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

LogDemoService

@Service
@RequiredArgsConstructor
public class LogDemoService {
    private final MyLogger myLogger;

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

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

원하는 출력 결과

[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

But... 오류발생!

• request 스코프 빈은 실제 고객의 요청이 와야 생성되기 때문이다!

✅ 스코프와 Provider

ObjectProvider 사용

LogDemoController

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

LogDemoService

@Service
@RequiredArgsConstructor
public class LogDemoService {
    private final ObjectProvider<MyLogger> myLoggerProvider;

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

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

✅ 스코프와 프록시

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

• 적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS를 선택
• 적용 대상이 인터페이스면 INTERFACES 선택
• MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP Request와 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

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

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

• @Scope의 proxyMode = ScopedProxyMode.TARGET_CLASS) 를 설정하면 스프링 컨테이너는 CGLIB라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성한다.
• 스프링 컨테이너에 "myLogger"라는 이름으로 진짜 대신에 이 가짜 프록시 객체를 등록한다.
• ac.getBean("myLogger", myLogger.class) 로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있다.

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

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

동작원리

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

특징

• 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request.scope를 사용할 수 있다.
• 진짜 객체 조회를 꼭 필요한 시점까지 지연처리하는 점이 중요!
• 원본 객체를 프록시 객체로 대체할 수 있음