SpringBoot全局异常处理

在SpringMVC中可以使用ControllerAdvice来做controller内部的全局异常处理，但对于未进入controller前的异常，该处理方法是无法进行捕获处理的，SpringBoot提供了ErrorController的处理类来处理所有的异常。

 

20190530补充：

springboot提供了/error的错误管理端点和默认的BasicErrorController实现类，但这个Controller实现类其实不一定符合我们的需求，所以我们才需要来覆盖这个默认实现。

其中：BasicErrorController extend AbstractErrorController ，AbstractErrorController  又 implements ErrorController。

下面的类是直接实现了ErrorController，其实我们也可以仿照BasicErrorController来继承AbstractErrorController减少一些代码的编写。

 

import java.util.Map;

import javax.servlet.http.HttpServletRequest;

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.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.ServletRequestAttributes;

import com.tomato.boss.common.base.ResponseResult;

import lombok.extern.slf4j.Slf4j;
import springfox.documentation.annotations.ApiIgnore;

/**
 * 全局异常处理，当异常被@ControllerAdvice时不会走到这个处理类，没被处理时会走到这里
 * 例如 @valid入参校验失败的是不会走ControllerAdvice的，但会走这个处理器
 * @author yangzhilong
 *
 */
@RestController
@ApiIgnore
@Slf4j
public class GolablExceptionEndpoint implements ErrorController{
    
    private static final String PATH = "/error";
    
    @Autowired
    private ErrorAttributes errorAttributes;

    @Override
    public String getErrorPath() {
        return PATH;
    }
    
    /**
     * 全局异常处理
     * 增加@ResponseStatus注解将非200的http状态码转成200
     * @return
     */
    @RequestMapping(value = PATH)
    @ResponseStatus(code=HttpStatus.OK)
    public ResponseResult<Object> error(HttpServletRequest request) {
        return handlerError(request, false);
    }
    
    /**
     * 具体的处理
     * @param request
     * @param includeStackTrace
     * @return
     */
    private ResponseResult<Object> handlerError(HttpServletRequest request, boolean includeStackTrace) {
        RequestAttributes requestAttributes = new ServletRequestAttributes(request);
        Throwable e = errorAttributes.getError(requestAttributes);
        
        Map<String, Object> data = errorAttributes.getErrorAttributes(requestAttributes, includeStackTrace);
        
        String message = null;
        StringBuilder detailMessage = new StringBuilder("");
        
        HttpStatus status = getStatus(request);
        if(status == HttpStatus.BAD_REQUEST) {
            log.error("参数校验失败", e);
            message = "请检查数据填写是否合法";
        } else if(status == HttpStatus.INTERNAL_SERVER_ERROR) {
            log.error("系统错误", e);
            message = "系统繁忙";
        } else if(status == HttpStatus.NOT_FOUND) {
            log.error("404错误");
            message = "服务或者页面不存在";
        } else {
            log.error("系统错误", e);
            message = "系统出错,未知错误";
        }
        if(null != data.get("error")) {
            detailMessage.append(String.valueOf(data.get("error"))).append(":");
        }
        if(null == e || null == e.getMessage()) {
            if(null != data.get("message")) {
                detailMessage.append(String.valueOf(data.get("message")));
            }
        } else {
            detailMessage.append(e.getMessage());
        }
        
        return ResponseResult.buildFailResponse(String.valueOf(data.get("status")), message, detailMessage.toString());
    }
    
    /**
     * 获取错误编码
     * @param request
     * @return
     */
    private HttpStatus getStatus(HttpServletRequest request) {
        Integer statusCode = (Integer) request
                .getAttribute("javax.servlet.error.status_code");
        if (statusCode == null) {
            return HttpStatus.INTERNAL_SERVER_ERROR;
        }
        try {
            return HttpStatus.valueOf(statusCode);
        }
        catch (Exception ex) {
            return HttpStatus.INTERNAL_SERVER_ERROR;
        }
    }
}