🖼️

Request Scope 로 빈의 생애 주기 관리

생성일

2022/06/08

태그

Spring

배경

미션 진행 중, 요청한 사용자에 대한 인증을 위해 token 방식을 사용하였습니다. 그런데 jwt token 을 파싱하고 유효성 검증을 하려고 하니, Interceptor 에서도 하고 ArgumentResolver 에서도 하게 되었습니다.

문제점

Interceptor - ArgumentResolver 로 전달되는 인자는 Request(ServletRequest, WebRequest) 이고 해당 객체에서 꺼낼 수 있는 정보는 getHeader() 로 꺼낼 수 있는 스트링입니다. 이에 따라 Interceptor 에서 파싱과 유효성 검증을 하는데, ArgumentResolver 에서 요청된 파라미터로 변환하기 위해 파싱을 또 하게 되는 중복 로직이 발생하는 것이었습니다. 그렇다고 ArgumentResolver 에서만 파싱, 유효성 검증, 요청 파라미터 변환을 모두 맡기기에는 책임지는 로직이 많아져, 이 책임들을 분리할 수 있는 방법을 생각해 보았습니다.

Interceptor

Handler 처리 전과 후에 요청에 대한 공통적인 로직을 실행할 수 있는 AOP 성격을 지닙니다.

Argument Resolver

컨트롤러의 메소드의 인자로 사용자가 임의의 값을 전달하는 방법을 제공하고자 할 때 사용합니다.

따라서 파싱과 유효성 검증은 Interceptor 에서 하고, 검증을 통과하고 받은 payload 는 ArgumentResolver 로 전달한 뒤 파라미터로 변환하는 로직을 구상하였습니다.

Request 의 Attribute

처음에는 각 파라미터로 받는 Request 에서 attribute 를 사용하는 방법을 생각해 보았습니다. Interceptor 에서는 유호성 검증을 마친 payload 를 attribute 에 set 합니다. 그리고 Argument Resolver 에서는 attribute 에서 get 한 뒤 파라미터로 변환하는 로직입니다. 같은 Request Context 안에 있어서 전달이 가능했고, 하나의 요청이 끝나면 사라져 이후의 요청에 중복의 문제를 일으키지 않습니다.

Scope

위와 같이 Request 의 attribute 를 이용하는 것도 방법 중 하나이지만, 인증과 관련해서 직접 관리할 수 있는 객체가 있으면 좋겠다라는 생각이 들었습니다. 위의 방법은 servlet 의 attribute 기능과 관련하여 Map 구조로 밖에 사용할 수 없기에 이후 확장의 측면에서 단점이 있을 것이라 판단했습니다. 이에 따라 request 와 같은 라이프 사이클을 유지할 수 있는 객체를 만들기로 하였습니다.

@Componen
@Scope(value = SCOPE_REQUEST, proxyMode = ScopedProxyMode.TARGET_CLASS)
public class RequestTokenContext {

    private String customerId;

    public String getCustomerId() {
        return customerId;
    }

    public void setCustomerId(String customerId) {
        this.customerId = customerId;
    }
}
Java
복사

1. 빈으로 등록하며 라이프사이클 주기를 스프링에 맡기면서, value = SCOPE_REQUEST 옵션으로 해당 주기를 request 로 정하였습니다.

두 번째 옵션인 Proxy mode 는 서버가 뜰 때 가짜 객체를 생성해주는 옵션인데 이후에 설명하겠습니다.

@Component
public class AuthenticationInterceptor implements HandlerInterceptor {

    private final RequestTokenContext requestTokenContext;

		public AuthenticationInterceptor(RequestTokenContext requestTokenContext) {
				this.requestTokenContext = requestTokenContext;
		}

		@Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        final String token = getTokenFromHeader();
        validateToken(token);
        final String payload = getPayload(token);
        validatePayload(payload);
        requestTokenContext.setCustomerId(payload);
				return true;
    }
}
Java
복사

RequestTokenContext 객체에 payload 를 set 합니다. RequestTokenContext 은 하나의 요청이 끝날 때 까지 빈으로 등록되어 사용이 가능합니다.

@Component
public class AuthenticationPrincipalArgumentResolver implements HandlerMethodArgumentResolver {

    private final RequestTokenContext requestTokenContext;

		// 생성자 생략

		@Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.hasParameterAnnotation(AuthenticationPrincipal.class);
    }

    @Override
    public Long resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) {
        return Long.parseLong(requestTokenContext.getCustomerId());
    }
}
Java
복사

Interceptor 에서 등록한 payload 를 가져옵니다. ArgumentResolver 에서는 해당 payload 를 검증하지 않고 바로 parameter 로 넘길 수 있도록 로직을 구성하였습니다.

위의 방식으로 두 가지 장점을 가질 수 있었습니다.

중복된 로직을 피할 수 있다.

•

getHeader() 로 Interceptor 와 ArgumentResolver 에서 파싱과 유효성 검사 등의 로직이 중복되는 것을 방지할 수 있습니다.

이후 같은 요청 주기의 Controller, Service 등에서 사용이 가능하다.

•

빈으로 등록하였기때문에 라이프사이클의 살아있는 동안 어떤 계층에서든, 주입을 받기만 하면 해당 객체를 사용할 수 있습니다.