Springboot之自定义全局异常处理的实现

更新时间：2019年08月28日 14:07:42 作者：韩数

这篇文章主要介绍了Springboot之自定义全局异常处理的实现,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

前言：

在实际的应用开发中，很多时候往往因为一些不可控的因素导致程序出现一些错误，这个时候就要及时把异常信息反馈给客户端，便于客户端能够及时地进行处理，而针对代码导致的异常，我们一般有两种处理方式，一种是throws直接抛出，一种是使用try..catch捕获，一般的话，如果逻辑的异常，需要知道异常信息，我们往往选择将异常抛出，如果只是要保证程序在出错的情况下依然可以继续运行，则使用try..catch来捕获。

但是try..catch会导致代码量的增加,让后期我们的代码变得臃肿且难以维护。当然，springboot作为一个如此优秀的框架，肯定不会坐视不管的，通过springboot自带的注解，我们可以方便的自定义我们的全局异常处理器，并且以json格式返回给我们的客户端。

代码实战：

捕获全局异常：

首先呢，我们新建我们负责全局异常捕捉处理的类:MyControllerAdvice，代码如下:

@ControllerAdvice
public class MyControllerAdvice {


  @ResponseBody
  @ExceptionHandler(value = Exception.class)
  public Map<String,Object> exceptionHandler(Exception ex){
    Map<String,Object> map = new HashMap<String,Object>();
    map.put("code",100);
    map.put("msg",ex.getMessage());
    //这里可以加上我们其他的异常处理代码，比如日志记录，，，
    return map;
  }

}

注解说明：
@ControllerAdvice 通过AOP的方式配合@ExceptionHandler()注解捕获在Controller层面发生的异常。如果需要扫描自定路径下的Controller，添加basePackages属性

@ControllerAdvice(basePackages ="com.example.demo.controller")

@RestControllerAdvice : 和@ControllerAdvice作用相同，可以理解为 @ResponseBody+@ControllerAdvice 的组合使用。

@ExceptionHandler()：该注解作用主要在于声明一个或多个类型的异常，当符合条件的Controller抛出这些异常之后将会对这些异常进行捕获，然后按照其标注的方法的逻辑进行处理，从而改变返回的视图信息。

测试：

@RestController
public class UserController {


  @GetMapping("/test")
  public String test(){
    int num = 1/0;
    return "Hello World";
  }
}

结果：

{"msg":"/ by zero","code":100}

捕获自定义异常：

自定义我们的异常信息类MyException 并继承RuntimeException：

public class MyException extends RuntimeException {

  private String errorCode;
  private String errorMsg;

  public MyException(String errorCode, String errorMsg) {
    this.errorCode = errorCode;
    this.errorMsg = errorMsg;
  }


  public String getErrorCode() {
    return errorCode;
  }

  public void setErrorCode(String errorCode) {
    this.errorCode = errorCode;
  }

  public String getErrorMsg() {
    return errorMsg;
  }

  public void setErrorMsg(String errorMsg) {
    this.errorMsg = errorMsg;
  }
  
}

修改我们的MyControllerAdvice，将MyException添加进去：

  @ResponseBody
  @ExceptionHandler(value = MyException.class)
  public Map<String,Object> myExceptionHandler(MyException mex){
    Map<String,Object> map = new HashMap<String,Object>();
    map.put("code",mex.getErrorCode());
    map.put("msg",mex.getErrorMsg());
    //其他业务代码...
    return map;
  }

测试：

  @GetMapping("/test1")
  public String test1(){
    String name = null;
    if(name == null){
      throw new MyException("101","用户名为空");
    }
    return "Hello World";
  }

输出：

{"msg":"用户名为空","code":"101"}

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

您可能感兴趣的文章:

使用IDEA打jar包的详细图文教程
JAR文件是一种压缩文件,与常见的ZIP压缩文件兼容,被称为JAR包,下面这篇文章主要给大家介绍了关于使用IDEA打jar包的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
2022-08-08
Netty启动流程注册多路复用源码解析
这篇文章主要介绍了Netty启动流程注册多路复用源码分析，继续分析channel是如何注册到selector中的，有需要的朋友可以借鉴参考下，希望能够有所帮助
2022-03-03
使用dom4j解析xml文件问题
这篇文章主要介绍了使用dom4j解析xml文件问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-09-09
Spring学习之Bean的装配多种方法
本篇文章主要介绍了Spring学习之Bean的装配三种方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-07-07
SpringBoot实现国密SM4加密解密的使用示例
在商用密码体系中,SM4主要用于数据加密,本文就来介绍一下SpringBoot实现国密SM4加密解密的使用示例,具有一定的参考价值,感兴趣的可以了解一下
2023-10-10
java文件复制代码片断(java实现文件拷贝)
本文介绍java实现文件拷贝的代码片断，大家可以直接放到程序里运行
2014-01-01
Spring中Bean的生命周期使用解析
这篇文章主要介绍了Spring中Bean的生命周期使用解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-09-09
浅谈Java基于Consul创建分布式锁
这篇文章主要介绍了浅谈基于Consul创建分布式锁,Consul是HashiCorp公司推出的开源工具，用于实现分布式系统的服务发现与配置Consul是分布式的、高可用的、可横向扩展的,需要的朋友可以参考下
2023-07-07
SpringCloud网关Gateway架构解析
这篇文章主要介绍了SpringCloud网关Gateway架构解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-03-03
java实现简单猜数字游戏
这篇文章主要介绍了java实现简单猜数字游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-12-12