[Spring Boot][2] 9-2. 빈 스코프

🏷 웹 스코프

✔️ 웹 스코프 특징

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

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

🏷 request 스코프 예제 만들기

✔️ 웹 환경 추가

웹 스코프는 웹 환경에서만 동작하므로 web 환경이 동작하도록 라이브러리를 추가(build.gradle)해야 한다!

//web 라이브러리 추가
implementation 'org.springframework.boot: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

⬆️ 위와 같은 로그가 남도록 request 스코프를 활용해서 추가 기능을 개발해보자!

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

✔️ hello.core/common/MyLogger.java 생성

package hello.core.common;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.util.UUID;

@Component
// request 스코프 지정
// 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸됨
@Scope(value = "request")
public class MyLogger {

    private String uuid;
    private String requestURL;

    // requestURL 은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력 받음
    public void setRequestURL(String requestURL) {
        this.requestURL = requestURL;
    }

    public void log(String message) {
        // 기대하는 포맷에 맞춰 출력
        System.out.println("[" + uuid + "]" + "[" + requestURL + "] " +
                message);
    }
    // 이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장
    @PostConstruct
    public void init() {
        // 절대로 겹치지 않는 확률로 아이디가 생성됨
        uuid = UUID.randomUUID().toString();
        System.out.println("[" + uuid + "] request scope bean create:" + this);
    }

    // 이 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남김
    @PreDestroy
    public void close() {
        System.out.println("[" + uuid + "] request scope bean close:" + this);
    }
}

⬆️ 로그를 출력하기 위한 MyLogger 클래스

✔️ hello.core/web/LogDemoController.java 생성

package hello.core.web;
import hello.core.common.MyLogger;
import hello.core.web.LogDemoService;
import lombok.RequiredArgsConstructor;
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 MyLogger myLogger;
    // log-demo 라는 요청이 오면,
    @RequestMapping("log-demo")
    // 뷰 화면 없이 바로 반환
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        // 고객이 어떤 url을 요청했는지 알 수 있음
        String requestURL = request.getRequestURL().toString();
        myLogger.setRequestURL(requestURL);

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

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

✔️ hello.core/web/LogDemoService.java 생성

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

⬆️ 비즈니스 로직이 있는 서비스 계층

이제 출력해보자❗️

  [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

⬆️ 우리가 기대하는 출력

 Error creating bean with name 'myLogger': Scope 'request' is not active for the
  current thread; consider defining a scoped proxy for this bean if you intend to
  refer to it from a singleton;

⬆️ 실제 출력🤷🏻‍♀️

왜 오류가 날까❓
메시지 마지막에 싱글톤이라는 단어가 나오는데 흐음... 이게 뭘까....
스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만, request 스코프 빈은 아직 생성되지 않는다.
이 빈은 실제 고객의 요청이 와야 생성할 수 있다!!!

이제부터 해결책을 알아보자

🏷 스코프와 Provider

✔️ Provider 사용하기

첫번째 해결방안은 앞서 배운 Provider를 사용하는 것이다.
간단히 ObjectProvider를 사용해보자!!

✔️ hello.core/web/LogDemoController.java 수정

package hello.core.web;
import hello.core.common.MyLogger;
import hello.core.web.LogDemoService;
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;

    // log-demo 라는 요청이 오면,
    @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";
    }
}

✔️ hello.core/web/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 myLogger = myLoggerProvider.getObject();
        myLogger.log("service id = " + id);
    }
}

스프링을 실행하고, 웹 브라우저에 http://localhost:8080/log-demo 를 입력하면,

⬆️ 잘 돌아가는 것을 확인 !!

• ObjectProvider 덕분에 ObjectProvider.getObject() 를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다!

그런데^^❗️
개발자들의 코드를 몇 자라도 더 줄이려는 욕심은 끝이 없다...ㅎㅎ

🏷 스코프와 프록시

✔️ 프록시 사용하기

프록시를 사용할 수도 있다!

✔️ hello.core/common/MyLogger.java 수정

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

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

📌 나머지 코드를 다시 Provider 사용 이전으로 돌려두고 나서 아래 내용 실습

✔️ 웹 스코프와 프록시 동작 원리
LogDemoController 에 로그(System.out.println("myLogger = " + myLogger.getClass());)를 찍어본 결과,

⬆️ 왜 내가 만든 게 아니라 스프링이 조작한 애가 스프링으로 등록되어 있는 걸까🤔,,

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

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

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

📌 이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용해야 한다!
무분별하게 사용하면 유지보수하기 어려워지기 때문!

자 가보자 ! HTTP 세계로 !