[Spring] 빈 스코프 3) 웹 스코프

 

목차

• 빈 스코프 - 빈 스코프란?
• 빈 스코프 - 프로토타입 스코프
• 빈 스코프 - 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점
• 빈 스코프 - 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 Provider로 문제 해결 
• 빈 스코프 - 웹 스코프
• 빈 스코프 - request 스코프 예제 만들기
• 빈 스코프 - 스코프와 Provider
• 빈 스코프 - 스코프와 프록시

 

 

 

 

싱글톤 스코프

싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 매우 긴 스코프이고, 프로토타입은 생성과 의존관계 주입, 초기화까지 진행하는 특별한 스코프이다.

 

 

웹 스코프

 

웹 스코프의 특징

웹 스코프는 웹 환경에서만 동작한다.

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

 

 

웹 스코프 종류

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

 

사실 세션이나, 서블릿 컨텍스트, 웹 소켓 같은 용어를 잘 모르는 분들도 있을 것이다.  

여기서는 request 스코프를 예제로 설명하겠다. 나머지도 범위만 다르지 동작 방식은 비슷하다. 

 

HTTP요청이 같으면, 같은 인스턴스로 호출된다.

HTTP요청이 다르면, 서로 다른 request scope객체를 생성해서 사용한다. 이는 response가 나갈때 까지 유지된다. 

 

 

 

request 스코프
-
예제 만들기(문제점) 

 

 

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

 

라이브러리 추가

build.gradle

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

(refresh 필수)

hello.core.CoreApplication을 실행시켰을 때 localhost:8080으로 접근이 가능하다(아직 페이지는 없음)

 

참고: spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.

 

참고: 스프링 부트는 웹 라이브러리가 없으면 우리가 지금까지 학습한 AnnotationConfigApplicationContext 을 기반으로 애플리케이션을 구동한다. 

웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로 AnnotationConfigServletWebServerApplicationContext 를 기반으로 애플리케이션을 구동한다.

 

 

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

[어떤 고객인지 구분] [어떤 url에서 호출된 것인지] controller / service등등 구별가능

• 기대하는 공통 포멧: [UUID][requestURL] {message}
• UUID를 사용해서 HTTP 요청을 구분하자.
• requestURL 정보도 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인하자.

 

 

MyLogger 

common 패키지 하위에 MyLogger클래스를 생성한다.

로그를 출력하기 위한 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")//HTTP 요청당 1개씩 생성, HTTP요청이 끝나면 소멸
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를 생성해서 저장해둔다.
• 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장
  • 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분 가능

• 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남긴다.
• requestURL 은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력 받는다.

 

 

LogDemoController

web이라는 패키지를 만들어 하위에 작성해준다. 

위에서 작성한 로거 클래스가 잘 작동하는지 확인하는 테스트용 컨트롤러이다.

 

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 //final붙은 애들 생성자 생략해도 자동의존관계 주입
public class LogDemonController {

    private final LogDemoService logDemoService;
    private final MyLogger myLogger; // 스프링 컨테이너가 의존관계 주입을하려고 하는데 request scope라 myLogger가없음 (HTTP요청이 들어와야 생성되기 때문) -> Provider로 해결


    @RequestMapping("log-demo")// log-demo요청이 들어
    @ResponseBody //view 탬플릿을 거치지 않고 문자를 응답으로 반환
    public String logDemo(HttpServletRequest request){ //고객요청정보를 받아옴
        String requestURL = request.getRequestURI().toString();
        myLogger.setRequestURL(requestURL);

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

}

• HttpServletRequest를 통해서 요청 URL을 받음(logDemo 메소드)
  • requestURL값 :  http://localhost:8080/log-demo  //고객이 요청한 값
• 받은 requestURL값을 myLogger에 저장해둔다.
  • HTTP는 요청 당 각각 구분되므로 다른 HTTP요청 때문에 값이 섞일일은 없다.
• 컨트롤러에서 controller test라는 로그를 남긴다.

 

참고: requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다. 

