7/9 스프링 핵심원리 - 웹스코프,스코프와 Provider
웹 스코프
지금까지 싱글톤과 프로토타입 스코프를 학습했다.
싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 매우 긴 스코프이고,
프로토타입은 생성과 의존관계 주입, 그리고 초기화까지만 진행하는 특별한 스코프이다.
이번에는 웹 스코프에 대해서 알아보자
웹 스코프의 특징
웹 스코프는 웹 환경에서만 동작한다.
웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. 따라서 종료 메서드가 호출된다.
웹 스코프 종류
request: HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프,
각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고, 관리된다.
session: HTTP Session과 동일한 생명주기를 가지는 스코프
application: 서블릿 컨텍스트( ServletContext )와 동일한 생명주기를 가지는 스코프
websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프
사실 세션이나, 서블릿 컨텍스트, 웹 소켓 같은 용어를 잘 모르는 분들도 있을 것이다.
여기서는 request 스코프를 예제로 설명하겠다. 나머지도 범위만 다르지 동작 방식은 비슷하다.
request 스코프 예제 만들기
웹 환경 추가
웹 스코프는 웹 환경에서만 동작하므로 web 환경이 동작하도록 라이브러리를 추가하자.
build.gradle에 추가
//web 라이브러리 추가
implementation 'org.springframework.boot:spring-boot-starter-web'
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
같은고객에게서 왔구나
고객이 /log-demo 호출 -> 컨트롤러 , 서비스 호출
-기대하는 공통 포멧: [UUID][requestURL] {message}
-UUID를 사용해서 HTTP 요청을 구분하자.
-requestURL 정보도 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인하자.
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
@Scope(value = "request")
public class MyLoagger {
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 // 고객 요청이 끝나면 close() 호출되면서 빈 소멸
public void close(){
System.out.println("[" + uuid + "] request scope bean close: " + this);
}
}
-로그를 출력하기 위한 MyLogger 클래스이다.
-@Scope(value = "request") 를 사용해서 request 스코프로 지정했다. 이제 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
(언제나 스프링 컨테이너에 요청하는 시점에 생성된다)
-이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다. 이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다. 이 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남긴다.
-requestURL 은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력 받는다.
MyLogger
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
@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 // 고객 요청이 끝나면 close() 호출되면서 빈 소멸
public void close(){
System.out.println("[" + uuid + "] request scope bean close: " + this);
}
}
-로그를 출력하기 위한 MyLogger 클래스이다.
-@Scope(value = "request") 를 사용해서 request 스코프로 지정했다.
이제 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
-이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다. 이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
-이 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남긴다.
-requestURL 은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력 받는다.
LogDemoController
package hello.core.web;
import hello.core.common.MyLogger;
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 //생성자에 Autowired 들어가면서 자동주입됨
public class LogDemoContoroller {
private final LogDemoService logDemoService;
private final MyLogger myLoagger; //request scope
@RequestMapping("log-demo")
@ResponseBody//화면이 없고 문자를 반환하고 싶으므로 . 보통 controller 요청이오면 뷰 템플릿 에서 렌더링 거쳐서 나감
//ResponseBody는 문자를 그대로 보낼 수 있다
public String logDemo(HttpServletRequest request){
String requestURL = request.getRequestURL().toString();
myLoagger.setRequestURL(requestURL);
myLoagger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}
인터셉터는 컨트롤러 호출 직전에 공통화해서 처리할 수 있는것.
String requestURL = request.getRequestURL().toString();
myLoagger.setRequestURL(requestURL);이부분을 공통처리할 수 있음
Error creating bean with name 'myLogger': Scope 'request' is not active for the current thread;
LogDemoService 추가
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의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.
스프링 애플리케이션을 실행 시키면 오류가 발생한다. 메시지 마지막에 싱글톤이라는 단어가 나오고…
스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만,
request 스코프 빈은 아직 생성되지 않는다. 이 빈은 실제 고객의 요청이 와야 생성할 수 있다!
스프링 컨테이너에게 나 이 스프링 빈 주세요 하는 단계를 의존관계 주입단계가 아니라 실제 고객 요청이 왔을 때로 지연시켜야한다
스코프와 Provider
첫번째 해결방안은 앞서 배운 Provider를 사용하는 것이다. 간단히 ObjectProvider를 사용해보자.
@Controller
@RequiredArgsConstructor //생성자에 Autowired 들어가면서 자동주입됨
public class LogDemoContoroller {
private final LogDemoService logDemoService;
private final ObjectProvider<MyLogger> myLoggerProvider; // MyLogger를 주입받는게 아니라 MyLogger를 찾을수있는 DL이 주입됨
@RequestMapping("log-demo")
@ResponseBody//화면이 없고 문자를 반환하고 싶으므로 . 보통 controller 요청이오면 뷰 템플릿 에서 렌더링 거쳐서 나감
//ResponseBody는 문자를 그대로 보낼 수 있다
public String logDemo(HttpServletRequest request){
MyLogger myLogger = myLoggerProvider.getObject();
String requestURL = request.getRequestURL().toString();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}@Service
@RequiredArgsConstructor
public class LogDemoService {
private final ObjectProvider<MyLogger> myLoggerProvider;
public void logic(String id) {
MyLogger myLogger = myLoggerProvider.getObject(); // 이 시점에 만들어짐
myLogger.log("service id = " + id);
}
}
main() 메서드로 스프링을 실행하고, 웹 브라우저에 http://localhost:8080/log-demo 를 입력하자.
잘 동작한다
public String logDemo(HttpServletRequest request) throws InterruptedException {
MyLogger myLogger = myLoggerProvider.getObject();
String requestURL = request.getRequestURL().toString();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
Thread.sleep(1000);
logDemoService.logic("testId");
return "OK";
}
Thread.slee(1000)을 추가해보았다
-ObjectProvider 덕분에 ObjectProvider.getObject() 를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.(스프링 컨테이너에게 요청하는 것을 지연할 수 있다)
-ObjectProvider.getObject() 를 호출하시는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리된다.
-ObjectProvider.getObject() 를 LogDemoController , LogDemoService 에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다!