SpringBoot 全局异常处理

最新推荐文章于 2024-10-31 10:35:12 发布

yllrayray

最新推荐文章于 2024-10-31 10:35:12 发布

阅读量276

点赞数 5

CC 4.0 BY-SA版权

文章标签： spring boot 后端 java

本文链接：https://blog.youkuaiyun.com/yllrayray/article/details/139526197

参考文档：

优雅地进行全局异常处理、统一返回值封装、自定义异常错误码——Graceful-Response推荐-腾讯云开发者社区-腾讯云 (tencent.com)

浅析@ResponseStatus的作用、属性、用法、底层原理及使用注意事项 - 古兰精 - 博客园 (cnblogs.com)

【规范】SpringBoot接口返回结果及异常统一处理，这样封装才优雅 - 知乎 (zhihu.com)

1、概念区分

http状态码 VS body 响应体中的code

两者都可以自定义，区别在于restful返回的响应体中，两者的所在的位置不同。

2、全局异常捕获

package com.common.handler;


import com.baomidou.mybatisplus.core.toolkit.ObjectUtils;
import com.baomidou.mybatisplus.extension.api.R;
import com.common.model.HandleEnum;
import com.common.model.HttpStatusBiz;
import com.common.model.ResponseResult;
import com.common.util.UserTipGenerator;
import com.common.util.Utils;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.exc.InvalidFormatException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;

import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.stream.Collectors;


