SpringBoot:如何优雅地处理全局异常？

李昌杰发布于2019-08-19 10:25 / 366人阅读

摘要：为了贴合主题，本次主要针对全局异常处理进行举例说明。自定义异常处理自定义一个异常自定义异常程序员小明错误码错误信息显而易见，这个异常继承了，属于运行时异常。包括处理其他异常，都是这种方式。

之前用springboot的时候，只知道捕获异常使用try{}catch，一个接口一个try{}catch，这也是大多数开发人员异常处理的常用方式，虽然屡试不爽，但会造成一个问题，就是一个Controller下面，满屏幕的try{}catch，看着一点都不优雅，一点都不符合小明的气质，憋了这么久，小明今天终于决定对所有异常实施统一处理的方案。

开发准备

JDK8、正常的springboot项目

代码编写 通用异常处理

其实Spring系列的项目全局异常处理方式早已存在，只不过我们一直忙于搬砖，很少停下脚步去审视这个日夜与我们相伴的朋友。为了贴合主题，本次主要针对SpringBoot全局异常处理进行举例说明。

SpringBoot中有一个@ControllerAdvice的注解，使用该注解即表示开启全局异常捕获，接下来我们只需在自定义的方法上使用@ExceptionHandler注解，并定义捕获异常的类型，对这种类型的异常进行统一的处理。

举个例子:

假如我们需要针对NullException（空指针异常，是Java程序员最痛恨的异常，没有之一）进行全局处理（如下所示）。

@RestControllerAdvice
public class GlobalExceptionHandler {
        /**
     * 处理空指针的异常
     * @param req
     * @param e
     * @return
     */
    @ExceptionHandler(value =NullPointerException.class)
    public BaseResponseFacade exceptionHandler(HttpServletRequest req, NullPointerException e){
        log.error("发生空指针异常！原因是:",e);
        return ResponseUtil.error(ResponseCode.ERROR);
    }
}

讷，就这么简单。其他可能发生的异常，都可以以这种方式处理快速处理。此处大家应该表现的十分兴奋，但请不要高兴太早，因为接下来，有更令激动人心的事情。

自定义异常处理

自定义一个异常

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.experimental.Accessors;

/**
 * @Description 自定义异常
 * @Date 2019-08-05 15:49
 * @Created by 程序员小明
 */
@Data
@AllArgsConstructor
@Accessors(chain = true)
public class BizException extends RuntimeException {
    /**
     * 错误码
     */
    protected Integer errorCode;
    /**
     * 错误信息
     */
    protected String errorMsg;
}

显而易见，这个异常继承了RuntimeException，属于运行时异常。细心的朋友已经发现，我使用了Lombok插件，非常契合今天的主题，给大家简单介绍一下：

lombok是一个可以帮助我们简化java代码编写的工具类，尤其是简化javabean的编写，即通过采用注解的方式，消除代码中的构造方法，getter/setter等代码，使我们写的类更加简洁（如果使用的IDE是idea，需要安装插件哈）。

定义过之后，我们就可以和之前处理NullException方式一样处理我们自定义的异常。包括处理其他异常，都是这种方式。直接贴代码。

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 处理自定义的业务异常
     * @param req
     * @param e
     * @return
     */
    @ExceptionHandler(value = BizException.class)
    public BaseResponseFacade bizExceptionHandler(HttpServletRequest req, BizException e){
        log.error("发生业务异常！原因是：{}",e.getErrorMsg());
        return ResponseUtil.error(e.getErrorCode(),e.getErrorMsg());
    }

    /**
     * 处理空指针的异常
     * @param req
     * @param e
     * @return
     */
    @ExceptionHandler(value =NullPointerException.class)
    public BaseResponseFacade exceptionHandler(HttpServletRequest req, NullPointerException e){
        log.error("发生空指针异常！原因是:",e);
        return ResponseUtil.error(ResponseCode.ERROR);
    }


    /**
     * 处理其他异常
     * @param req
     * @param e
     * @return
     */
    @ExceptionHandler(value =Exception.class)
    public BaseResponseFacade exceptionHandler(HttpServletRequest req, Exception e){
        log.error("未知异常！原因是:",e);
        return ResponseUtil.error(ResponseCode.INTERNAL_SERVER_ERROR);
    }
}

