如何实现全局异常处理
从 Spring 3.0 - Spring 3.2 版本之间,对 Spring 架构和 SpringMVC 的Controller 的异常捕获提供了相应的异常处理。
•@ExceptionHandler
•Spring3.0提供的标识在方法上或类上的注解,用来表明方法的处理异常类型。
•@ControllerAdvice
•Spring3.2提供的新注解,从名字上可以看出大体意思是控制器增强, 在项目中来增强SpringMVC中的Controller。通常和@ExceptionHandler 结合使用,来处理SpringMVC的异常信息。
•@ResponseStatus
•Spring3.0提供的标识在方法上或类上的注解,用状态代码和应返回的原因标记方法或异常类。
调用处理程序方法时,状态代码将应用于HTTP响应。
具体实现:
- 首先在java代码中定义一个自定义异常
public class XuechengException extends RuntimeException {private String errMessage;public XuechengException() {super();}public XuechengException(String errMessage) {super(errMessage);this.errMessage = errMessage;}public String getErrMessage() {return errMessage;}public static void cast(String errMessage){throw new XuechengException(errMessage);}public static void cast(CommonError commonError){throw new XuechengException(commonError.getErrMessage());}
}
第二、创建一个枚举类来管理异常信息
public enum CommonError {UNKOWN_ERROR("执行过程异常,请重试。"),PARAMS_ERROR("非法参数"),OBJECT_NULL("对象为空"),QUERY_NULL("查询结果为空"),REQUEST_NULL("请求参数为空");private final String errMessage;public String getErrMessage() {return errMessage;}private CommonError( String errMessage) {this.errMessage = errMessage;}}
第三、 创建一个返回对象,用于将错误信息返回给前端
public class RestErrorResponse implements Serializable {private String errMessage;public RestErrorResponse(String errMessage){this.errMessage= errMessage;}public String getErrMessage() {return errMessage;}public void setErrMessage(String errMessage) {this.errMessage = errMessage;}
}
第四、创建全局异常处理器,处理抛出的异常
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {//处理抛出的自定义异常@ResponseBody@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)@ExceptionHandler(XuechengException.class)public RestErrorResponse customException(XuechengException e){log.error("【系统异常】{}",e.getErrMessage(),e);return new RestErrorResponse(e.getErrMessage());}//处理其他异常@ResponseBody@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)@ExceptionHandler(Exception.class)public RestErrorResponse exception(Exception e){log.error("【系统异常】{}",e.getMessage(),e);return new RestErrorResponse(CommonError.UNKOWN_ERROR.getErrMessage());}//处理JSR303异常@ResponseBody@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)@ExceptionHandler(MethodArgumentNotValidException.class)public RestErrorResponse methodArgumentNotValidException(MethodArgumentNotValidException e){//处理异常BindingResult bindingResult = e.getBindingResult();//定义集合存储错误信息List<String> error =new ArrayList<>();bindingResult.getFieldErrors().stream().forEach(item ->{error.add(item.getDefaultMessage());});//拼接错误信息String join = StringUtils.join(error, ",");return new RestErrorResponse(join);}
}
测试:
//合法性校验
if (StringUtils.isEmpty(dto.getName())) {
XuechengException.cast(“课程名称为空”);
}