        String requestURL = request.getRequestURI().toString(); //고객이 요청한 값 저장
        myLogger.setRequestURL(requestURL);

여기서는 예제를 단순화하고, 아직 스프링 인터셉터를 학습하지 않은 분들을 위해서 컨트롤러를 사용했다. 스프링 웹에 익숙하다면 인터셉터를 사용해서 구현해보자.

 

 

LogDemoService

같은 패키지 하위에 LogDemoService를 추가한다. 

비즈니스 로직에 있는 서비스 계층에도 로그를 출력해본다.

 

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을 사용하지 않고 파라미터로 모든 정보를 서비스 계층에 넘길 수 있지만, 파라미터(유효 id, requestURL등) 가 매우 많이 필요해 지저분 해진다.

또한, requestURL같은 웹과 관련된 정보가 웹과 관련없는 서비스 계층까지 넘어간다.

웹과 관련된 부분은 컨트롤러까지만 사용하고, 서비스 계층은 웹 기술에 종속되지 않고 유지하는게 유지보수 관점에서 좋다

request scope의 MyLogger 덕분에 이런 부분을 파라미터로 넘기지 않고, MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

 

결과

하지만, 실행해보면 다음과 같은 에러가 발생한다.

이는 request scope의 특성 때문이다.

request scope인 MyLogger는 HTTP 요청이 올 때 생성되는데, 

아직 HTTP 요청이 존재하지 않아 생성되지 않았다. 

하지만, LogDemoController가 MyLogger를 의존하고 있고, @RequiredArgsConstructor 를 이용해 final로 선언된 MyLogger클래스를 스프링컨테이너를 이용하여 의존관계를 주입하려고 한다.

하지만, MyLogger가 존재하지 않아 에러가 발생한다 

 

이 (MyLogger)빈은 실제 고객 요청이 와야 생성할 수 있고, MyLogger스프링 빈요청은 의존관계 주입 단계가 아니라, 실제 고객 요청이 왔을 때로 뒤로 미루어야 한다. (Provider를 사용하여 해결)

 

 

 

 

Provider 와 Proxy

 

 

이를 해결하는 방안에는 

• Provider
• Proxy

가 존재한다.

 

 

Provider

ObjectProvider를 이용하여, 고객 요청이 들어오고나서 실행되는 logoDemo가 호출 될 때, (HTTP요청이 들어온 이후)

myLogger를 요청한다

 

LogDemonController

@Controller
@RequiredArgsConstructor //final붙은 애들 생성자 생략해도 자동의존관계 주입
public class LogDemonController {

    private final LogDemoService logDemoService;
    private final ObjectProvider<MyLogger> myLoggerProvider; // 스프링 컨테이너가 의존관계 주입을하려고 하는데 request scope라 myLogger가없음 (HTTP요청이 들어와야 생성되기 때문) -> Provider로 해결


    @RequestMapping("log-demo")// log-demo요청이 들어
    @ResponseBody //view 탬플릿을 거치지 않고 문자를 응답으로 반환
    public String logDemo(HttpServletRequest request) throws InterruptedException { //고객요청정보를 받아옴
        String requestURL = request.getRequestURI().toString(); //고객이 요청한 값 저장
        MyLogger myLogger = myLoggerProvider.getObject(); //Provider를 이용해 필요한 시점(클라이언트 요청을 받아옴) 에 myLogger빈을 받아옴
        myLogger.setRequestURL(requestURL);


        //컨트롤러에 로그를 남김
        myLogger.log("controller test");
        Thread.sleep(1000); //명확하게 확인하기 위해 딜레이 줌
        logDemoService.logic("testId");
        return "OK";
    }

}

 

 

LogDemoService

@Service
@RequiredArgsConstructor
public class LogDemoService {


    private final ObjectProvider<MyLogger> myLoggerProvider;