/**
 * 全局异常处理
 * ×  只能在全局controller 拦截 无法获取Method的异常
 *
 * @author 00
 */
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 业务异常
     */
    @ExceptionHandler(ServiceException.class)
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    public ResponseResult handleServiceException(ServiceException e) {
        log.error(e.getMessage(), e);
        Integer code = e.getCode();
        return ObjectUtils.isNotNull(code) ? ResponseResult.fail(code, e.getMessage()) : ResponseResult.fail(e.getMessage());
    }

    /**
     * 参数校验失败
     */
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    @ExceptionHandler(javax.validation.ConstraintViolationException.class)
    public ResponseResult handleconstrainViolationException(ConstraintViolationException e, HttpServletRequest request) {
        // 下面这种方式，可以返回所有字段的查检不通过的结果
        String res = e.getConstraintViolations().stream()
                .map(ConstraintViolation::getMessage)
                .collect(Collectors.joining(";"));

        String requestURI = request.getRequestURI();
        log.error("请求地址'{}',发生未知异常.", requestURI, e);
        return ResponseResult.fail(HttpStatusBiz.BadRequest.getCode(), res);
    }

    @ExceptionHandler(org.springframework.web.bind.MethodArgumentNotValidException.class)
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    public ResponseResult methodArgNotValidException(org.springframework.web.bind.MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        if (!bindingResult.hasErrors()) {
            e.printStackTrace();
            return ResponseResult.fail(HttpStatusBiz.BadRequest.getCode(), "系统异常，入参校验失败");
        }
        String res2 = bindingResult.getFieldErrors().stream()
                .map(fieldError -> fieldError.getField() + ": " + fieldError.getDefaultMessage())
                .collect(Collectors.joining("; "));
        return ResponseResult.fail(HttpStatusBiz.BadRequest.getCode(), res2);
    }


    @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    public ResponseResult methodNotSupportException(HttpRequestMethodNotSupportedException e) {
        return ResponseResult.fail(HttpStatusBiz.BadRequest.getCode(), "接口仅支持如下请求方式: " + Arrays.toString(e.getSupportedMethods()));
    }

    /**
     * <p>该ExceptionHandler对应的情况：在调用【入参为格式requestBody】的接口时：
     * <ul>
     *     <li>1) 不传body请求体</li>
     *     <li>2) 或传的body请求体格式错误，如：<b>{ "age": 130, ""}</b></li>
     *     <li>3) 或传的body请求体内的日期格式错误</li>
     * </ul>
     * 此时如果不进行对应的异常处理，则会报{@link org.springframework.http.converter.HttpMessageNotReadableException}异常且返回如下的
     */
    @ExceptionHandler(HttpMessageNotReadableException.class)
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    public ResponseResult httpMsgNotReadableExp(HttpMessageNotReadableException e) {

        Throwable rootCause = e.getRootCause();

        // 无效格式异常处理。比如：目标格式为数值，输入为非数字的字符串（"80.5%"、"8.5.1"、"张三"）。
        if (rootCause instanceof InvalidFormatException) {
            String userMessage = UserTipGenerator.getUserMessage((InvalidFormatException) rootCause);
            String format = "HttpMessageNotReadableException-InvalidFormatException（Http消息不可读异常-无效格式异常）：%s";
            String errorMessage = String.format(format, e.getMessage());
            log.error(userMessage);
            log.error(errorMessage);
            return ResponseResult.fail(HttpStatusBiz.BadRequest.getCode(), errorMessage);
        }

        String userMessage = "Http消息不可读异常！请稍后重试，或联系业务人员处理。";
        String errorMessage = String.format("HttpMessageNotReadableException（Http消息不可读异常）：%s", e.getMessage());
        log.error(userMessage);
        log.error(errorMessage);
        return ResponseResult.fail(HttpStatusBiz.BadRequest.getCode(), errorMessage);
    }


    /**
     * <p>该ExceptionHandler对应的情况：在调用【入参设置为如(@RequestParam("name") String name)】的接口时 ，入参name却不传（为null）的时候报的异常
     * 则会报{@link org.springframework.web.bind.MissingServletRequestParameterException}异常
     * <p>如果不做此异常捕获处理，则接口返回如下的 <b>不友好的结果</b> 给调用方：
     * <p>{
     * <p>   "timestamp": "2023-12-29T03:10:57.961+0000",
     * <p>     "status": 400,
     * <p>     "error": "Bad Request",
     * <p>     "message": "Required String parameter 'name' is not present",
     * <p>     "path": "/param_type/get_reqestparam"
     * <p> }
     */
    @ExceptionHandler(org.springframework.web.bind.MissingServletRequestParameterException.class)
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    public ResponseResult missingRequestParamException(MissingServletRequestParameterException e) {
        e.printStackTrace();
        return ResponseResult.fail(HttpStatusBiz.BadRequest.getCode(), e.getMessage());
    }

    /**
     * <p>该ExceptionHandler对应的是类似如下的情况入参类型错误：
     * <ul>
     *     <li>1) 字段age类型是Integer，但是入参却是test这样的字符串</li>
     *     <li>2) 字段enable类型是Boolean，但是入参却是666这样的数值</li>
     *     <li>3) 字段birth类型是Date且@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")，但是入参却是<i>20230101</i>这样的错误格式</li>
     *     <li>4) 等等</li>
     * </ul>
     */
    @ExceptionHandler(org.springframework.web.method.annotation.MethodArgumentTypeMismatchException.class)
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    public ResponseResult methodArgTypeMismatchException(MethodArgumentTypeMismatchException e) throws JsonProcessingException {
        String fieldName = e.getName();
        String errorStr = e.getCause().toString();
        HashMap<String, String> map = new HashMap<>();
        map.put(fieldName, errorStr);
        return ResponseResult.fail(HttpStatusBiz.BadRequest.getCode(), Utils.toStringByJackson(map));
    }
    /**
     * <p>"BindException" 错误通常是以下原因引起的：
     * <ul>
     * <li>绑定参数错误：如果您的绑定参数错误，则可能会出现此错误。在这种情况下，您需要检查您的绑定参数并确保它们正确。</li>
     * <li>绑定参数类型不正确：如果传入的参数类型不正确，则可能会出现此错误</li>
     * </ul>
     */
    @ExceptionHandler(org.springframework.validation.BindException.class)
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    public ResponseResult bindingException(BindException e) throws JsonProcessingException {
        BindingResult bindingResult = e.getBindingResult();

        HashMap<String, String> map = new HashMap<>();
        bindingResult.getFieldErrors().stream()
                .forEach(fieldError -> map.put(fieldError.getField(), fieldError.getDefaultMessage()));
        return ResponseResult.fail(HttpStatusBiz.BadRequest.getCode(), Utils.toStringByJackson(map));
    }

    /**
     * 拦截未知的运行时异常
     */
    @ExceptionHandler(RuntimeException.class)
    @ResponseStatus(value = HttpStatus.NOT_ACCEPTABLE)
    public ResponseResult handleRuntimeException(RuntimeException e, HttpServletRequest request) {
        String requestURI = request.getRequestURI();
        log.error("请求地址'{}',发生未知异常.", requestURI, e);
        return ResponseResult.fail(e.getMessage());
    }

    /**
     * 系统异常
     */
    @ExceptionHandler(Exception.class)
    @ResponseStatus(value = HttpStatus.NOT_ACCEPTABLE)
    public ResponseResult handleException(Exception e, HttpServletRequest request) {
        String requestURI = request.getRequestURI();
        log.error("请求地址'{}',发生系统异常.", requestURI, e);
        return ResponseResult.fail(e.getMessage());
    }
}

