Spring - 빈 스코프(웹 스코프, request 스코프 예제 만들기)

웹 스코프

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

웹 스코프의 종류

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

request 스코프 예제 만들기

우선 웹 스코프를 위해 웹 환경을 추가하자.

// build.gradle에 추가
implementation 'org.springframework.boot:spring-boot-starter-web'

스프링 부트는 내장 톰캣 서버를 활용해 웹서버와 스프링을 같이 실행시킨다.

지금까지 AnnotationConfigApplicationContext를 기반으로 애플리케이션을 구동했다면, 웹 라이브러리가 추가된 이후로는 웹 관련 추가 설정과 환경들이 필요하기 때문에 AnnotationConfigServletWebServerApplicationContext를 기반으로 구동한다.

request 스코프 예제 개발

동시에 여러 HTTP 요청이 오게되면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다.
이럴 때 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을 요청해서 남은 로그인지 확인

코드

@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 destroy() {
        System.out.println("[" + uuid + "] request scope bean close:" + this);
    }
}

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

@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을 받았다.
• 받은 requestURL 값을 myLogger에 저장한다.
  • myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 됨.
• 컨트롤러에서 controller test라는 로그를 남김.

@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의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있게 되었다.

실행

[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

를 기대 했지만

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;

스프링 컨테이너가 뜨면서 스프링 빈을 의존관계 주입 받을 때 MyLogger를 받아야 하는데, MyLogger는 request scope이기 때문에 아직 고객의 요청이 없어 생성되지 않아 주입 받지 못해서 나오는 오류이다.
request scope의 생존 기간은 고객 요청이 들어와서 나갈 때 까지이다.

이럴 때 쓰는 것이 Provider이다!

출처 : 인프런 김영한 지식공유자님의 스프링 완전 정복 로드맵 강의