    public void logic(String id){
        MyLogger myLogger = myLoggerProvider.getObject();
        myLogger.log("service id = "+ id);
    }


}

 

 

실행시켜보면, localhost:8080에 정상적으로 실행된다.

새로고침을 할 때 마다 새로운 요청이 되기 때문에, 새로운 uuid로 로그가 찍힌다.

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

 

정확하게, 이 그림이 구현된 것이다.

 

 

 

 

Proxy

 

방법은 request scope에 다음을 추가해 주는 것 이다.

@Component
@Scope(value="request", proxyMode = ScopedProxyMode.TARGET_CLASS)//HTTP 요청당 1개씩 생성, HTTP요청이 끝나면 소멸
public class MyLogger {

proxyMode = ScopedProxyMode.TARGET_CLASS 를 추가한다.

• 적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS 를 선택
• 적용 대상이 인터페이스면 INTERFACES 를 선택

이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

 

MyLogger

package hello.core.common;

import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.util.UUID;


@Component
@Scope(value="request", proxyMode = ScopedProxyMode.TARGET_CLASS)//HTTP 요청당 1개씩 생성, HTTP요청이 끝나면 소멸
public class MyLogger {

    private String uuid;
    private String requestURL; //빈이 생성되는 순간 값이 들어오지 않고 외부에서 값을 받아 setter를 이용하여 입력받음

    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);//주소 출력

    }



}

 

나머지 코드는 2개는 Provider 적용 이전으로 되돌리면 된다.

 

실행시켜보면, 정상적으로 작동한다.

 

그런데 특이 한 것은 myLogger를 출력해 봤을 때, $$EnhancerBySpringCGLIB$$ 라는 것이 붙는 것을 확인할 수 있다.

이는 진짜 MyLogger가 아니라 가짜 프록스 클래스를 넣어두고, MyLogger의 실제 메소드가 호출되는 시점에 진짜 MyLogger를 찾아서 동작시킨다.

 

CGLIB 라이브러리

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

@Scope 의 "proxyMode = ScopedProxyMode.TARGET_CLASS" 를 설정하면 ,스프링 컨테이너는 CGLIB 라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성

결과를 확인해보면 우리가 등록한 순수한 MyLogger 클래스가 아니라 MyLogger$ $EnhancerBySpringCGLIB 이라는 클래스로 만들어진 객체가 대신 등록됨

스프링 컨테이너에 "myLogger"라는 이름으로 진짜 대신에 이 가짜 프록시 객체를 등록한다.

ac.getBean("myLogger", MyLogger.class) 로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있다.
그래서 의존관계 주입도 이 가짜 프록시 객체가 주입된다.

 

 

이러한 가짜 프록시는 요청이 오면 내부에서 진짜 빈을 요청하는 로직이 들어있다.

내부에 myLogger를 찾는 방법을 알고 있으며, 클라이언트 메서드를 호출하면, 가짜 프록시 객체의메서드를 호출한 것이고 

가짜 프록시 객체가 request 스코프의 진짜 myLogger 메서드를 호출한다.

가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다(다형성)

 

 

 

동작 정리

• CGLIB 라이브러리 내 클래스를 상속받은 가짜 프록시 생성 후 주입 
• 실제 요청이 오면, 가짜 프록시 객체가 실제 빈을 찾아서 요청하는 위임 로직을 실행 

*가짜 프록시 객체는 request scope와는 관계가 없음 (단순 위임 로직만 있으며 싱글톤 처럼 작동)

 

 

특징 정리

• 프록시 객체 덕분에 클라이언트는 싱글톤 빈을 사용하는 것 처럼 request scope 사용 가능
• 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체가 가능함(다형성과 ID컨테이너가 지닌 강점)
• 웹 스코프 아니어도 사용가능 

*프록시/ provider 둘다 진짜 객체 조회를 꼭 필요한 시점까지 미루는 것이 핵심

 

주의점 

• 싱글톤을 사용하는 것 처럼 사용이 가능하지만, 다르기 때문에 주의해서 사용해야함
• 이런 특별한 scope는 꼭 필요한 곳에서만 최소화해서 사용해야 유지보수