springboot 全局异常处理和统一响应对象的处理方式

更新时间：2022年06月28日 14:35:09 作者：猪仔读我名字

这篇文章主要介绍了springboot 全局异常处理和统一响应对象,主要包括SpringBoot 默认的异常处理机制和SpringBoot 全局异常处理，本文给大家介绍的非常详细，需要的朋友可以参考下

springboot异常处理

SpringBoot 默认的异常处理机制

默认情况，SpringBoot 提供两种不同响应方式

一种是浏览器客户端请求一个不存在的页面或服务端异常时，SpringBoot默认会响应一个html
另一种是使用postman等调试工具请求不存在的url或服务端异常时，默认返回json信息

SpringBoot 全局异常处理

一般我们不会将错误信息返回前端，自己去try catch捕获异常,但有个问题：每个方法都这样捕获异常，肯定是不合适，这是我们就需要全局的异常处理了。

@RestController
public class ExceptionController {
    @GetMapping("exceptionA")
    public void methodA() {
        try {
            int a = 100 / 0;
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

1. 局部异常处理

使用@EceptionHandle注解实现某个类的局部异常处理

   @RestController
   public class ExceptionController {
   
       @GetMapping("exceptionA")
       public void methodA() {
           int a = 100 / 0;
       }
   
       /**
        * 局部异常处理
        */
       @ExceptionHandler(Exception.class)
       public String exHandler(Exception e) {
           // 判断发生异常的类型是除0异常则做出响应
           if (e instanceof ArithmeticException) {
               return "发生了除0异常";
           }
           // 未知的异常做出响应
           return "发生了未知异常";
       }
   }

2. 全局异常处理

使用@ControllerAdvice +@ExceptionHandler注解实现全局异常处理

自定义一个异常类

@RestControllerAdvice
public class DefaultException {

    @ExceptionHandler({NullPointerException.class})
    public String exception(NullPointerException exception) {
        return "空指针异常";

    }

    @ExceptionHandler({IndexOutOfBoundsException.class})
    public String exception(IndexOutOfBoundsException exception) {
        return "数组越界异常";
    }
}

增加一个异常方法测试，由于局部异常优先级更高先注释掉了

@RestController
public class ExceptionController {

    @GetMapping("exceptionA")
    public void methodA() {
        int a = 100 / 0;
    }

    @GetMapping("exceptionB")
    public void methodB() {
        List list = new ArrayList<>();
        System.out.println(list.get(0));
    }

    /**
     * 局部异常处理
     */
    //@ExceptionHandler(Exception.class)
    //public String exHandler(Exception e) {
    //    // 判断发生异常的类型是除0异常则做出响应
    //    if (e instanceof ArithmeticException) {
    //        return "发生了除0异常";
    //    }
    //    // 未知的异常做出响应
    //    return "发生了未知异常";
    //}
}

全局异常注解已生效

自定义异常

自定义异常只需要继承exception类或其子类

@Data
@NoArgsConstructor
public class CustomException extends Exception {

    private static final long serialVersionUID = 1L;

    private Integer code;

    private String mes;

    /**
     * @param code 状态码
     * @param msg  异常返回信息
     * @description 构造器
     */
    public CustomException(Integer code, String msg) {
        super(msg);
        this.code = code;
    }
}

使用时可以直接抛出异常对象

@GetMapping("exceptionC")
public void methodC() throws CustomException {
    int a = 1;
    if (a == 1) {
        throw new CustomException(10086, "自定义异常");
    }
}

统一响应对象

实际开发中我们需要封装统一的响应对象，区分状态码和信息，以便前端处理。

定义统一的响应对象

一般包含状态码，错误信息，数据等。

自定义一些方法用来返回信息，比如我定义的success(),failed()方法

@Data
@NoArgsConstructor
@AllArgsConstructor
public class R<T> {
    /**
     * 返回状态码
     */
    private Integer code;
    /**
     * 返回信息
     */
    private String msg;
    /**
     * 数据
     */
    private T data;

    public static R success() {
        return new R(ResultCode.SUCCESS.getCode(), ResultCode.SUCCESS.getMsg(), null);
    }

    public static R success(Object data) {
        return new R(ResultCode.SUCCESS.getCode(), ResultCode.SUCCESS.getMsg(), data);
    }

    public static R failed() {
        return new R(ResultCode.FAILED.getCode(), ResultCode.FAILED.getMsg(), null);
    }

    public static R failed(String msg) {
        return new R(ResultCode.FAILED.getCode(), msg, null);
    }

    public static R failed(int code, String msg) {
        return new R(code, msg, null);
    }
}

枚举信息

枚举一些常用的状态信息

我就举个例子，只枚举2个，根据需要去自定义

@NoArgsConstructor
@AllArgsConstructor
public enum ResultCode {

    SUCCESS(200, "请求成功"),
    FAILED(500, "服务器错误");

    private int code;
    private String msg;

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}

响应对象

使用时直接返回定义的对象类型就行了，将定义的全局异常返回类型也改成统一的响应对象

@RestControllerAdvice
public class DefaultException {
    @ExceptionHandler({CustomException.class})
    public R exception(CustomException e) {
        return R.failed(e.getCode(),e.getMessage());
    }

    @ExceptionHandler({Exception.class})
    public R exception(Exception e) {
        return R.failed(e.getMessage());
    }
}

全局异常和响应对象的简单介绍就这样了，欢迎补充指正。

gitee地址：gitee.com/rainscloud/…

到此这篇关于springboot 全局异常处理和统一响应对象的文章就介绍到这了,更多相关springboot全局异常处理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java进程cpu占用过高问题解决
这篇文章主要介绍了Java进程cpu占用过高问题解决,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-04-04
mybatis中使用InsertProvider注解报错解决全过程
这篇文章主要介绍了mybatis中使用InsertProvider注解报错解决全过程，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-07-07
java高并发InterruptedException异常引发思考
这篇文章主要为大家介绍了java高并发InterruptedException异常引发思考，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-08-08
详解通过maven运行项目的两种方式
这篇文章主要介绍了通过maven运行项目的两种方式,给大家提到了通过tomcat的方式来启动maven项目的方法，通过图文并茂的形式给大家介绍的非常详细，需要的朋友可以参考下
2021-12-12
详解SpringMVC中的@RequestMapping注解
这篇文章主要介绍了SpringMVC中@RequestMapping注解,@RequestMapping注解是一个用来处理请求地址映射的注解，可用于映射一个请求或一个方法，可以用在类或方法上,需要的朋友可以参考下
2023-07-07
SpringBoot 2 统一异常处理过程解析
这篇文章主要介绍了SpringBoot 2 统一异常处理过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-09-09
maven如何使用profiles多环境配置
在软件开发过程中,我们经常需要在不同的环境中部署和运行我们的应用程序,例如开发环境、测试环境和生产环境,为了方便管理和配置不同环境下的参数,我们可以使用Maven的profiles功能,本文给大家介绍maven如何使用profiles多环境配置,感兴趣的的朋友一起看看吧
2024-02-02
Elasticsearch 自动重启脚本创建实现
这篇文章主要为大家介绍了Elasticsearch 自动重启脚本创建实现详解分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-08-08
JDK源码之PriorityQueue解析
这篇文章主要为大家详细介绍了JDK源码之PriorityQueue，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-04-04
Java实现JDBC批量插入原理详解
在JDBC中，executeBatch这个方法可以将多条dml语句批量执行，效率比单条执行executeUpdate高很多，这是什么原理呢？在mysql和oracle中又是如何实现批量执行的呢？本文将给大家介绍这背后的原理
2023-03-03