欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

SpringBoot 2 统一异常处理过程解析

程序员文章站 2022-10-25 17:59:10
统一异常处理相关注解介绍 @controlleradvice 声明在类上用于指定该类为控制增强器类,如果想声明返回的结果为 restfull 风格的数据,需要在声明...

统一异常处理相关注解介绍

@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个方法 :

  1. 成功处理含实体数据
  2. 成功处理 没有实体数据
  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 并在该注解中指定要拦截的异常类。具体代码如下:

@restcontrolleradvice
public 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 统一异常处理过程解析

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。