9월 20일 화요일 TIL 회고록

웹 스코프

---

• 웹 환경에만 동작하는 스코프
• 스프링이 해당 스코프의 종료 시점까지 관리하며, 종료 메서드도 호출한다.

 

종류

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

네 종류 모두 범위는 다르지만 동작 방식은 비슷하기에 대표적으로 Request 웹 스코프를 가지고 학습하였다.

 

request 스코프 예제 만들기

---

실제로 예제를 만들어보면서 학습하였다.

만들어볼 웹 스코프 범위의 빈은 로깅 빈이다.

• Format : [UUID] [requestURL] {message}

 

1. build.gradle에 web 환경 추가

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

• 해당 라이브러리를 추가하면 스프링 부트는 내장 톰캣 서버를 활용해 웹 서버와 스프링을 함께 실행한다.
• 해당 라이브러리가 없으면 지금까지처럼 AnnotationConfigApplicationContext를 기반으로 애플리케이션을 구동한다.
• 웹 라이브러리가 추가되면 웹 관련 기능 및 설정이 필요하기에 AnnotationConfigServletApplicationContext를 기반으로 애프리케이션을 구동한다.

만약 실행했을때 기본 포트인 8080 포트가 사용중이라면 main/resources/application,properties에서 다음 내용을 추가해 포트를 변경하자.

server.port = 9000

 

 

2. 코드 작성

로그를 출력하기 위한 MyLogger 클래스, 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러인 LogDemoController,

비즈니스 로직이 있는 서비스 계층인 LogDemoService 클래스를 만들었다.

 

MyLogger.class

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

• @Scope(value = "request") 어노테이션을 사용해서 request 스코프로 지정했다. 이제 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 사라진다.
• 이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다. 이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
• 이 빈이 소멸되는 시점에 @PreDestory 어노테이션을 사용해서 종료 메시지를 남긴다. (close() 메서드)
• requestURL은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력 받는다.

 

LogDemoController.class

@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을 받았다. 
  • HttpServletRequest : Http 프로토콜의 request 정보를 서블릿에게 전달하기 위한 목적으로 사용된다. Header 정보, Parameter, Cookie, URI, URL 등의 정보를 읽어들이는 메소드를 가진 클래스이고 Body의 Stream을 읽어들이는 메소드를 가지고있다.
  • 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 scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아서 지저분해진다. 더 문제는 requestURL 같은 웹과 관련없는 서비스 계층까지 넘어가게 된다. 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다. 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.
• request scope의 MyLogger 덕분에 이런 부분을 파라미터로 넘기지 않고 MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

 

실행 결과

실행 시 아래와 같은 오류가 출력되며 실행이 안된다. (에러가 발생한다.)

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 스코프 빈은 아직 생성되지 않고 실제 고객의 요청이 와야 생성할 수 있기 때문이다. 

다시말해, 해당 프로젝트가 구동될 때 스프링 빈들이 컴포넌트 스캔이 되며 등록 및 의존관계 주입이 되는데, 여기서 웹 스코프인 MyLogger 빈의 경우 Http Request 요청이 올때 생성돠는 빈이기 때문에 스프링 구동단계에서는 아직 생성을 할 수 없다. 그렇기에 해당 에러가 발생하는 것이다.

마지막으로 정리하면, 스프링 구동시 MyLogger 스프링 빈을 등록을 요구하는데 해당 빈은 자신이 생성되야 할 스코프 범위에 해당되지 않았기 때문에 에러가 발생한다.

 

그럼 해당 스프링 빈은 스프링 구동시점이 아닌 사용자의 HTTP Request 요청 시점에 생성될 수 있다는 말인데, 이를 해결하기 위한 방법들에 대해 알아보았다.

 

스코프와 Provider

---

위에서 말한것처럼 스프링 빈의 생성시점이 구동시점이 아닌 지연된 시점인 경우 해결책에 대해 알아보았다.

 

1. Provider

위에서 배운 Provider를 사용해보자. 간단히 ObjectProvider를 사용하였다.

 

LogDemoController.class

@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.class

@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 접근 (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

웹 페이지에서 해당 경로로 접근을 시도하니 콘솔창에도 의도한 포맷 형식으로 데이터가 잘 나온다.

 

• ObjectProvider를 사용해 getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
• getObject() 를 호출하는 시점에는 HTTP 요청이 진행중이기에 빈 생성이 정상적으로 동작한다.
• getObject()를 컨트롤러, 서비스에서 각각 호출하는데도 동일한 HTTP 요청일 경우 같은 스프링 빈이 반환된다.

 

2. 프록시 활용

스코프 속성을 이용해 스프링 빈을 프록시 객체로 만들어 줄 수 있다.

 

MyLogger.class

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

• @Scope 어노테이션에 proxyMode = ScopedProxyMode.TARGET_CLASS 속성 활용
  • 적용대상이 인터페이스가 아닌 클래스이기에 TARGET_CLASS 사용
  • 적용대상이 인터페이스일 경우 INTERFACES 사용
• 이제 이 클래스는 가짜 프록시를 만들어주고 이 가짜 프록시 빈을 의존관계 주입을 한다.
• 해당 빈이 실제 사용될 때 프록시 빈에서 실제 빈을 가져와 사용할 수 있도록 한다.

이렇게 적용하고 컨트롤러, 서비스의 코드를 이전 상태로 돌려서 다시 실행해도 정상 작동하는 것을 확인할 수 있다. 어떻게 가능한 것일까?

 

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

MyLogger의 클래스를 출력해보면 우리가 만든 hello.core.common.MyLogger가 출력되지 않고 이를 상속한 임의의 객체가 생성되는 것을 볼 수 있다.

 

LogDemoController.class

@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();
    System.out.println("myLogger = " + myLogger.getClass());
    myLogger.setRequestURL(requestURL);

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

 

실행 결과

• @Scope의 proxyMode를 설정하면 스프링 컨테이너는 CGLIB 이라는 바이트코드 조작 라이브러리를 사용해 MyLogger를 상속받은 가짜 프록시 객체를 생성한다.
• 스프링 컨테이너에는 이 프록시 객체가 등록된다.
• getBean을 통해 해당 클래스 타입을 조회해도 가짜 프록시 객체가 조회되는 것을 볼 수 있다.
  • 의존관계에서도 프록시 객체가 주입되는걸 알 수 있다.

정리

• CGLIB 이라는 바이트코드 조작 라이브러리로 클래스를 상속받은 가짜 프록시 객체를 만들어 의존관계를 주입시킨다.
• Provider를 사용하든, Proxy를 사용하든 핵심 아이디어는 진짜 객체 조회를 필요한 시점까지 지연처리 한다는 점이다.
• 단지 애노테이션 속성 추가 만으로 원본 객체를 프록시 객체로 대체할 수 있다.
  • 다형성과 DI 컨테이너가 가진 큰 강점이다. 
• 꼭 웹 스코프가 아니어도 프록시는 사용할 수 있다.

주의점

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