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


Posted in Java/Android onJune 28, 2022

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全局异常处理内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!


Tags in this post...

Java/Android 相关文章推荐
浅析NIO系列之TCP
Jun 15 Java/Android
ConstraintValidator类如何实现自定义注解校验前端传参
Jun 18 Java/Android
实体类或对象序列化时,忽略为空属性的操作
Jun 30 Java/Android
简述Java中throw-throws异常抛出
Aug 07 Java/Android
MyBatis-Plus 批量插入数据的操作方法
Sep 25 Java/Android
MyBatis自定义SQL拦截器示例详解
Oct 24 Java/Android
利用Sharding-Jdbc进行分库分表的操作代码
Jan 22 Java/Android
Android Flutter实现图片滑动切换效果
Apr 07 Java/Android
Mybatis-Plus 使用 @TableField 自动填充日期
Apr 26 Java/Android
mybatis-plus模糊查询指定字段
Apr 28 Java/Android
SpringBoot详解自定义Stater的应用
Jul 15 Java/Android
HttpClient实现表单提交上传文件
Aug 14 Java/Android
详解Spring Security如何在权限中使用通配符
Jun 28 #Java/Android
Android RecyclerView实现九宫格效果
Jun 28 #Java/Android
Java 多线程并发FutureTask
Java+swing实现抖音上的表白程序详解
Jun 25 #Java/Android
Java Spring Boot请求方式与请求映射过程分析
Jun 25 #Java/Android
Spring Cloud OAuth2实现自定义token返回格式
Jun 25 #Java/Android
Spring Cloud OpenFeign模版化客户端
Jun 25 #Java/Android
You might like
php 结果集的分页实现代码
2009/03/10 PHP
用mysql触发器自动更新memcache的实现代码
2009/10/11 PHP
基于PHP静态类的原罪详解
2013/05/06 PHP
PHP中mysqli_affected_rows作用行数返回值分析
2014/12/26 PHP
PHP使用递归方式列出当前目录下所有文件的方法
2015/06/02 PHP
使用php从身份证号中获取一系列线索(星座、生肖、生日等)
2016/05/11 PHP
PHP页面间传递值和保持值的方法
2016/08/24 PHP
封装好的省市地区联动控件附下载
2007/08/13 Javascript
FLASH 广告之外的链接
2008/12/16 Javascript
jquery select(列表)的操作(取值/赋值)
2011/03/16 Javascript
JavaScript在IE和FF下的兼容性问题
2014/05/19 Javascript
JavaScript拆分字符串时产生空字符的解决方案
2014/09/26 Javascript
jquery验证邮箱格式并显示提交按钮
2015/11/07 Javascript
jQuery删除节点用法示例(remove方法)
2016/09/08 Javascript
JS调用打印机功能简单示例
2016/11/28 Javascript
nodejs+mongodb+vue前后台配置ueditor的示例代码
2018/01/02 NodeJs
2019 年编写现代 JavaScript 代码的5个小技巧(小结)
2019/01/15 Javascript
浅谈Vue项目骨架屏注入实践
2019/08/05 Javascript
js实现上传图片并显示图片名称
2019/12/18 Javascript
探究数组排序提升Python程序的循环的运行效率的原因
2015/04/01 Python
详细解析Python中的变量的数据类型
2015/05/13 Python
python爬虫基础教程:requests库(二)代码实例
2019/04/09 Python
Python closure闭包解释及其注意点详解
2019/08/28 Python
简单了解python协程的相关知识
2019/08/31 Python
关于Python中定制类的比较运算实例
2019/12/19 Python
美国羊皮公司:Overland
2018/01/15 全球购物
能否解释一下XSS cookie盗窃是什么意思
2012/06/02 面试题
若干个Java基础面试题
2015/05/19 面试题
校园自助餐厅的创业计划书
2013/12/26 职场文书
24岁生日感言
2014/01/13 职场文书
中学生英语演讲稿
2014/04/26 职场文书
应届大专生自荐书
2014/06/16 职场文书
银行转正自我鉴定
2014/09/29 职场文书
学习三严三实心得体会
2014/10/13 职场文书
python本地文件服务器实例教程
2021/05/02 Python
你知道Java Spring的两种事务吗
2022/03/16 Java/Android