Spring Boot全局异常处理

我们在开发项目时难免需要处理异常，但是怎样优雅的处理一场呢？今天就给大家介绍一下。

1、请求参数校验异常处理

        现在项目一般都已经前后端分离了，而表单校验或者JSON参数校验，一般都要求前后端都校验，而以前后端校验都是通过if判断空或者字符串长度，导致我们代码看起来很恶心，因此我们需要统一处理；

首先我们需要定义全局异常处理器，并且将需要拦截的异常定义一下

@RestControllerAdvice（该注解对Controller进行增强的，可以全局捕获spring mvc抛的异常。）

@ExceptionHandler({ BindException.class, MethodArgumentNotValidException.class })
 

@RestControllerAdvice
public class CommonExceptionHandler {
    /**
     * 日志管理
     */
    private static final LogUtil log = LogUtil.getLogger(CommonExceptionHandler.class);

    /**
     * 请求参数校验拦截处理
     *
     * @param exception 业务异常
     * @return 错误信息
     */
    @ExceptionHandler({ BindException.class, MethodArgumentNotValidException.class })
    public Object validationBodyException(Exception exception) {
        log.error("请求参数校验：{}", exception);
        BindingResult result = null;
        // 拦截表单提交 application/x-www-form-urlencoded
        if (exception instanceof BindException) {
            BindException bindException = (BindException) exception;
            result = bindException.getBindingResult();
        }
        // 拦截json提交 application/json
        if (exception instanceof MethodArgumentNotValidException) {
            MethodArgumentNotValidException bindException = (MethodArgumentNotValidException) exception;
            result = bindException.getBindingResult();
        }
        if (null == result) {
            return JsonResult.errorResult(ExceptionConstants.PARAM_CHECK_FAIL,
                    ExceptionConstants.getDefaultMessageMap().get(ExceptionConstants.PARAM_CHECK_FAIL));
        }
        StringBuilder message = new StringBuilder();
        if (result.hasErrors()) {
            List<ObjectError> errors = result.getAllErrors();
            for (ObjectError error : errors) {
                FieldError fieldError = (FieldError) error;
                log.error("Data check failure : object {},field {},errorMessage{}", fieldError.getObjectName(),
                        fieldError.getField(), fieldError.getDefaultMessage());
                message.append("【");
                message.append(fieldError.getDefaultMessage()).append("】 ");
            }
        }
        return JsonResult.errorResult(400, message.toString());
    }


   /**
     * 打印日志
     *
     * @param ex 异常信息
     * @param request 请求信息
     */
    private void printLog(Throwable ex, ServletRequest request) {
        try {
            ContentCachingRequestWrapper re = (ContentCachingRequestWrapper) request;
            StringBuilder stringBuilder = new StringBuilder();
            if (null != re) {
                stringBuilder.append("mark_end|uri=").append(re.getRequestURI()).append("|request=")
                        .append(JSON.toJSONString(new String(re.getContentAsByteArray(), StandardCharsets.UTF_8)))
                        .append("|ip=").append(CommonUtil.getRemoteAddress(re)).append("|");
            }
            stringBuilder.append(ex);
            log.error("{}", stringBuilder.toString());

        } catch (Exception e) {
            log.error("mark_end|{}", ex);
        }
    }
}

2、业务异常：以下添加的代码块都是伪代码

   /**
     * BusinessException 业务异常
     *
     * @param businessException 业务异常
     * @return 结果
     */
    @ExceptionHandler(BusinessException.class)
    @ResponseBody
    public JsonResult<Object> exceptionHandler(BusinessException businessException, ServletRequest request) {
        printLog(businessException, request);
        return JsonResult.errorResult(businessException.getErrorcode(), businessException.getMsg());
    }

