@ControllerAdvice根据不同的HTTP客户端返回不同的结果

ゝ一世哀愁。 2023-03-03 13:27 20阅读 0赞

## 前言 ##

该注解的作用就不用多说，但有时候我们的项目接口存在前后端混合接口（即有JSON格式，也有HTML格式的），要想在处理异常的时候根据不同情况来区分该如何做呢？

这个问题我看到很多博客封装了各种工具类来判断是Web还是Ajax等等一大堆的逻辑，说实在我并不看好这种配置。现在SpringBoot兴起，不知道大家有没有发现当我们在浏览器上请求接口（浏览器返回的是HTML格式）与在Postman请求接口（Postman返回的是JSON格式）返回的结果是不一样的。那SpringBoot是如何处理的呢？答案就在`BasicErrorController`这个类里面：

@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
    	public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) { 
    		HttpStatus status = getStatus(request);
    		Map<String, Object> model = Collections
    				.unmodifiableMap(getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.TEXT_HTML)));
    		response.setStatus(status.value());
    		ModelAndView modelAndView = resolveErrorView(request, response, status, model);
    		return (modelAndView != null) ? modelAndView : new ModelAndView("error", model);
    	}
    
    	@RequestMapping
    	public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) { 
    		HttpStatus status = getStatus(request);
    		if (status == HttpStatus.NO_CONTENT) { 
    			return new ResponseEntity<>(status);
    		}
    		Map<String, Object> body = getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.ALL));
    		return new ResponseEntity<>(body, status);
    	}

代码中`errorHtml`方法就是返回HTML的，`produces = MediaType.TEXT_HTML_VALUE`表示返回的是`text/html`。其本质就是SpringBoot根据客户端的请求头`Accept`来决定响应结果。那么好了，我们在异常处理器中也这么做就好了：

/** * 该类只返回JSON格式的数据，如果需要返回其它（如HTML、XML）请使用{@link ControllerExceptionHandler}。 * <p> * 之所以取名为RestControllerExceptionHandler，原因是只能处理由Spring MVC请求转发的异常， * 也就是说那些子线程抛出的异常或者某些不经过Spring MVC（比如安全框架Spring Security、Shiro、某些Filter等等）处理的抛出的异常， * 该类是无法拦截到的。 */
    @Slf4j
    @ControllerAdvice
    public class ControllerExceptionHandler { 
    
        /** * 400，一般就是请求参数与实际参数不匹配导致的。 * * @param exception * @return */
        @ResponseBody
        @ExceptionHandler({ BindException.class, MethodArgumentNotValidException.class,
                MissingServletRequestParameterException.class, HttpMessageNotReadableException.class})
        @ResponseStatus(HttpStatus.BAD_REQUEST)
        public Response badRequest(Exception exception) { 
            log.error(HttpStatus.BAD_REQUEST.getReasonPhrase(), exception);
            return Response.clientError(HttpStatus.BAD_REQUEST, exception.getMessage());
        }
    
    	// ……
    
        /** * 404，请求的地址路径不存在。 * * @param exception * @return */
        @ExceptionHandler(NoHandlerFoundException.class)
        @ResponseStatus(HttpStatus.NOT_FOUND)
        public Object notFound(NoHandlerFoundException exception, HttpServletRequest httpServletRequest,
                               HttpServletResponse httpServletResponse) throws IOException { 
            log.error(exception.getMessage());
    
            return this.forwardOrPrint(httpServletRequest, httpServletResponse, "404",
                    Response.clientError(HttpStatus.NOT_FOUND, exception.getMessage()));
        }
    
        /** * 500，服务内部异常导致的，所有未被处理的异常都被该方法捕获。 * * @param exception * @return */
        @ExceptionHandler(Exception.class)
        @ResponseStatus
        public String serverError(Exception exception, HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) throws IOException { 
            log.error(HttpStatus.INTERNAL_SERVER_ERROR.getReasonPhrase(), exception);
            return this.forwardOrPrint(httpServletRequest, httpServletResponse, "500", Response.serverError());
        }
    
        /** * 针对404或者500状态码下，并根据客户端接收的类型来决定返回的结果。 * * @param httpServletRequest * @param httpServletResponse * @param view * @param response * @return * @throws IOException */
        private String forwardOrPrint(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse,
                                      String view, Response response) throws IOException { 
            // 获取【Accept】请求头，来决定返回什么
            String accept = httpServletRequest.getHeader("Accept");
            if (StringUtils.isNotBlank(accept) && accept.contains(MediaType.TEXT_HTML_VALUE)) { 
                return view;
            } else { 
                httpServletResponse.setContentType(MediaType.APPLICATION_JSON_VALUE);
                PrintWriter printWriter = httpServletResponse.getWriter();
                printWriter.write(new ObjectMapper().writeValueAsString(response));
                printWriter.close();
                return null;
            }
        }
    }

在这里我们获取客户端的请求头`httpServletRequest.getHeader("Accept")`来决定返回的结果。由于HTML视图是需要转发到页面的，因此返回的是String（当然你也可以使用ModelAndView也是可以的），而JSON数据则需要通过流来打印到客户端，则不需要返回。

该方法的前提是需要客户端严格遵守HTTP协议，正确的设置`Accept`请求头的内容。

注意：  
不同版本的Spring方法可能有差别，自行调整即可。另外附上网友的补充博客：https://www.jianshu.com/p/6e7651705d29