spring boot ErrorMvcAutoConfiguration 问题

ErrorMvcAutoConfiguration

当mvc出现错误时，会使用该配置类进行处理异常流程。

前言

本人，在使用spring boot时，遇到了一些问题。我已经封装好了统一的接口返回类，但是当项目出现异常时（系统异常或自定义的异常），spring-mvc都会转发到 /error 接口进行异常处理，这就导致了前端接收的json格式不一致，难以维护。

解决办法

自定义 /error 处理流程

下面是 BasicErrorController 处理 /error 的源代码,两个方法分别处理 浏览器和客户端请求，我们需要自定义异常流程，不使用他的流程。

@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);
}

自定义异常流程

/**
 * 自定义 /error 映射
 * @Author msi
 * @Date 2021-05-25 10:53
 * @Version 1.0
 */
@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class ErrorController extends AbstractErrorController {

    @Resource
    private ErrorAttributes errorAttributes;

    public ErrorController(org.springframework.boot.web.servlet.error.ErrorAttributes errorAttributes) {
        super(errorAttributes);
    }

    /**
     * mvc 错误时，跳转到/error请求，并自定义返回状态码和对应的json数据
     * @param request
     * @return
     */
    @RequestMapping
    public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
        // 获取异常信息
        Map<String, Object> body = errorAttributes.getErrorAttributes(new ServletWebRequest(request), ErrorAttributeOptions.defaults());
		// 获取响应码，响应码跟异常信息有关。
        int code = (int)request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
        HttpStatus status = HttpStatus.resolve(code);
        return new ResponseEntity<>(body, status);
    }

    /**
     * @deprecated
     */
    @Override
    public String getErrorPath() {
        return null;
    }
}

自定义异常json数据

根据请求对象，获取异常对象，然后获取异常对象的各属性进行封装成map。

/**
 * 自定义异常逻辑，返回自定义格式的json错误信息
 * @Author msi
 * @Date 2021-05-25 9:53
 * @Version 1.0
 */
@Component
public class ErrorAttributes extends DefaultErrorAttributes {
    @Resource
    private HttpServletRequest request;

    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
        Throwable error = super.getError(webRequest);
        // 系统中我抛出的异常都是 BasicException 自定义异常
        if (error instanceof BasicException) {
            BasicException be = (BasicException) error;
            Result result = Result.ofFail(be);
            // hutool 中的对象转map工具类
            Map<String, Object> map = BeanUtil.beanToMap(result);

            // 将错误的响应码，设置到请求对象中，当 /error处理完后，返回该状态码。
            request.setAttribute(RequestDispatcher.ERROR_STATUS_CODE, be.getStatus());
            return map;
        }
        // 其它错误异常，使用默认的json数据。
        return super.getErrorAttributes(webRequest, options);
    }

}

结语

修改默认的/error请求，进行自定的json数据组装，保证接口返回的格式固定。