3、SQL异常

 /**
     * 拦截SQLException类的异常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(SQLException.class)
    @ResponseBody
    public Result exceptionHandler(SQLException e) {
        printLog(businessException, request);
        return JsonResult.errorResult(businessException.getErrorcode(), businessException.getMsg());
    }

4、拦截未知异常

 /**
     * 处理异常返回
     *
     * @param ex 异常信息
     * @param request 请求信息
     * @return 输出结果
     */
    @ExceptionHandler({ Throwable.class })
    public JsonResult<Object> processError(Throwable ex, ServletRequest request) {

        JsonResult<Object> exceptionResult;
        printLog(ex, request);
        if (ex instanceof ConstraintViolationException) {
            ConstraintViolationException e = (ConstraintViolationException) ex;
            StringJoiner joiner = new StringJoiner(",");
            e.getConstraintViolations().forEach(p -> joiner.add(p.getMessage()));
            exceptionResult = JsonResult.errorResult(ManagementExceptionConstants.SYSTEM_ERROR, joiner.toString());
        } else if (ex instanceof MissingServletRequestParameterException
                || ex instanceof HttpRequestMethodNotSupportedException) {
            exceptionResult = JsonResult.errorResult(ManagementExceptionConstants.PARAM_CHECK_FAIL, ex.getMessage());
        } else if (!(ex.getCause() instanceof InvalidFormatException)
                && !(ex.getCause() instanceof NumberFormatException)) {
            if (!(ex.getCause() instanceof ResourceAccessException) && !(ex.getCause() instanceof ConnectException)
                    && !(ex.getCause() instanceof SocketException)) {
                if (ex.getCause() instanceof UnknownHostException) {
                    exceptionResult = JsonResult.errorResult(500, "发生未知错误");
                } else if (ex.getCause() instanceof HttpRequestMethodNotSupportedException) {
                    exceptionResult = JsonResult.errorResult(500, "不支持此方法");
                } else {
                    exceptionResult = JsonResult.errorResult(400, "参数错误");
                }
            } else {

                exceptionResult = JsonResult.errorResult(500, "不支持此方法");
            }
        } else {
            exceptionResult = JsonResult.errorResult(400, "参数错误");
        }
        return exceptionResult;
    }

补充JsonResult和BusinessException类

public class JsonResult<T> {
    @ApiModelProperty(value = "接口返回业务码 0：业务成功 其它：业务异常", required = true)
    private int code;

    @ApiModelProperty(value = "接口返回消息", required = true)
    private String message;

    @ApiModelProperty(value = "业务对象", required = true)
    private T data;

    /**
     * 成功返回json结果
     *
     * @param data 业务对象
     * @return json结果
     */
    public static <T> JsonResult<T> successResult(T data) {
        JsonResult<T> jsonResult = new JsonResult<>();
        jsonResult.setCode(ExceptionConstants.PARAM_SUCCESS);
        jsonResult.setMessage(
                ExceptionConstants.getDefaultMessageMap().get(ExceptionConstants.PARAM_SUCCESS));
        jsonResult.setData(data);
        return jsonResult;
    }

    /**
     * 成功返回json结果
     *
     * @param data 业务对象
     * @return json结果
     */
    public static <T> JsonResult<T> successResult(int code, String message, T data) {
        JsonResult<T> jsonResult = new JsonResult<>();
        jsonResult.setCode(code);
        jsonResult.setMessage(message);
        jsonResult.setData(data);
        return jsonResult;
    }

    /**
     * 失败返回json结果
     *
     * @param code    业务吗
     * @param message 返回消息
     * @return json结果
     */
    public static <T> JsonResult<T> errorResult(int code, String message) {
        JsonResult<T> jsonResult = new JsonResult<>();
        jsonResult.setCode(code);
        jsonResult.setMessage(message);
        return jsonResult;
    }

    /**
     * 失败返回json结果
     *
     * @param code 业务异常码,需要通过异常码匹配到异常信息
     * @param <T>
     * @return
     */
    public static <T> JsonResult<T> errorResult(int code) {
        JsonResult<T> jsonResult = new JsonResult<>();
        jsonResult.setCode(code);
        jsonResult.setMessage(ExceptionConstants.getMessage(code));
        return jsonResult;
    }

    /**
     * 失败返回json结果
     *
     * @param code    业务吗
     * @param message 返回消息
     * @param data    响应的业务数据
     * @return json结果
     */
    public static <T> JsonResult<T> errorResult(int code, String message, T data) {
        JsonResult<T> jsonResult = new JsonResult<>();
        jsonResult.setCode(code);
        jsonResult.setMessage(message);
        jsonResult.setData(data);
        return jsonResult;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    @Override
    public String toString() {
        return "JsonResult{"
                + "code=" + code
                + ", message='" + message + '\''
                + ", data=" + data + '}';
    }
}

public class BusinessException extends HystrixBadRequestException {
    private static final long serialVersionUID = -4674620081768391938L;
    private int code;
    private String message;

    public BusinessException(int code, String message) {
        super(String.format("BusinessException: code:%s, message:%s", code, message));
        this.code = code;
        this.message = message;
    }

    public BusinessException(int code, String message, Throwable e) {
        super(String.format("BusinessException: code:%s, message:%s", code, message), e);
        this.code = code;
        this.message = message;
    }

    public int getErrorcode() {
        return this.code;
    }

    public String getMsg() {
        return this.message;
    }
}