Spring Boot Rest - 如何配置 404 - 未找到资源

rest java spring spring-mvc spring-boot

2022-09-02 20:37:34

我得到了一个工作弹簧靴休息服务。当路径错误时，它不会返回任何内容。根本没有回应。同时，它也不会抛出错误。理想情况下，我期望404未找到错误。

我有一个 GlobalErrorHandler

@ControllerAdvice
public class GlobalErrorHandler extends ResponseEntityExceptionHandler {

}

ResponseEntityExceptionHandler 中有此方法

protected ResponseEntity<Object> handleNoHandlerFoundException(NoHandlerFoundException ex, HttpHeaders headers,
                                                     HttpStatus status, WebRequest request) {

    return handleExceptionInternal(ex, null, headers, status, request);
}

我在我的属性中标记了error.whitelabel.enabled=false

我还必须对此服务做些什么才能将404未找到的响应抛回客户端

我推荐了很多线程，没有看到任何人面临的麻烦。

这是我的主要应用程序类

 @EnableAutoConfiguration // Sprint Boot Auto Configuration
@ComponentScan(basePackages = "com.xxxx")
@EnableJpaRepositories("com.xxxxxxxx") // To segregate MongoDB
                                                        // and JPA repositories.
                                                        // Otherwise not needed.
@EnableSwagger // auto generation of API docs
@SpringBootApplication
@EnableAspectJAutoProxy
@EnableConfigurationProperties

public class Application extends SpringBootServletInitializer {

    private static Class<Application> appClass = Application.class;

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(appClass).properties(getProperties());

    }

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public FilterRegistrationBean correlationHeaderFilter() {
        FilterRegistrationBean filterRegBean = new FilterRegistrationBean();
        filterRegBean.setFilter(new CorrelationHeaderFilter());
        filterRegBean.setUrlPatterns(Arrays.asList("/*"));

        return filterRegBean;
    }

    @ConfigurationProperties(prefix = "spring.datasource")
    @Bean
    public DataSource dataSource() {
        return DataSourceBuilder.create().build();
    }

    static Properties getProperties() {
        Properties props = new Properties();
        props.put("spring.config.location", "classpath:/");
        return props;
    }

    @Bean
    public WebMvcConfigurerAdapter webMvcConfigurerAdapter() {
        WebMvcConfigurerAdapter webMvcConfigurerAdapter = new WebMvcConfigurerAdapter() {
            @Override
            public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
                configurer.favorPathExtension(false).favorParameter(true).parameterName("media-type")
                        .ignoreAcceptHeader(false).useJaf(false).defaultContentType(MediaType.APPLICATION_JSON)
                        .mediaType("xml", MediaType.APPLICATION_XML).mediaType("json", MediaType.APPLICATION_JSON);
            }
        };
        return webMvcConfigurerAdapter;
    }

    @Bean
    public RequestMappingHandlerMapping defaultAnnotationHandlerMapping() {
        RequestMappingHandlerMapping bean = new RequestMappingHandlerMapping();
        bean.setUseSuffixPatternMatch(false);
        return bean;
    }
}

答案 1

解决方案非常简单：

首先，您需要实现将处理所有错误情况的控制器。此控制器必须具有 -- 需要定义应用于所有 .@ControllerAdvice@ExceptionHandler@RequestMappings

@ControllerAdvice
public class ExceptionHandlerController {

    @ExceptionHandler(NoHandlerFoundException.class)
    @ResponseStatus(value= HttpStatus.NOT_FOUND)
    @ResponseBody
    public ErrorResponse requestHandlingNoHandlerFound() {
        return new ErrorResponse("custom_404", "message for 404 error code");
    }
}

提供要覆盖中响应的异常。是当 Spring 无法委派请求时将生成的异常（404 个案例）。您还可以指定覆盖任何异常。@ExceptionHandlerNoHandlerFoundExceptionThrowable

其次，您需要告诉Spring在404的情况下抛出异常（无法解析处理程序）：

@SpringBootApplication
@EnableWebMvc
public class Application {

    public static void main(String[] args) {
        ApplicationContext ctx = SpringApplication.run(Application.class, args);

        DispatcherServlet dispatcherServlet = (DispatcherServlet)ctx.getBean("dispatcherServlet");
        dispatcherServlet.setThrowExceptionIfNoHandlerFound(true);
    }
}

使用未定义的 URL 时的结果

{
    "errorCode": "custom_404",
    "errorMessage": "message for 404 error code"
}

更新：如果您使用配置SpringBoot应用程序，则需要添加以下属性，而不是在main方法中配置（感谢@mengchengfeng）：application.propertiesDispatcherServlet

spring.mvc.throw-exception-if-no-handler-found=true
spring.web.resources.add-mappings=false

答案 2

我知道这是一个古老的问题，但这是另一种配置代码但不在主类中的方法。您可以使用单独的类：DispatcherServlet@Configuration

@EnableWebMvc
@Configuration
public class ExceptionHandlingConfig {

    @Autowired
    private DispatcherServlet dispatcherServlet;

    @PostConstruct
    private void configureDispatcherServlet() {
        dispatcherServlet.setThrowExceptionIfNoHandlerFound(true);
    }
}

请不要在没有注释的情况下这样做。@EnableWebMvc