[Spring MVC] 스프링 인터셉터 적용 시 NOT FOUND가 발생하지 않는 경우

 

 

 

 

 

🧐 상황

인증 시 JWT를 사용하여 인증을 진행하며, 회원가입과 로그인을 제외한 모든 URL에 대해서 인증 관련 Interceptor를 구현하여 등록해 둔 상태였습니다.

 

해당 인터셉터에서는 AccessToken이 없는 경우 예외를 throw 하도록 구현하였는데,  다음과 같은 코드였습니다.

@Component
public class LogInInterceptor implements HandlerInterceptor {
	// 생략

    @Override
    public boolean preHandle(final HttpServletRequest request,
                             final HttpServletResponse response,
                             final Object handler) {
        AccessToken token = extractAccessTokenUseCase.command(
                new ExtractAccessTokenUseCase.Command(request.getHeader(AUTHORIZATION_HEADER))
        );
        Claims claims = extractClaimsUseCase.command(
                new ExtractClaimsUseCase.Command(token)
        );
        validateClaims(claims);
        authenticationContext.setPrincipal(parseLong(claims.get(MEMBER_ID_CLAIM)));
        return true;
    }

    private void validateClaims(final Claims claims) {
        // 클레임이 있는지 검사
        if (claims.get(MEMBER_ID_CLAIM) == null) {
            throw new AuthenticationException(INVALID_ACCESS_TOKEN);
        }
        // 클레임이 Long으로 파싱될 수 있는지 검사
        try {
            parseLong(claims.get(MEMBER_ID_CLAIM));
        } catch (NumberFormatException e) {
            throw new AuthenticationException(INVALID_ACCESS_TOKEN);
        }
    }
}

 

 

그리고 이를 다음과 같이 등록하였습니다.

@Override
public void addInterceptors(final InterceptorRegistry registry) {
    registry.addInterceptor(logInInterceptor)
            .addPathPatterns("/api/**")
            .excludePathPatterns(SIGN_UP_URL, LOGIN_URL);
}

 

 

 

문제는 이렇게 등록하다 보니, 다음과 같은 문제가 발생하였습니다.

 

 

정의되지 않는 url 중, /api/~~ 으로 요청이 들어오는 경우(addPathPatterns와 일치하는 경우),

AccessToken이 없다면 404 에러가 아닌 500 예외가 발생합니다.

 

 

 

조금 더 신기한 점은 이외의 url로 들어오는 경우에는 AccessToken이 없어도 404가 제대로 반환된다는 점이었습니다.

 

 

 

 

이러한 이유를 알아보도록 하겠습니다.

 

 

 

 

 

 

 

 

 

 

 

🧐 원인

스프링의 DispatcherServlet의 코드를 살펴볼 필요성이 있습니다.

 

중요한 부분은 디버깅 표시를 넣어 빨간색으로 표시되게 하였습니다.

 

먼저 요청에 대하여 Handler를 조회합니다.

 

만약 Handler를 찾지 못했다면 mappedHandler == null 이므로 noHandlerFound를 수행한 후, return합니다.

(최종적으로 404 반환)

 

 

그러나 Handler를 찾은 경우 Handler를 처리할 수 있는 HandlerAdapter를 조회한 후

handler.applyPreHandle()을 수행하는데, 이곳에서 Interceptor의 preHandle()이 호출됩니다.

 

 

참고로 이 경우 Interceptor에서 예외가 발생하는 경우 두가지 상황이 발생할 수 있습니다.

 

 

1. 요청 url에 대응되는 url이 @Controller 클래스 내에서 @RequestMapping을 통해 존재하는 경우

-> @ControllerAdvice에 의해 정상적으로 처리됩니다.

 

 

2. 그렇지 않은 경우

@ControllerAdvice 에 의하여 처리되지 않습니다.

(이는 AbstractHandlerMethodExceptionResolver의 shouldApplyTo() 메서드 때문입니다.)

 

 

 

 

 

 

 

큰 흐름을 정리하자면 다음과 같습니다.

요청에 대한 Handler를 찾은 경우 -> HandlerAdapter 조회 -> Interceptor의 preHandle() 수행 -> 핸들러 실행

요청에 대한 Handler를 찾지 못한 경우 -> noHandlerFound() 호출 후 return (최종적으로 NOT FOUND 반환)

 

 

 

 

 

 

 

 

 

 

 

 

🧐 핸들러가 안 찾아져야 할텐데...

위의 과정을 이해했다면, 조금 이상한 부분이 존재합니다.

 

우선 저의 상황을 다시 정리해보겠습니다.

정의되지 않는 url 중, /api/~~ 으로 요청이 들어오는 경우, AccessToken이 없다면 404 에러가 아닌 500 예외가 발생합니다.
 
/api/~~가 아닌 /xxx 등의 url로 들어오는 경우에는, AccessToken이 없어도 404가 제대로 반환됩니다.

분명 위의 코드대로라면 정의되지 않은 url에 대해서는 핸들러를 찾을 수 없으므로 404가 반환되어야 하는 것이 맞습니다.

 

그럼 무엇이 문제일까요??

 

디버깅을 해보면 다음과 같은 사실을 알 수 있습니다.

정의되지 않은 URL에 요청을 보내는 경우에도 Handler가 찾아진다는 것이었습니다.

 

 

그 핸들러는 바로 ResourceHttpRequestHandler 였습니다.

 

해당 핸들러가 조회되기 때문에 Interceptor의 preHandle()이 호출되는 것이었고, 따라서 404 NOT FOUND 예외가 반환되지 않는 것이었습니다.

 

 

 

 

 

 

 

 

 

 

🧐 해결방법

Application.properties에 다음과 같은 속성을 추가합니다.

spring.web.resources.add-mappings=false

이를 통해 ResourceHttpRequestHandler가 매핑되는 것을 방지할 수 있습니다.

 

 

만약 Resource에 대한 접근을 사용하고 있던 경우라면, 아래와 같은 설정을 추가해 주어야 합니다.

@Configuration
public class AuthenticationConfig implements WebMvcConfigurer {
    
    // 생략
    
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/docs/**")
                .addResourceLocations("classpath:/static/docs/");
    }
}

 

 

 

 

 

 

 

 

 

 

🧐 Reference

https://tecoble.techcourse.co.kr/post/2021-11-24-spring-customize-unhandled-api/

SpringBoot 존재하지 않는 API 요청의 응답 커스마이징하기

https://dev-monkey-dugi.tistory.com/136

Interceptor 예외를 @ExceptionHandler가 핸들링 가능할까?