[Spring] 🧨 JsonParseException 핸들링과 Request Body 캐싱 전략

관련 글 - [Spring] 🧨 JSON 역직렬화 (JSON 파싱 오류) & Bean Validation 예외 처리

✏️ 왜 이 작업을 하게 되었을까?

JsonParseException이 발생했을 때, 단순히 400 에러만 던지는 것보다는
어떤 줄(line)에서 어떤 값 때문에 오류가 발생했는지 구체적으로 응답에 담아주고 싶었다.

하지만, @RequestBody는 내부적으로 InputStream을 사용하기 때문에
한 번 읽히면 더 이상 다시 읽을 수 없다.
👉 그래서 Request Body를 캐싱하고, 예외가 발생해도 본문 내용을 다시 꺼내 쓸 수 있도록 처리해보기로 했다.

이 글에서는

📌 ContentCachingRequestWrapper를 적용한 Filter 구성
     원리 및 생명주기(→언제 캐시 정리!?)
📌 @RestControllerAdvice를 활용한 예외 응답 커스터마이징

등 JsonParseException 처리에 관한 전체 흐름을 정리하고, 해당 내용을 구현해본다.

---

🧨 JsonParseException 처리

• JSON 문법 자체가 잘못되어 파싱이 불가한 경우
• 이 예외 객체로부터 얻을 수 있는 정보는 제한적이며,
  • 파싱 오류가 발생한 라인(line)과 컬럼(column) 번호
  • 어떤 텍스트를 처리하다 오류가 발생했는지에 대한 정보 정도만 제공된다.
  • 예시
    request : { "hi": ""2, }
    error log : JSON parse error: Unexpected character ('2' (code 50)) ... at line: 1, column: 10
    • 실제 로그 캡처본
      

🧵 어떤 text에서 예외가 터졌는지 보여주고 싶은데…?

⇒ 어느 라인에서 터진 예외인지 제공하기 위해 RequestBody 추출 시도 → ❌불가!❌

• InputStream을 한 번 읽으면 내용이 소진되기 때문
  ⇒ Request Body 캐싱 필요
  
  
  

---

🧊 ContentCachingRequestWrapper 사용하여 Request Body 캐싱

• ContentCachingRequestWrapper 란?
  HttpServletRequest를 감싸는 Wrapper로,
  InputStream과 Reader에서 읽은 내용을 캐싱해 나중에 바이트 배열로 다시 읽을 수 있도록 도와준다.

• 📌 즉, 예외가 발생하더라도
        request.getContentAsByteArray()를 통해 Request Body를 로그로 남길 수 있게 되는 것!

• 메모리 걱정은?
  ⇒ request와 lifecycle이 같고, 응답이 끝날 때 함께 GC 대상이 되므로 메모리 누수 걱정 필요 x
  ⇒ 나중에 부하테스트를 진행해보면 좋을 것 같다.

  
  

💻 CachingRequestFilter 구현

🧊 ContentCachingRequestWrapper 로 request body 캐싱
CachingRequestFilter 복사 이곳

• HTTP 요청(Request)의 Body를 캐싱하기 위한 용도
• 모든 요청에 대해 필터 적용
• 코드 설명 (line별)
  • 5 : HTTP 요청일 경우에만 다음 작업 진행
  • 6 : request 객체를 ContentCachingRequestWrapper로 감쌈
    • InputStream에서 읽은 내용을 내부에 캐싱 ⇨ 예외 발생 후에도 request body 내용을 다시 꺼내쓸 수 있게 함.
  • 7 : 다음 필터나 DispatcherServlet으로 캐싱된 request 객체 전달
    • 다음 필터가 있음 → 다음 필터가 실행됨 (Filter Chain 중간 단계)
    • 이 필터가 마지막 필터 → DispatcherServlet으로 제어를 넘김 (Spring MVC 진입)
• 유의! 반드시 가장 앞단 필터에 등록해야 효과 ⭕️, 그렇지 않으면.. 이미 body가 다 소진될 위험.
• servletContext에 필터 등록 - 필터 등록 코드 복사 이곳
  
  • 6 : servletContext.addFilter로 위에서 구현한 캐싱필터 등록
  • 7 : "/*" - 모든 요청에 대해 필터 적용

---

🚗 JsonErrorControllerAdvice 구현

JsonErrorControllerAdvice 복사 이곳

• 코드 설명 (line 및 메소드별)
  • 1 : @RestControllerAdvice(annotations = RestController.class)
    • 오직 @RestController에 적용 + 모든 응답을 JSON 형식으로 반환
  • 12 : getRequestBody 메서드
    • 요청 본문을 ContentCachingRequestWrapper 를 통해 추출
      필터에서 캐싱해둔 바이트 배열을 다시 읽어 문자열로 복원
  • 31 : extractErrorLineFromJson 메서드
    • JsonParseException의 getLocation()을 통해
      파싱 오류가 발생한 line 번호를 추출
    • 추출한 요청 본문에서 해당 라인을 가져와 에러 응답에 함께 담음
  • 에러응답 : JsonSyntaxError 는 커스텀 클래스로 에러라인번호, 에러라인 문자열, 메시지를 담음
    - 예시
    request body : { "hi" : 1
    response body :

    {
       "lineNumber": 1,
       "rejectValue": "{ \"hi\" : 1",
       "message": "JSON 문법 오류 - Unexpected end-of-input: expected close marker for Object (start marker at [Source: (org.springframework.util.StreamUtils$NonClosingInputStream); line: 1, column: 1])"
    }

    
    
    

마무리

이렇게 JsonParseException이 발생했을 때, 오류가 난 라인과 그 내용을 응답에 담아주는 작업을 직접 구현해보았다.
구글에 떠다니는 Exception Handler 코드를 활용하는 데에는 익숙했지만, 이렇게 실제 예외 구조를 뜯어보고 개선해본 경험은 처음인 것 같다.
이 작업이 프론트엔드 개발자에게는 디버깅을 더 수월하게, 서버 측에서는 오류 상황을 보다 명확히 기록할 수 있는 데에 도움이 되기를 바란다.
자잘하지만 이런 실용적인 예외 처리 하나가 사용자 경험과 협업의 품질을 바꾸는 시작점이 될 수 있다고 믿는다.

글 읽어주셔서 감사합니다!! 틀린 내용이나 더 나은 방식이 있다면 댓글로 편하게 알려주세요 😊