"인프런의 스프링 핵심원리 - 기본편 강의를 듣고 작성한 글 입니다."
스프링 핵심 원리 - 기본편 - 인프런 | 강의
스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., - 강의 소개 | 인프런...
www.inflearn.com
웹 스코프
지금까지 싱글톤과 프로토타입 스코프를 학습했다. 싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 매우 긴 스코프이고, 프로토타입은 생성과 의존관계 주입, 그리고 초기화 까지만 진행하는 특별한 스코프이다.
이번에는 웹 스코프에 대해 알아보자.
* 웹 스코프의 특징
- 웹 스코프는 웹 환경에서만 동작한다.
- 웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점 까지 관리한다. 따라서 종료 메소드가 호출된다.
* 웹 스코프의 종류
- request : HTTP 요청 하나가 들어오고 나갈때 까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리된다.
- session : HTTP Session 과 동일한 생명주기를 가지는 스코프
- application : 서블릿 컨텍스트(ServletContext) 와 동일한 생명주기를 가지는 스코프
- websocket : 웹 소켓과 동일한 생명주기를 가지는 스코프
사실 세션이나, 서블릿 컨텍스트, 웹 소켓같은 용어를 잘 모를수도 있다. 여기서는 request 스코프를 예제로 알아보자. 나머지도 범위만 다르지 동작은 비슷하다.
HTTP request 요청 당 각각 할당되는 request 스코프
- 클라이언트 A 와 클라이언트 B 가 각각 HTTP request 요청을 해왔을 때, 각 클라이언트의 전용 request scope 가 생성되며, 이에 따라 각 요청마다 별도의 빈이 요청된다.
- 컨트롤러와 서비스 단에서 해당 빈을 사용할 때도 마찬가지로 각 HTTP request 요청에 맞게 생성된 request scope 를 찾아간다.
request 스코프 예제 만들기
* 웹 환경 추가
웹 스코프는 웹 환경에서만 동작하므로 web 환경이 동작하도록 라이브러리를 추가하자.
- build.gradle
dependencies {
implementation 'org.springframework.boot:spring-boot-starter'
implementation 'javax.inject:javax.inject:1'
//web 라이브러리 추가
implementation 'org.springframework.boot:spring-boot-starter-web'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
// lombok 라이브러리 추가 시작
compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
testCompileOnly 'org.projectlombok:lombok'
testAnnotationProcessor 'org.projectlombok:lombok'
// lombok 라이브러리 추가 끝
}이제 CoreApplication 의 main 메소드를 실행하면 웹 어플리케이션이 실행되는 것을 확인할 수 있다.
2022-02-20 01:05:50.729 INFO 1240 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''
2022-02-20 01:05:50.738 INFO 1240 --- [ main] hello.core.CoreApplication : Started CoreApplication in 1.965 seconds (JVM running for 2.351)+ 참고 : spring-boor-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰캣 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.
+ 참고 : 스프링 부트는 웹 라이브러리가 없으면 지금까지 학습한 AnnotationConfigApplicationContext 를 기반으로 애플리케이션을 구동한다. 웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로 AnnotationConfigServletWebServerApplicationContext 를 기반으로 애플리케이션을 구동한다.
만약 기본 포트인 8080 포트를 다른곳에서 사용중이어서 오류가 발생하면 포트를 변경해야 한다. 9090 포트로 변경하려면 다음 설정을 추가해주자.
- main/resources/application.properties
server.port=9090
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
- 기대하는 공통 포맷 [UUID][requestURL]{message}
- UUID 를 사용해서 HTTP 요청을 구분하자.
- requestURL 정보도 추가로 넣어서 어떤 URL 을 요청해서 남은 로그인지 확인하자.
main 폴더 아래 hello.core.common 패키지에 MyLogger 클래스를 만들고 다음과 같이 코드를 작성해보자.
- MyLogger.java
@Component
@Scope(value = "request")
public class MyLogger {
private String uuid;
private String requestURL;
// URL 은 나중에 들어오도록 수정자로 필드 값을 설정하자
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 요청이 끝나는 시점에 소멸된다.
- 이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메소드를 사용해서 uuid 를 생성해서 저장해둔다.
이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid 를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
- 이 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남긴다.
- requestURL 은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter 로 입력받는다.
그럼 이번에는 URL 정보를 외부에서 넣어주기 위한 클래스를 만들어보자.
main 폴더 아래 hello.core.web 패키지에 LogDemoController, LogDemoService 클래스를 만들고 아래와 같이 코드를 작성해보자.
- LogDemoController.java
@Controller
@RequiredArgsConstructor
public class LogDemoController {
private final LogDemoService logDemoService;
private final MyLogger myLogger;
@RequestMapping("log-demo")
@ResponseBody // 문자열 그대로 응답을 보내기 위한 @ResponseBody 어노테이션 사용
public String logDemo(HttpServletRequest request){
// HttpServletRequest : 자바에서 제공하는 표준 서블릿 규약을 위한 HttpRequest 정보를 받을 수 있는 클래스
String requestURL = request.getRequestURL().toString();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}- 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러다.
- 여기서 HttpServletRequest 를 통해서 요청 URL 을 받았다.
- requestURL 값 http://localhost:9090/log-demo
- 이렇게 받은 requestURL 값을 myLogger 에 저장해둔다. myLogger 는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.
- 컨트롤러에서 controller test 라는 로그를 남긴다.
+ 참고 : requestURL 을 MyLogger 에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다. 여기서는 예제를 단순화하고, 아직 스프링 인터셉터를 학습하지 않은 경우를 위해 컨트롤러를 사용한다.
스프링 웹에 익숙하다면 인터셉터를 사용해서 구현해보자.
- LogDemoService.java
@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 의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.
이제 CoreApplication 을 실행해보면 기대하기로는 MyLogger 와 컨트롤러, 서비스에 각각 작성되어 있는 출력문이 나오겠지만, 기대와는 달리 오류가 발생하는 것을 확인할 수 있다.
ScopeNotActiveException: 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 스코프 빈은 아직 생성되지 않는다. 이 빈은 실제 고객의 요청이 와야(HttpRequest 가 와야) 생성할 수 있다.
즉, 아직 객체가 생성되지 않아 스프링 컨테이너에 등록되지 않은 스프링 빈을 컨트롤러와 서비스에서 의존성으로 주입 받으려고 했기 때문에 위와 같이 오류가 발생한 것이다.
이를 해결하기 위한 몇 가지 방안이 있다.
스코프와 Provider
첫번째 해결방안은 앞서 배운 Provider 를 사용하는 것이다.
간단히 ObjectProvider 를 사용해보자.
- LogDemoController.java
@Controller
@RequiredArgsConstructor
public class LogDemoController {
private final LogDemoService logDemoService;
private final ObjectProvider<MyLogger> myLoggerProvider;
@RequestMapping("log-demo")
@ResponseBody // 문자열 그대로 응답을 보내기 위한 @ResponseBody 어노테이션 사용
public String logDemo(HttpServletRequest request){
// HttpServletRequest : 자바에서 제공하는 표준 서블릿 규약을 위한 HttpRequest 정보를 받을 수 있는 클래스
String requestURL = request.getRequestURL().toString();
MyLogger myLogger = myLoggerProvider.getObject();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}- LogDemoService.java
@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:9090/log-demo 를 입력해서 접속해보면 다음과 같은 로그가 출력되는 것을 확인할 수 있다.
[cbbc2d95-cb94-4ce5-847e-0bc27128c4f8] request scope bean create : hello.core.common.MyLogger@63e72287
[cbbc2d95-cb94-4ce5-847e-0bc27128c4f8][http://localhost:9090/log-demo]controller test
[cbbc2d95-cb94-4ce5-847e-0bc27128c4f8][http://localhost:9090/log-demo]service id = testId
[cbbc2d95-cb94-4ce5-847e-0bc27128c4f8] request scope bean close : hello.core.common.MyLogger@63e72287- ObjectProvider 덕분에 ObjectProvider.getObject() 를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
- ObjectProvider.getObject() 를 호출하는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리된다.
- ObjectProvider.getObject() 를 LogDemoController, LogDemoService 에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다.
이 정도에서 끝내도 될 것 같지만, 개발자들의 코드 몇자를 더 줄이려는 욕심은 끝이 없다.
스코프와 프록시
이번에는 프록시 방식을 사용해보자.
- MyLogger.java
@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {
}- proxyMode = ScopedProxyMode.TARGET_CLASS 를 @Scope 어노테이션에 추가해주자. 이게 핵심이다.
- 적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS 를 선택
- 적용 대상이 인터페이스면 INTERFACES 를 선택
- 이렇게 하면 MyLogger 의 가짜 프록시 클래스를 만들어두고 HTTP request 와 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.
이제 나머지 코드를 Provider 사용 이전으로 돌려주자.
- LogDemoController.java
@Controller
@RequiredArgsConstructor
public class LogDemoController {
private final LogDemoService logDemoService;
private final MyLogger myLogger;
@RequestMapping("log-demo")
@ResponseBody // 문자열 그대로 응답을 보내기 위한 @ResponseBody 어노테이션 사용
public String logDemo(HttpServletRequest request){
// HttpServletRequest : 자바에서 제공하는 표준 서블릿 규약을 위한 HttpRequest 정보를 받을 수 있는 클래스
String requestURL = request.getRequestURL().toString();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}- LogDemoService.java
@Service
@RequiredArgsConstructor
public class LogDemoService {
private final MyLogger myLogger;
public void logic(String id) {
myLogger.log("service id = " + id);
}
}이제 아까와 같이 스프링을 실행한 다음 localhost:9090/lod-demo 경로로 접속해보면 다음과 같이 로그가 정상적으로 출력 되는것을 확인할 수 있다.
[48d52b4c-f9cc-440e-b4a4-18b5c0e31746] request scope bean create : hello.core.common.MyLogger@2331de79
[48d52b4c-f9cc-440e-b4a4-18b5c0e31746][http://localhost:9090/log-demo]controller test
[48d52b4c-f9cc-440e-b4a4-18b5c0e31746][http://localhost:9090/log-demo]service id = testId
[48d52b4c-f9cc-440e-b4a4-18b5c0e31746] request scope bean close : hello.core.common.MyLogger@2331de79코드를 잘 보면 LogDemoController, LogDemoService 는 Provider 사용 전과 완전히 동일하다.
어떻게 이게 가능한 것일까?
* 웹 스코프와 프록시 동작 원리
먼저 주입된 MyLogger 를 확인해보자.
- LogDemoController.java
@Controller
@RequiredArgsConstructor
public class LogDemoController {
private final LogDemoService logDemoService;
private final MyLogger myLogger;
@RequestMapping("log-demo")
@ResponseBody // 문자열 그대로 응답을 보내기 위한 @ResponseBody 어노테이션 사용
public String logDemo(HttpServletRequest request){
// HttpServletRequest : 자바에서 제공하는 표준 서블릿 규약을 위한 HttpRequest 정보를 받을 수 있는 클래스
String requestURL = request.getRequestURL().toString();
// 주입된 myLogger 객체 확인
System.out.println("myLogger = " + myLogger.getClass());
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}결과 :
myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$575e84ef
[3f8bc3af-d7b0-4a01-b1ca-dcb6faff19c8] request scope bean create : hello.core.common.MyLogger@25db40d3
[3f8bc3af-d7b0-4a01-b1ca-dcb6faff19c8][http://localhost:9090/log-demo]controller test
[3f8bc3af-d7b0-4a01-b1ca-dcb6faff19c8][http://localhost:9090/log-demo]service id = testId
[3f8bc3af-d7b0-4a01-b1ca-dcb6faff19c8] request scope bean close : hello.core.common.MyLogger@25db40d3
* 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 컨테이너가 가진 큰 강점이다.
* 주의점
- 마치 싱글톤을 사용하는 것 같지만, 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.
- 이런 특별한 scope 는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수하기 어려워진다.
'Spring basic' 카테고리의 다른 글
| 스프링 핵심원리 : 기본편 - 프로토타입 스코프와 싱글톤 (0) | 2022.02.19 |
|---|---|
| 스프링 핵심원리 : 기본편 - 빈 스코프와 프로토타입 스코프 (0) | 2022.02.18 |
| 스프링 핵심원리 : 기본편 - 빈 생명주기 콜백 시작 (0) | 2022.02.18 |
| 스프링 핵심원리 : 기본편 - 조회한 빈이 모두 필요할 때 (0) | 2022.02.18 |
| 스프링 핵심원리 : 기본편 - 조회 빈이 2개 이상인 경우 문제해결 (0) | 2022.02.17 |
