如何优雅的处理SpringBoot Web中的异常

如何优雅的处理SpringBoot Web中的异常

大家在开发Web项目中的时候总是会遇到一些让人很麻烦的参数校验和一些固定的返回格式，如果我们在每个方法中都加入这些代码就很麻烦，大大降低我们的开发效率。今天我们就看一下如何进行优雅的异常抛出，来做个记录吧。

首先定义一个异常的接口：

public interface BasicException {
    /**
     * 错误码
     * @return
     */
    String getResultCode();

    /**
     * 错误描述
     * @return
     */
    String getResultMsg();
}

然后我们定义一些常见的基础的枚举异常

public enum CommonEnum implements BasicException {
    /**
     * 基础的一些错误定义。
     */
    SUCCESS("200", "成功!"),
    BODY_NOT_MATCH("400", "请求的数据格式不符!"),
    SIGNATURE_NOT_MATCH("401", "请求的数字签名不匹配!"),
    NOT_FOUND("404", "未找到该资源!"),
    INTERNAL_SERVER_ERROR("500", "服务器内部错误!"),
    SERVER_BUSY("503", "服务器正忙，请稍后再试!");

    private String resultCode;
    private String resultMsg;

    CommonEnum(String resultCode, String resultMsg) {
        this.resultCode = resultCode;
        this.resultMsg = resultMsg;
    }

    @Override
    public String getResultCode() {
        return resultCode;
    }

    @Override
    public String getResultMsg() {
        return resultMsg;
    }
}

再来一个自定义异常的包装类。

public class CustomException extends RuntimeException implements BasicException {

    private String errorCode;
    private String errorMsg;

    public CustomException() {
        super();
    }

    public CustomException(BasicException exception) {
        super(exception.getResultCode());
        this.errorCode = exception.getResultCode();
        this.errorMsg = exception.getResultMsg();
    }

    public CustomException(String errorMsg) {
        this.errorMsg = errorMsg;
    }

    public CustomException(String errorCode, String errorMsg) {
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }

    public CustomException(String errorCode, String errorMsg, Throwable cause) {
        super(cause);
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }

    public String getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(String errorCode) {
        this.errorCode = errorCode;
    }

    public String getErrorMsg() {
        return errorMsg;
    }

    public void setErrorMsg(String errorMsg) {
        this.errorMsg = errorMsg;
    }

    @Override
    public String getResultCode() {
        return this.errorCode;
    }

    @Override
    public String getResultMsg() {
        return this.errorMsg;
    }
}

再进行一下异常的全局捕获抛出。

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
    /**
     * 捕捉自定义异常，减少代码量
     *
     * @param request
     * @param exception
     * @return
     */
    @ExceptionHandler(CustomException.class)
    public ResultBody handleCustomException(HttpServletRequest request, CustomException exception) {
        log.error("发生异常");
        return ResultBody.error(exception.getErrorCode(), exception.getMessage());
    }

    @ExceptionHandler(value = NullPointerException.class)
    public ResultBody exceptionHandler(HttpServletRequest req, NullPointerException e) {
        log.error("发生空指针异常！原因是:", e);
        return ResultBody.error(CommonEnum.BODY_NOT_MATCH);
    }

    @ExceptionHandler(ConstraintViolationException.class)
    public ResultBody constraintViolationExceptionHandle(HttpServletRequest req, ConstraintViolationException e) {
        String message = e.getMessage();
        String[] messages = message.split(": ");
        return ResultBody.error(messages[messages.length - 1]);
    }
}