You need to enable JavaScript to run this app. Spring ControllerAdvice如何根据请求头Accept返回404对应的JSON或HTML页面?
优惠活动
大模型
产品
解决方案
定价
更多

Spring ControllerAdvice如何根据请求头Accept返回404对应的JSON或HTML页面?

差异化404响应实现方案

原有代码已经能正常处理无路由访问的404跳转,要实现根据请求头返回不同格式响应的需求,不需要拆分多个异常处理方法,直接在原有逻辑里加分支判断即可,整体思路很简单:

  • 当请求头Accept包含application/json时,返回结构化JSON错误对象
  • 其他场景下保持原有逻辑,返回自定义HTML格式的404页面

实现步骤

  1. 先定义和预期JSON结构完全匹配的错误响应模型,保证序列化后的字段、格式和示例一致:

    public class ApiError {
        // 时间戳对齐示例里的格式:2018-04-11T05:56:03.845+0000
        private String timestamp = LocalDateTime.now().format(
                DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSZ")
        );
        private int status;
        private String error;
        private String message;
        private String path;
    
        // 补充构造方法、getter、setter 即可
    }
    
  2. 改造原来的全局异常处理类,把方法返回值从固定的视图字符串改成Object类型,根据请求头判断结果返回对应内容:

    @ControllerAdvice
    class GlobalControllerExceptionHandler {
    
        private static final String JSON_ACCEPT_MARK = "application/json";
    
        @ResponseStatus(HttpStatus.NOT_FOUND)
        @ExceptionHandler(NoHandlerFoundException.class)
        public Object handle404(WebRequest request) {
            String acceptHeader = request.getHeader("Accept");
    
            // 判断是否需要返回JSON格式响应
            if (acceptHeader != null && acceptHeader.contains(JSON_ACCEPT_MARK)) {
                ApiError error = new ApiError();
                error.setStatus(HttpStatus.NOT_FOUND.value());
                error.setError(HttpStatus.NOT_FOUND.getReasonPhrase());
                error.setMessage("No message available");
                // 从请求上下文取当前访问的路径
                String path = (String) request.getAttribute(
                        HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE,
                        WebRequest.SCOPE_REQUEST
                );
                error.setPath(path);
                // 指定响应内容类型为JSON
                request.getResponse().setContentType(MediaType.APPLICATION_JSON_VALUE);
                return error;
            }
    
            // 非JSON请求,走原有404页面逻辑
            return "/exceptions/404";
        }
    }
    

实操注意点

  • 这种写法不需要在类或方法上加@ResponseBody:Spring MVC会自动识别返回值类型,返回字符串就走视图解析流程渲染HTML,返回POJO就通过Jackson序列化JSON,不会打乱原有逻辑。
  • 别手动往response里写JSON字符串,直接返回对象交给消息转换器处理,能和项目其他接口的序列化规则(比如日期格式、空值处理)保持一致。
  • 如果遇到Accept头同时声明多种类型(比如text/html,application/json)的优先级判断场景,可以注入ContentNegotiationManager解析客户端真正期望的响应类型,简单场景下直接匹配是否包含application/json就足够用。
  • 原有代码已经能正常触发404处理逻辑,说明项目里关于NoHandlerFoundException的相关配置(比如开启无路由抛异常、静态资源匹配规则)都是正常的,不需要额外调整。

内容的提问来源于stack exchange,提问作者Yuzuki Ayase

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.29 13:36:05