Spring Boot, HttpServletRequest 객체에서 요청 바디 획득하기

개요

• 클라이언트로부의 요청 정보를 담은 HttpServletRequest 객체에는 요청 바디를 반환하는 getInputStream() 메써드가 존재한다. 하지만 이 메써드는 최초 1회 호출 후에는 재호출시 java.io.IOException: Stream closed. 예외를 발생시킨다. 일반적인 상황에서는 문제가 없지만 로깅 등의 목적으로 요청 바디를 획득하고자 할 경우 접근이 불가능한 문제가 발생한다. 이 경우 getInputStream()을 재호출이 가능한 별도의 커스텀 HttpServletRequest를 제작해야 한다.

요청 바디의 재접근이 가능한 HttpServletRequest 작성

• 요청 바디의 재접근이 가능한 커스텀 HttpServletRequest 클래스를 아래와 같이 작성한다. (소스 코드 예제는 아래 참고 글에서 인용했다.) 목적은 요청 바디를 바이트의 배열로 보관하다가 매번 getInputStream() 요청이 올 때마다 보관된 데이터를 반환하는 것에 있다.

import org.apache.commons.io.IOUtils;

import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.io.*;

public class MultiReadableRequestBodyHttpServletRequest extends HttpServletRequestWrapper {

    private ByteArrayOutputStream cachedBytes;

    public MultiReadableRequestBodyHttpServletRequest(HttpServletRequest request) {
        super(request);
    }

    @Override
    public ServletInputStream getInputStream() throws IOException {
        if (cachedBytes == null) cacheInputStream();

        return new CachedServletInputStream(cachedBytes.toByteArray());
    }

    @Override
    public BufferedReader getReader() throws IOException {

        return new BufferedReader(new InputStreamReader(getInputStream()));
    }

    private void cacheInputStream() throws IOException {

        cachedBytes = new ByteArrayOutputStream();
        IOUtils.copy(super.getInputStream(), cachedBytes);
    }

    public static class CachedServletInputStream extends ServletInputStream {

        private final ByteArrayInputStream buffer;

        public CachedServletInputStream(byte[] contents) {
            this.buffer = new ByteArrayInputStream(contents);
        }

        @Override
        public int read() {

            return buffer.read();
        }

        @Override
        public boolean isFinished() {

            return buffer.available() == 0;
        }

        @Override
        public boolean isReady() {

            return true;
        }

        @Override
        public void setReadListener(ReadListener listener) {

            throw new RuntimeException("Not implemented");
        }
    }
}

커스텀 작성한 HttpServletRequest을 Filter에 연결

• 앞서 작성한 커스텀 HttpServletRequest 클래스를 Filter에 연결할 차례이다. 이 과정을 통해 실제로 해당 클래스가 작동하게 된다.

import org.springframework.stereotype.Component;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

@Component
public class MultiReadableRequestBodyFilter implements Filter {

    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

        if (servletRequest.getContentType() == null) {
            filterChain.doFilter(servletRequest, servletResponse);
            return;
        }
        if (servletRequest.getContentType().startsWith("multipart/form-data")) {
            filterChain.doFilter(servletRequest, servletResponse);
        } else {
            MultiReadableRequestBodyHttpServletRequest wrappedRequest = new MultiReadableRequestBodyHttpServletRequest((HttpServletRequest) servletRequest);
            filterChain.doFilter(wrappedRequest, servletResponse);
        }
    }
}

• 일반적인 요청에 대해서는 요청 바디를 획득할 수 있도록 커스텀 HttpServletRequest 클래스를 작동시키고, 파일 업로드 요청에 대해서는 일반적인 HttpServletRequest 클래스를 작동하도록 작성했다.

Interceptor 클래스에서의 요청 바디 획득

• 아래는 실제 Interceptor 클래스에서 요청 바디를 획득하는 예이다.

@Component
class SomeRequestInterceptor() : HandlerInterceptorAdapter() {

    @Throws(Exception::class)
    override fun preHandle(request: HttpServletRequest, response: HttpServletResponse, handler: Any): Boolean {

        ...
        request.queryString?.let { MDC.put("request_query_string", it) }
        request.contentType?.let { contentType ->
            if (!contentType.startsWith("multipart/form-data")) {
                val requestBody = IOUtils.toString(request.inputStream, StandardCharsets.UTF_8)
                if (!requestBody.contains("password")) {
                    MDC.put("request_body", requestBody)
                }
            }
        }
        ...

        return true
    }
    ...
}

참고 글

• Reading a Servlet/Spring Request Body Multiple Times
• Reading HttpServletRequest Multiple Times in Spring