捕获各类异常的工具类

二编

先封装一个返回体 RespResult.java

import java.util.Date;

public class RespResult<T> {
    public static final int SUCCESS = 0;
    public static final int ERROR = 1;
    public static final int WARNING = 2;
    public static final int INFO = 3;
    private String msg;
    private int level;
    private T data;
    private Date timestamp;

    public static RespResult<Object> success() {
        return new RespResult(0);
    }

    public static RespResult<Object> info(String msg) {
        return new RespResult(3, msg);
    }

    public static RespResult<Object> error(String msg) {
        return new RespResult(1, msg);
    }

    public static RespResult<Object> warning(String msg) {
        return new RespResult(2, msg);
    }

    public static <T> RespResult<T> success(T data) {
        return new RespResult(0, "", data);
    }

    public static <T> RespResult<T> success(String msg, T data) {
        return new RespResult(0, msg, data);
    }

    public static <T> RespResult<T> info(String msg, T data) {
        return new RespResult(3, msg, data);
    }

    public static <T> RespResult<T> error(String msg, T data) {
        return new RespResult(1, msg, data);
    }

    public static <T> RespResult<T> warning(String msg, T data) {
        return new RespResult(2, msg, data);
    }

    public RespResult() {
        this(0);
    }

    public RespResult(int level) {
        this(level, "");
    }

    public RespResult(int level, String msg) {
        this(level, msg, (T) null);
    }

    public RespResult(int code, String msg, T data) {
        this.level = code;
        this.msg = msg;
        this.data = data;
        this.timestamp = new Date();
    }

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

    public int getLevel() {
        return this.level;
    }

    public T getData() {
        return this.data;
    }

    public Date getTimestamp() {
        return this.timestamp;
    }

    public void setMsg(final String msg) {
        this.msg = msg;
    }

    public void setLevel(final int level) {
        this.level = level;
    }

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

    public void setTimestamp(final Date timestamp) {
        this.timestamp = timestamp;
    }
}

编写全局异常处理方法 ControllerHandlerAdvice.java

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.support.MessageSourceAccessor;
import org.springframework.context.support.ReloadableResourceBundleMessageSource;
import org.springframework.http.HttpStatus;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.HttpMediaTypeNotSupportedException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ControllerAdvice;
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.method.annotation.MethodArgumentTypeMismatchException;
import org.springframework.web.multipart.MaxUploadSizeExceededException;
import org.springframework.web.multipart.MultipartException;
import org.springframework.web.servlet.NoHandlerFoundException;

import java.nio.charset.StandardCharsets;
import java.util.Objects;

@ConditionalOnClass({MessageSourceAccessor.class})
@ControllerAdvice
@ResponseBody
@Slf4j
public class ControllerHandlerAdvice {
    protected final MessageSourceAccessor messageSourceAccessor;

