统一异常处理相关注解介绍
@ControllerAdvice
声明在类上用于指定该类为控制增强器类，如果想声明返回的结果为 RESTFull 风格的数据，需要在声明 @ExceptionHandler 注解的方法上同时加 上 @ResponseBody
@RestControllerAdvice
声明在类上用于指定该类为控制增强器类。并声明返回的结果为 RESTFull 风格的数据，无需在声明@ExceptionHandler 注解的方法上加@ResponseBody
@ExceptionHandler
声明在方法上用于指定需要统一拦截的异常。例如：@ExceptionHandler(value = Exception.class)
实战操作
定义消息类：
定义 RESTFull 返回 JSON 数据的消息类，其中包含成员变量如下：
code：错误码，0表示没有异常信息。 message：异常提示信息。 date：无异常是返回具体内容信息。
public class ReturnMessage<T> { private Integer code;//错误码 private String message;//提示信息 private T date;//返回具体内容 public ReturnMessage(Integer code, String message, T date) { super(); this.code = code; this.message = message; this.date = date; } //省略get and set方法 }
** 消息类处理工具类：**
主要是用来处理成功或失败消息处理，该工具类主要包含是3个方法 ：
- 成功处理含实体数据 成功处理 没有实体数据 失败处理
具体代码如下：
public class ReturnMessageUtil { /** * 无异常 请求成功并有具体内容返回 * @param object * @return */ public static ReturnMessage<Object> sucess(Object object) { ReturnMessage<Object> message = new ReturnMessage<Object>(0,"sucess",object); return message; } /** * 无异常 请求成功并无具体内容返回 * @return */ public static ReturnMessage<Object> sucess() { ReturnMessage<Object> message = new ReturnMessage<Object>(0,"sucess",null); return message; } /** * 有自定义错误异常信息 * @param code * @param msg * @return */ public static ReturnMessage<Object> error(Integer code,String msg) { ReturnMessage<Object> message = new ReturnMessage<Object>(code,msg,null); return message; } }
自定义异常类：
我们通过自定义系统异常类来完成校验相关的操作，自定义系统异常类通过继承 RuntimeException ，然后声明名称为 code 的成员变量来表示不同类型异常。
主要是用于异常拦截后获取自定义异常的 code ，并将code 设置到消息类中。
public class SbException extends RuntimeException{ private Integer code; public Integer getCode() { return code; } public void setCode(Integer code) { this.code = code; } public SbException(Integer code,String message) { super(message); this.code = code; } }
定义统一异常拦截类：
通过声明 @RestControllerAdvice 表示该类为 RESTFul 风格的异常处理控制增强器类，在 handle 方法声明 @ExceptionHandler 并在该注解中指定要拦截的异常类。具体代码如下：
@RestControllerAdvicepublic class ExceptionHandle { private final static Logger logger = LoggerFactory.getLogger(ExceptionHandle.class); @ExceptionHandler(value = Exception.class) public ReturnMessage<Object> handle(Exception exception) { if(exception instanceof SbException) { SbException sbexception = (SbException)exception; return ReturnMessageUtil.error(sbexception.getCode(), sbexception.getMessage()); }else { logger.error("系统异常 {}",exception); return ReturnMessageUtil.error(-1, "未知异常"+exception.getMessage()); } }}
测试
分别测试自定义异常和系统异常，通过 /error/custome 测试自定义异常，通过 /error/unknown 测试未知的系统异常。具体代码如下：
@RestController@RequestMapping("/error")public class DemoException { @GetMapping(value = "custome") public void customException() { SbException sbe = new SbException(100, "这个是自定义异常！"); throw sbe; } @GetMapping(value = "unknown") public void unknownException() { int i = 0; int b = 1/i; }}
测试结果：
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。
本文标题: SpringBoot 2 统一异常处理过程解析
以上就上有关SpringBoot2统一异常处理过程解析的全部内容，学步园全面介绍编程技术、操作系统、数据库、web前端技术等内容。