统一异常处理

统一异常处理

前言

在实际开发中，我们会有许多异常的处理方式都是一样的，比如权限验证、登录失败、未查询到订单等等。我们遵循no-repeat原则。可以将许多共同场景定义为一个统一的异常进行处理。

定义一个异常

/**
 * @author LiHaiNan
 * @version V1.0
 * @Description: 参数校验异常统一处理类
 * @date 上午 11:14 2017/12/12 0012
 */
public class ParameterVerificationException extends RuntimeException {
    public ParameterVerificationException() {
        super();
    }

    //重写构造函数将异常信息传入
    public ParameterVerificationException(String message) {
        super(message);
    }
}

定义一个异常处理类

import org.apache.commons.lang3.StringUtils;
import org.hshk.enums.v1.ResultEnum;
import org.hshk.exception.ParameterVerificationException;
import org.hshk.vo.v1.ResultVO;
import org.hshk.vo.v1.ResultVOUtil;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @author LiHaiNan
 * @version V1.0
 * @Description: 验证异常handle处理类
 * @date 上午 11:19 2017/12/12 0012
 */
@ControllerAdvice
//@ResControllerAdvice
public class ParameterVerificationExceptionHandle {
    @ExceptionHandler(value = ParameterVerificationException.class)
    @ResponseBody
    public ResultVO handle(ParameterVerificationException e) {
        if (StringUtils.isEmpty(e.getMessage())) {
            return ResultVOUtil.error(ResultEnum.PARAMETER_VERIFICATION_ERROR.getCode(), ResultEnum.PARAMETER_VERIFICATION_ERROR.getMessage());
        }
        return ResultVOUtil.error(ResultEnum.PARAMETER_VERIFICATION_ERROR.getCode(), e.getMessage());
    }

    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public ResultVO defaultGlobalErrorHandler(HttpServletRequest httpServletRequest, Exception e) {
        log.error("全局异常捕获url={}", httpServletRequest.getRequestURL());
        log.error(e.getMessage(), e);
        return ResultUtilsVO.error(e.getMessage());
    }
}

使用

    @RequestMapping(value = "/test")
    public ResultVO test(
            @RequestBody @Valid User user,
            BindingResult bindingResult
    ) {
        if (bindingResult.hasErrors()) {
            throw new ParameterVerificationException(bindingResult.getFieldError().getDefaultMessage());
        }
        return userService.roomOn(user);
    }