Ensure handling of 404 errors for static resources

Closes gh-30930
This commit is contained in:
rstoyanchev
2023-07-27 22:09:18 +03:00
parent 85704c890e
commit 78d0dbb519
6 changed files with 194 additions and 10 deletions

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2021 the original author or authors.
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -26,6 +26,7 @@ import org.apache.commons.logging.LogFactory;
import org.springframework.core.Ordered;
import org.springframework.core.log.LogFormatUtils;
import org.springframework.lang.Nullable;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
@@ -98,6 +99,25 @@ public abstract class AbstractHandlerExceptionResolver implements HandlerExcepti
this.mappedHandlerClasses = mappedHandlerClasses;
}
/**
* Add a mapped handler class.
* @since 6.1
*/
public void addMappedHandlerClass(Class<?> mappedHandlerClass) {
this.mappedHandlerClasses = (this.mappedHandlerClasses != null ?
ObjectUtils.addObjectToArray(this.mappedHandlerClasses, mappedHandlerClass) :
new Class<?>[] {mappedHandlerClass});
}
/**
* Return the {@link #setMappedHandlerClasses(Class[]) configured} mapped
* handler classes.
*/
@Nullable
protected Class<?>[] getMappedHandlerClasses() {
return this.mappedHandlerClasses;
}
/**
* Set the log category for warn logging. The name will be passed to the underlying logger
* implementation through Commons Logging, getting interpreted as a log category according

View File

@@ -56,6 +56,7 @@ import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.View;
import org.springframework.web.servlet.handler.AbstractHandlerMethodExceptionResolver;
import org.springframework.web.servlet.mvc.support.RedirectAttributes;
import org.springframework.web.servlet.resource.ResourceHttpRequestHandler;
import org.springframework.web.servlet.support.RequestContextUtils;
/**
@@ -372,6 +373,12 @@ public class ExceptionHandlerExceptionResolver extends AbstractHandlerMethodExce
return !this.exceptionHandlerAdviceCache.isEmpty();
}
@Override
protected boolean shouldApplyTo(HttpServletRequest request, @Nullable Object handler) {
return (handler instanceof ResourceHttpRequestHandler ?
hasGlobalExceptionHandlers() : super.shouldApplyTo(request, handler));
}
/**
* Find an {@code @ExceptionHandler} method and invoke it to handle the raised exception.
*/

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,9 +19,11 @@ package org.springframework.web.servlet.resource;
import java.io.IOException;
import java.net.MalformedURLException;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.stream.Stream;
import jakarta.servlet.ServletException;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
@@ -29,12 +31,16 @@ import org.junit.jupiter.params.provider.MethodSource;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.UrlResource;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.servlet.DispatcherServlet;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
import org.springframework.web.testfixture.servlet.MockHttpServletRequest;
import org.springframework.web.testfixture.servlet.MockHttpServletResponse;
import org.springframework.web.testfixture.servlet.MockServletConfig;
@@ -114,6 +120,34 @@ public class ResourceHttpRequestHandlerIntegrationTests {
assertThat(response.getContentAsString()).as(description).isEqualTo("h1 { color:red; }");
}
@Test
void testNoResourceFoundException() throws Exception {
AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
context.setServletConfig(this.servletConfig);
context.register(WebConfig.class);
context.register(GlobalExceptionHandler.class);
context.refresh();
DispatcherServlet servlet = new DispatcherServlet();
servlet.setApplicationContext(context);
servlet.init(this.servletConfig);
MockHttpServletRequest request = initRequest("/cp/non-existing");
MockHttpServletResponse response = new MockHttpServletResponse();
servlet.service(request, response);
assertThat(response.getStatus()).isEqualTo(404);
assertThat(response.getContentType()).isEqualTo("application/problem+json");
assertThat(response.getContentAsString()).isEqualTo("""
{"type":"about:blank",\
"title":"Not Found",\
"status":404,\
"detail":"No static resource non-existing.",\
"instance":"/cp/non-existing"}\
""");
}
private DispatcherServlet initDispatcherServlet(
boolean usePathPatterns, boolean decodingUrlPathHelper, Class<?>... configClasses) throws ServletException {
@@ -176,6 +210,11 @@ public class ResourceHttpRequestHandlerIntegrationTests {
}
return urlResource;
}
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
converters.add(new MappingJackson2HttpMessageConverter());
}
}
@@ -209,4 +248,9 @@ public class ResourceHttpRequestHandlerIntegrationTests {
}
}
@ControllerAdvice
private static class GlobalExceptionHandler extends ResponseEntityExceptionHandler {
}
}