spring boot 全局Controller错误处理器

背景

SpringBoot默认有自定义异常处理的体系，在做SpringBoot项目的时候，如果是抛出了运行时异常，springBoot并会对异常进行处理;

1. json接口返回如下异常信息:
{
 "timestamp": 1478571808052,
 "status": 404,
 "error": "Not Found",
 "message": "No message available",
 "path": "/json/rpc"
}

2. html接口返回如下信息:

Whitelabel Error Page

This application has no explicit mapping for /html/rpc, so you are seeing this as a fallback.

Thu Sep 07 16:27:43 CST 2018
There was an unexpected error (type=Not Found, status=404).
No message available

追究其原因，发现SpirngBoot出现异常信息时候，会默认访问/error,springBoot种有BasicErrorController这个类来处理异常信息.

改造

我们通过继承ErrorController,实现自己的处理器

package cn.pomelo.controller;

import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.web.ErrorAttributes;
import org.springframework.boot.autoconfigure.web.ErrorController;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.servlet.ModelAndView;
import com.alibaba.fastjson.JSON;

/**
 * 统一错误处理。<br/>
 * 
 * @see {http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#howto-customize-the-whitelabel-error-page}
 * @see {http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-error-handling} <br/>
 */
@Controller
public class CommonErrorController implements ErrorController {

    private static final Logger logger     = LoggerFactory.getLogger(CommonErrorController.class);

    public final static String  ERROR_PATH = "/error";

    @Autowired
    private ErrorAttributes     errorAttributes;

    /**
     * Supports other formats JSON
     * 
     * @param request HttpServletRequest
     * @return ResponseEntity
     */
    @RequestMapping(value = ERROR_PATH, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
    @ResponseBody
    public String error(HttpServletRequest request) {
        Map<String, Object> body = getErrorAttributes(request);
        HttpStatus status = getStatus(request);
        return JSON.toJSONString(new ResponseEntity<>(body, status).getBody());
    }

    /**
     * Supports the HTML Error View
     * 
     * @param request HttpServletRequest
     * @return ModelAndView
     */
    @RequestMapping(value = ERROR_PATH, produces = MediaType.TEXT_HTML_VALUE)
    public ModelAndView errorHtml(HttpServletRequest request) {
        return new ModelAndView("globalError", getErrorAttributes(request));
    }

    /**
     * 错误信息详情map
     * 
     * @param request
     * @return ErrorAttributes
     */
    private Map<String, Object> getErrorAttributes(HttpServletRequest request) {
        RequestAttributes requestAttributes = new ServletRequestAttributes(request);
        Map<String, Object> map = errorAttributes.getErrorAttributes(requestAttributes, isTrace(request));
        if (request.getAttribute("status") instanceof Integer) {
            map.put("status", request.getAttribute("status"));
        }
        map.put("url", request.getRequestURL().toString());
        map.putIfAbsent("path", request.getAttribute("raw_url"));
        if (logger.isInfoEnabled()) {
            logger.info("error occurred, status={}, path={}, msg={}, error={}, exception={}", map.get("status"),
                        map.get("path"), map.get("message"), map.get("error"), map.get("exception"));
        }
        return map;
    }

    /**
     * 获取状态码
     * 
     * @param request HttpServletRequest
     * @return HttpStatus
     */
    private HttpStatus getStatus(HttpServletRequest request) {
        Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code");
        if (statusCode == null) {
            return HttpStatus.INTERNAL_SERVER_ERROR;
        }
        return HttpStatus.valueOf(statusCode);
    }

    /**
     * 是否打印错误信息
     * 
     * @param request HttpServletRequest
     * @return if trace error
     */
    private boolean isTrace(HttpServletRequest request) {
        String parameter = request.getParameter("trace");
        if (parameter == null) {
            return false;
        }
        return !"false".equals(parameter.toLowerCase());
    }

    @Override
    public String getErrorPath() {
        return ERROR_PATH;
    }
}

修改后结果：

1. json返回：
{
 "status": 404
 "url": "/json/rpc",
 "path": "/json/rpc?p=1"
}

2. html页面返回：
渲染视图：globalError.html

赏

谢谢你请我吃糖果