    public ControllerHandlerAdvice() {
        ReloadableResourceBundleMessageSource reloadableResourceBundleMessageSource = new ReloadableResourceBundleMessageSource();
        reloadableResourceBundleMessageSource.setBasenames("classpath:i18n/messages");
        reloadableResourceBundleMessageSource.setCacheSeconds(3600);
        reloadableResourceBundleMessageSource.setDefaultEncoding(StandardCharsets.UTF_8.name());
        this.messageSourceAccessor = new MessageSourceAccessor(reloadableResourceBundleMessageSource);
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({MissingServletRequestParameterException.class})
    public RespResult<?> handleMissingServletRequestParameterException(MissingServletRequestParameterException e) {
        log.error("MissingServletRequestParameterException 缺少请求参数 getParameterName = {} type = {}", e.getParameterName(), e.getParameterType());
        // return RespResult.warning(this.messageSourceAccessor.getMessage("controller.parameter.MissingServletRequest", new Object[]{e.getParameterName()}));
        return RespResult.warning(e.getMessage());
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({HttpMessageNotReadableException.class})
    public RespResult<?> handleHttpMessageNotReadableException(HttpMessageNotReadableException e) {
        log.error("HttpMessageNotReadableException 请求体解析失败 = {}", e.getMessage());
        // return RespResult.warning(this.messageSourceAccessor.getMessage("controller.parameter.HttpMessageNotReadable"));
        return RespResult.warning(e.getMessage());
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({MethodArgumentNotValidException.class})
    public RespResult<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        log.error("MethodArgumentNotValidException 参数验证失败 = {}", e.getMessage());
        return this.parseBindingResult(e.getBindingResult());
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({BindException.class})
    public RespResult<?> handleBindException(BindException e) {
        log.error("BindException 参数验证失败 = {}", e.getMessage());
        return this.parseBindingResult(e.getBindingResult());
    }

    private RespResult<?> parseBindingResult(BindingResult result) {
        if (result.hasFieldErrors()) {
            FieldError fieldError = result.getFieldError();
            assert fieldError != null;
            String field = fieldError.getField();
            return RespResult.warning(fieldError.getDefaultMessage(), field);
        } else {
            // return RespResult.warning(this.messageSourceAccessor.getMessage("controller.parameter.MethodArgumentNotValid.empty"));
            return RespResult.warning("controller.parameter.MethodArgumentNotValid.empty");
        }
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({MethodArgumentTypeMismatchException.class})
    public RespResult<?> handleMethodArgumentTypeMismatchException(MethodArgumentTypeMismatchException ex) {
        log.error("MethodArgumentTypeMismatchException 参数类型出错，转换失败！\n方法：{}\n期望参数类型：{}\n参数：{}\n信息：{}",
                Objects.requireNonNull(ex.getParameter().getMethod()).getName(),
                ex.getParameter().getParameterType(), ex.getName(), ex.getMessage());
        // String type = Objects.requireNonNull(ex.getRequiredType()).getSimpleName();
        // Object value = ex.getValue();
        // return RespResult.error(this.messageSourceAccessor.getMessage("controller.parameter.ArgumentTypeMismatch", new Object[]{type, value}));
        return RespResult.error(ex.getMessage());
    }

    @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
    @ExceptionHandler({HttpRequestMethodNotSupportedException.class})
    public RespResult<?> handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) {
        log.error("不支持的请求方法 = {} ", e.getMethod());
        // return RespResult.error(this.messageSourceAccessor.getMessage("controller.MethodNotSupported", new Object[]{e.getMethod()}));
        return RespResult.error(e.getMessage());
    }

    @ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
    @ExceptionHandler({HttpMediaTypeNotSupportedException.class})
    public RespResult<?> handleHttpMediaTypeNotSupportedException(HttpMediaTypeNotSupportedException e) {
        log.error("不支持当前媒体类型 = {}", e.getContentType());
        // return RespResult.info(this.messageSourceAccessor.getMessage("controller.HttpMediaTypeNotSupported", new Object[]{e.getContentType()}));
        return RespResult.info(e.getMessage());
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({MultipartException.class})
    public RespResult<?> handleMultipartException(MultipartException e) {
        log.error("上传文件失败", e);
        String message = "upload.fail";
        if (e instanceof MaxUploadSizeExceededException) {
            message = "upload.fail.exceeded.max.size";
        }
        // return RespResult.warning(this.messageSourceAccessor.getMessage(message));
        return RespResult.warning(message);
    }

    @ResponseStatus(HttpStatus.NOT_FOUND)
    @ExceptionHandler({NoHandlerFoundException.class})
    public RespResult<?> noHandlerFoundException(NoHandlerFoundException e) {
        log.error("Not Found = {}", e.getRequestURL());
        // return RespResult.info(this.messageSourceAccessor.getMessage("controller.404"));
        return RespResult.error(e.getMessage());
    }

    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler({Exception.class})
    public RespResult<?> handleException(Exception e) {
        log.error("通用异常 = e.class = {} message = {}", e.getClass(), e.getMessage(), e);
        // return RespResult.error(this.messageSourceAccessor.getMessage("controller.500"));
        return RespResult.error(e.getMessage());
    }

}

一编

import cn.mbdoge.jyx.exception.LocalServiceException;
import cn.mbdoge.jyx.exception.RequestLimitException;
import cn.mbdoge.jyx.web.model.RespResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.support.MessageSourceAccessor;
import org.springframework.context.support.ReloadableResourceBundleMessageSource;
import org.springframework.http.HttpStatus;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.HttpMediaTypeNotSupportedException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ControllerAdvice;
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.method.annotation.MethodArgumentTypeMismatchException;
import org.springframework.web.multipart.MaxUploadSizeExceededException;
import org.springframework.web.multipart.MultipartException;
import org.springframework.web.servlet.NoHandlerFoundException;

import java.nio.charset.StandardCharsets;
import java.nio.file.AccessDeniedException;
import java.util.Objects;

@ConditionalOnClass({MessageSourceAccessor.class})
@ControllerAdvice
@ResponseBody
public class ControllerHandlerAdvice {
    private static final Logger log = LoggerFactory.getLogger(cn.mbdoge.jyx.web.handler.ControllerHandlerAdvice.class);
    protected final MessageSourceAccessor messageSourceAccessor;

    public ControllerHandlerAdvice() {
        ReloadableResourceBundleMessageSource reloadableResourceBundleMessageSource = new ReloadableResourceBundleMessageSource();
        reloadableResourceBundleMessageSource.setBasenames("classpath:i18n/messages");
        reloadableResourceBundleMessageSource.setCacheSeconds(3600);
        reloadableResourceBundleMessageSource.setDefaultEncoding(StandardCharsets.UTF_8.name());
        this.messageSourceAccessor = new MessageSourceAccessor(reloadableResourceBundleMessageSource);
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({MissingServletRequestParameterException.class})
    public RespResult<?> handleMissingServletRequestParameterException(MissingServletRequestParameterException e) {
        log.error("MissingServletRequestParameterException 缺少请求参数 getParameterName = {} type = {}", e.getParameterName(), e.getParameterType());
        // return RespResult.warning(this.messageSourceAccessor.getMessage("controller.parameter.MissingServletRequest", new Object[]{e.getParameterName()}));
        return RespResult.warning(e.getMessage());
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({HttpMessageNotReadableException.class})
    public RespResult<?> handleHttpMessageNotReadableException(HttpMessageNotReadableException e) {
        log.error("HttpMessageNotReadableException 请求体解析失败 = {}", e.getMessage());
        // return RespResult.warning(this.messageSourceAccessor.getMessage("controller.parameter.HttpMessageNotReadable"));
        return RespResult.warning(e.getMessage());
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({MethodArgumentNotValidException.class})
    public RespResult<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        log.error("MethodArgumentNotValidException 参数验证失败 = {}", e.getMessage());
        return this.parseBindingResult(e.getBindingResult());
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({BindException.class})
    public RespResult<?> handleBindException(BindException e) {
        log.error("BindException 参数验证失败 = {}", e.getMessage());
        return this.parseBindingResult(e.getBindingResult());
    }

    private RespResult<?> parseBindingResult(BindingResult result) {
        if (result.hasFieldErrors()) {
            FieldError fieldError = result.getFieldError();
            assert fieldError != null;
            String field = fieldError.getField();
            return RespResult.warning(fieldError.getDefaultMessage(), field);
        } else {
            // return RespResult.warning(this.messageSourceAccessor.getMessage("controller.parameter.MethodArgumentNotValid.empty"));
            return RespResult.warning("controller.parameter.MethodArgumentNotValid.empty");
        }
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({MethodArgumentTypeMismatchException.class})
    public RespResult<?> handleMethodArgumentTypeMismatchException(MethodArgumentTypeMismatchException ex) {
        log.error("MethodArgumentTypeMismatchException 参数类型出错，转换失败！\n方法：{}\n期望参数类型：{}\n参数：{}\n信息：{}",
                Objects.requireNonNull(ex.getParameter().getMethod()).getName(),
                ex.getParameter().getParameterType(), ex.getName(), ex.getMessage());
        // String type = Objects.requireNonNull(ex.getRequiredType()).getSimpleName();
        // Object value = ex.getValue();
        // return RespResult.error(this.messageSourceAccessor.getMessage("controller.parameter.ArgumentTypeMismatch", new Object[]{type, value}));
        return RespResult.error(ex.getMessage());
    }

    @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
    @ExceptionHandler({HttpRequestMethodNotSupportedException.class})
    public RespResult<?> handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) {
        log.error("不支持的请求方法 = {} ", e.getMethod());
        // return RespResult.error(this.messageSourceAccessor.getMessage("controller.MethodNotSupported", new Object[]{e.getMethod()}));
        return RespResult.error(e.getMessage());
    }

    @ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
    @ExceptionHandler({HttpMediaTypeNotSupportedException.class})
    public RespResult<?> handleHttpMediaTypeNotSupportedException(HttpMediaTypeNotSupportedException e) {
        log.error("不支持当前媒体类型 = {}", e.getContentType());
        // return RespResult.info(this.messageSourceAccessor.getMessage("controller.HttpMediaTypeNotSupported", new Object[]{e.getContentType()}));
        return RespResult.info(e.getMessage());
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({MultipartException.class})
    public RespResult<?> handleMultipartException(MultipartException e) {
        log.error("上传文件失败", e);
        String message = "upload.fail";
        if (e instanceof MaxUploadSizeExceededException) {
            message = "upload.fail.exceeded.max.size";
        }
        // return RespResult.warning(this.messageSourceAccessor.getMessage(message));
        return RespResult.warning(message);
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({LocalServiceException.class})
    public RespResult<?> handleServiceException(LocalServiceException e) {
        // return RespResult.info(this.messageSourceAccessor.getMessage(e.getMessage(), e.getParams()), "zh_CN");
        return RespResult.info(e.getMessage());
    }

    @ResponseStatus(HttpStatus.FORBIDDEN)
    @ExceptionHandler({RequestLimitException.class})
    public RespResult<?> handleRequestLimitException(RequestLimitException e) {
        String message = e.getMessage();
        if (message == null) {
            message = "request.limit";
        }
        // return RespResult.warning(this.messageSourceAccessor.getMessage(message));
        return RespResult.warning(message);
    }

    @ResponseStatus(HttpStatus.NOT_FOUND)
    @ExceptionHandler({NoHandlerFoundException.class})
    public RespResult<?> noHandlerFoundException(NoHandlerFoundException e) {
        log.error("Not Found = {}", e.getRequestURL());
        // return RespResult.info(this.messageSourceAccessor.getMessage("controller.404"));
        return RespResult.error(e.getMessage());
    }

    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler({Exception.class})
    public RespResult<?> handleException(Exception e) {
        log.error("通用异常 = e.class = {} message = {}", e.getClass(), e.getMessage(), e);
        // return RespResult.error(this.messageSourceAccessor.getMessage("controller.500"));
        return RespResult.error(e.getMessage());
    }

}