其中：

@ResponseStatus用于设置http响应状态码

HttpStatusBiz 自定义的业务响应code码

ResponseResult 封装的请求体

package com.common.model;

import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;


/**
 * 结果返回类
 *
 * @author ican
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ResponseResult<T> implements Serializable {

    /**
     * 状态码
     */
    private Integer code;
    /**
     * 状态信息
     */
    @ApiModelProperty(value = "状态信息")
    private Boolean status;
    /**
     * 返回信息
     */
    @ApiModelProperty(value = "返回信息")
    private String message;
/*
    *//**
     * 数据
     *//*
    @ApiModelProperty(value = "数据")
    private T data;

    *//**
     * 全参数方法
     *
     * @param code    状态码
     * @param status  状态
     * @param message 返回信息
     * @param data    返回数据
     * @param <T>     泛型
     * @return {@link ResponseResult<T>}
     *//*
    private static <T> ResponseResult<T> response(Integer code, Boolean status, String message, T data) {
        ResponseResult<T> responseResult = new ResponseResult<>();
        responseResult.setCode(code);
        responseResult.setStatus(status);
        responseResult.setMessage(message);
        responseResult.setData(data);
        return responseResult;
    }*/
    /**
     * 全参数方法
     *
     * @param code    状态码
     * @param status  状态
     * @param message 返回信息
     * @param <T>     泛型
     * @return {@link ResponseResult<T>}
     */
    private static <T> ResponseResult<T> response(Integer code, Boolean status, String message) {
        ResponseResult<T> responseResult = new ResponseResult<>();
        responseResult.setCode(code);
        responseResult.setStatus(status);
        responseResult.setMessage(message);
        return responseResult;
    }
    /**
     * 成功返回（无参）
     *
     * @param <T> 泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> success() {
        return response(HttpStatusBiz.Succeeded.getCode(), true, HttpStatusBiz.Succeeded.getMessage());
    }
    /**
     * 成功返回（枚举参数）
     *
     * @param httpResponseEnum 枚举参数
     * @param <T>              泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> success(HttpStatusBiz httpResponseEnum) {
        return response(httpResponseEnum.getCode(), true, httpResponseEnum.getMessage());
    }
    /**
     * 成功返回（状态码+返回信息）
     *
     * @param code    状态码
     * @param message 返回信息
     * @param <T>     泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> success(Integer code, String message) {
        return response(code, true, message);
    }
    /**
     * 成功返回（返回信息 + 数据）
     *
     * @param message 返回信息
     * @param data    数据
     * @param <T>     泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> success(String message, T data) {
        return response(HttpStatusBiz.Succeeded.getCode(), true, message);
    }
    /**
     * 成功返回（状态码+返回信息+数据）
     *
     * @param code    状态码
     * @param message 返回信息
     * @param data    数据
     * @param <T>     泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> success(Integer code, String message, T data) {
        return response(code, true, message);
    }
    /**
     * 成功返回（数据）
     *
     * @param data 数据
     * @param <T>  泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> success(T data) {
        return response(HttpStatusBiz.Succeeded.getCode(), true, HttpStatusBiz.Succeeded.getMessage());
    }
    /**
     * 成功返回（返回信息）
     *
     * @param message 返回信息
     * @param <T>  泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> success(String message) {
        return response(HttpStatusBiz.Succeeded.getCode(), true, message);
    }
    /**
     * 失败返回（无参）
     *
     * @param <T> 泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> fail() {
        return response(HttpStatusBiz.Error.getCode(), false, HttpStatusBiz.Error.getMessage());
    }
    /**
     * 失败返回（枚举）
     *
     * @param httpResponseEnum 枚举
     * @param <T>              泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> fail(HttpStatusBiz httpResponseEnum) {
        return response(httpResponseEnum.getCode(), false, httpResponseEnum.getMessage());
    }
    /**
     * 失败返回（状态码+返回信息）
     *
     * @param code    状态码
     * @param message 返回信息
     * @param <T>     泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> fail(Integer code, String message) {
        return response(code, false, message);
    }
    /**
     * 失败返回（返回信息+数据）
     *
     * @param message 返回信息
     * @param data    数据
     * @param <T>     泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> fail(String message, T data) {
        return response(HttpStatusBiz.Error.getCode(), false, message);
    }

    /**
     * 失败返回（状态码+返回信息+数据）
     *
     * @param code    状态码
     * @param message 返回消息
     * @param data    数据
     * @param <T>     泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> fail(Integer code, String message, T data) {
        return response(code, false, message);
    }
    /**
     * 失败返回（数据）
     *
     * @param data 数据
     * @param <T>  泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> fail(T data) {
        return response(HttpStatusBiz.Error.getCode(), false, HttpStatusBiz.Error.getMessage());
    }
    /**
     * 失败返回（返回信息）
     *
     * @param message 返回信息
     * @param <T>  泛型
     * @return {@link ResponseResult<T>}
     */
    public static <T> ResponseResult<T> fail(String message) {
        return response(HttpStatusBiz.Error.getCode(), false, message);
    }
}