整个全局异常处理方式核心就是以上介绍这些。下面用一个Demo给大家举个例子

@GetMapping("/test")
public BaseResponseFacade test(){
  if(true){
      throw new BizException(1,"error");
  }
  return ResponseUtil.success();
}

地址栏请求，进入这个方法后，会抛出异常，此时全局异常生效，就会返回异常处理过后的信息

{"errorCode":1,"errorMsg":"error","data":null}

到此整个流程都然跑通了。当然，好多地方都可以根据我们自身实际业务情况以此为基础进一步丰富，比如返回数据可以改成跳转某一个具体的页面。这样的出场方式是不是都很优雅？大家有什么问题，期待各位留言。

超融合服务器 idc机房托管 java优雅异常处理捕获全局异常 java捕获全局异常江苏医保云参保地服务器异常

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/76005.html

第二十九章：基于SpringBoot平台使用Lombok来优雅的编码

摘要：还提供了全部参数的构造函数的自动生成，该注解的作用域也是只有在实体类上，因为只有实体类才会存在构造函数。当然除了全部参数的构造函数，还提供了没有参数的构造函数，使用方式与一致。 Lombok对于Java偷懒开发者来说应该是比较中意的，恰恰笔者就是一个喜欢在小细节上偷懒来提高开发效率的人。所以在技术框架的海洋里寻找了很久才在GitHub开源平台上找到，而在这之前国外很多程序猿一直使用该框...

fanux 2019-08-15 11:59 评论0 收藏0
SpringBoot RESTful 应用中的异常处理小结

摘要：和的区别方法注解作用于级别注解为一个定义一个异常处理器类注解作用于整个工程注解定义了一个全局的异常处理器需要注意的是的优先级比高即抛出的异常如果既可以让标注的方法处理又可以让标注的类中的方法处理则优先让标注的方法处理处理中的异常为了方便地展 @ControllerAdvice 和 @ExceptionHandler 的区别 ExceptionHandler, 方法注解, 作用于 Co...

jackzou 2019-08-14 14:33 评论0 收藏0
如何优雅关闭 Spring Boot 应用

摘要：除了，还有十余种，有的是特定操作，比如转储内存日志有的是信息展示，比如显示应用健康状态。 showImg(http://ww1.sinaimg.cn/large/006tNc79gy1g5qb2coyfoj30u00k0tan.jpg); 前言随着线上应用逐步采用 SpringBoot 构建，SpringBoot应用实例越来多，当线上某个应用需要升级部署时，常常简单粗暴地使用 kil...

xiyang 2019-08-19 10:22 评论0 收藏0
Spring Boot 2.x 系列教程：WebFlux REST API 全局异常处理 Error

摘要：挺多人咨询的，异常处理用切面注解去实现去全局异常处理。全局异常处理类，代码如下代码解析如下抽象类是用来处理全局错误时进行扩展和实现注解标记的切面排序，值越小拥有越高的优先级，这里设置优先级偏高。本文内容为什么要全局异常处理？ WebFlux REST 全局异常处理实战小结摘录：只有不断培养好习惯，同时不断打破坏习惯，我们的行为举止才能够自始至终都是正确的。一、为什么要全局...

BicycleWarrior 2019-08-16 16:43 评论0 收藏0
利用函数式优雅的重构API

摘要：新建字典必要的验证参数不能为空调用封装数据到统一到结构体异常处理包括中抛出到自定义异常和未知异常统一包装到返回对象中这样子的代码在开发接口的时候比比皆是。基础知识在开始之前假设你从未了解过函数式编程，本文不会教你函数式里面的各种概念。而是用实际案例让给了解到函数式编程的魅力，并且能够在合适的场景中应用。 ## 重构之前基本代码如下很普通的 springboot http接口。...

bergwhite 2019-08-16 17:49 评论0 收藏0