웹 스코프

김영한님의 인프런 강의와 PDF를 바탕으로 정리하였습니다.
https://www.inflearn.com/courses?s=%EA%B9%80%EC%98%81%ED%95%9C

 

 

 

웹 스코프

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

 

웹 스코프 종류

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

websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프

 

웹 스코프 빈이 생성되는 과정을 보자.

웹 스코프 빈은 사용자가 요청할 때마다 생성된다.

 

웹 스코프는 웹환경에서만 동작하므로, 웹 라이브러리를 추가해야한다.

( implementation 'org.springframework.boot:spring-boot-starter-web' )

참고 1: spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.
참고 2: 스프링 부트는 웹 라이브러리가 없으면 우리가 지금까지 학습한 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을 요청해서 남은 로그인인지 확인하자.

코드는 아래와 같다.

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

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

 

테스트용 컨트롤러

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

 

• 여기서 HttpServletRequest를 통해서 요청 URL을 받았다. (requestURL 값: http://localhost:8080/log-demo)
• 이렇게 받은 requestURL 값을 myLogger에 저장해둔다. myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.
• 컨트롤러에서 controller test라는 로그를 남긴다.

 

 

테스트용 서비스

 

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

• request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아서 지저분해진다.
• 더 문제는 requestURL같은 웹과 관련된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다. 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다. 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.
• request scope의 MyLogger 덕분에 이런 부분을 파라미터로 넘기지 않고, MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

하지만 이를 실행하면 다음과 같은 에러가 뜨며 실행되지 않는다.

 

왜냐하면 LogDemoController는 싱글톤 빈으로써 MyLogger(request 빈)를 의존관계를 주입받고 있다.
근게 MyLogger는 언제 생성된다? 바로 request요청이 들어올 때이다. 
하여 스프링 컨테이너가 올라갈 때 생성되는 LogDemoController가 MyLogger가 필요한데 이때는 요청이 없으므로 만들어질 수 없는 것이다. 이럴 때 사용하는 것이 Provider이다.

 

 

 

Provider를 사용하여 해결하기

ObjectProvider를 사용하여 requet 빈(MyLogger)의 생성을 늦추게 하는 것이다.

코드를 보면 컨트롤러와 서비스의 필드에 MyLogger대신 ObjectProvider<MyLogger>를 의존성으로 주입받는다. 이렇게 되면 MyLogger를 의존성으로 주입받도록하여 MyLogger의 생성을 처음부터 요구하는 것이 아니라, MyLogger를 DL(Dependency Lookup)할 수 있는 객체를 의존관계로 주입 받는 것이다.

이렇게 컨트롤러와 서비스 빈이 생성되면 이제는 request 요청을 받을 수 있는 상태가 되므로, 요청을 날리면 logDemo메소드가 실행되어 이때서야 MyLogger빈의 생성을 요규하게 된다. 

이때 각 요청마다 모든 MyLogger빈은 다른 빈들로 생성된다.

 

수행결과:

현재 요청을 두번 날린 상태인데, 요청 마다 uuid가 유지되고, 요청마다 다른 것을 확인할 수 있다.

 

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

 

 

스코프와 프록시로 해결하기

프록시로 사용할 클래스 위에 다음의 어노테이션만 붙여주면 된다.

@Scope(value="request", proxyMode = ScopedProxyMode.TARGET_CLASS)

(만약 인테페이스에 붙인 다면 TARGET_INTERFACES로 한다.)

처음에는 가짜 프록시MyLogger를 만들어서 주입시키고, MyLogger가 필요항 경우에 진짜 MyLogger를 쓸수 있도록 하는 방법이다.

코드는 ObjectProvider<MyLogger> myLoggerProvider를 다시 전부 MyLogger myLogger로 바뀐뒤 

MyLogger클래스에 어노테이션을 붙이면 된다.

 

 

MyLogger

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

 

 

아래는 컨트롤러

 

아래는 서비스

 

위의 코드를 실행하면 잘 실행된다. 

컨트롤러 빈에 의존관계 주입된 MyLogger가 무엇인지 아래의 출력문을 통해 확인해보면

출력결과

스프링의 컨테이너의 바이트 코드 조작 기술 CGLIB로 인해 생성된 객체임을 알 수 있다.

 

전체 수행 결과:(요청을 2번 보냄)

 

 

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는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수하기 어려워 진다.