package com.common.model;

import lombok.AllArgsConstructor;
import lombok.Getter;

@Getter
@AllArgsConstructor
public enum HttpStatusBiz {
    /**
     * 成功
     */
    Succeeded("Succeeded",200),
    /**
     * 成功
     */
    Error("Error",400),
    /**
     * 失败
     */
    NotSupport("资源不足，不支持运行", 4001),
    /**
     * 失败
     */
    ParamsInValidated("输入参数有误", 4002),
    /**
     * 失败
     */
    DBNotSupport("没有查询到需要处理的任务", 4003),
    /**
     * 失败
     */
    DBInsertFailed("数据库插入失败", 4004),
    /**
     * 失败
     */
    DBUpdateFailed("数据库更新失败", 4005),
    /**
     * 失败
     */
    AlgorithmFailed("回调处理，当前算法运行失败", 4006),
    /**
     * 失败
     */
    BadRequest("参数校验失败", 4007),
    /**
     * 失败
     */
    ServiceFailed("其他", 4008);


    /**
     * 状态
     */
    private final String message;
    private final Integer code;

    public static HttpStatusBiz geHttpStatusBiz(String msg) {
        for (HttpStatusBiz value : HttpStatusBiz.values()) {
            if (value.getMessage().equals(msg)) {
                return value;
            }
        }
        return null;
    }

}