备案控制台
探索云世界
开发者社区 开发与运维 文章 正文

SpringBoot异常统一处理，包括系统异常、自定义异常和参数检验异常

2023-04-24 340
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： SpringBoot异常统一处理，包括系统异常、自定义异常和参数检验异常

SpringBoot异常统一处理


本文基于SpringBoot使用@RestControllerAdvice无侵入返回统一结果包装ResultJson.java对象在上文中已经创建，这里不再赘述。

上面我们我们介绍了统一返回格式，如果程序抛异常了，我们是否也可以返回统一的格式呢？

答案是，当然可以的，不光可以抛出我们想要的格式，还可以对指定的异常类型进行特殊处理

例如使用@Validated对入参校验的异常，我们自定义的异常等等


未处理的返回情况


首先我们模拟一个异常的场景，代码如下：

package com.maple.controller;
import lombok.Data;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @author 笑小枫
 * @date 2021/12/7
 */
@RestController
@RequiredArgsConstructor
@RequestMapping("/example")
public class TestErrorResultController {
    @GetMapping("/testResultError")
    public Test testResultError() {
        Test test = null;
        test.setName("简单点，抛个空指针吧");
        return test;
    }
    @Data
    static class Test {
        private String name;
        private Integer age;
        private String remark;
    }
}

我们先看看这是调用返回的结果，可以看到，由于我们对结果进行了统一封装，将错误信息放到了data里面。 但显然，status显示true，后台都空指针了，这显然不是我们想要的结果。

{
  "status": true,
  "code": "0000",
  "msg": "",
  "data": {
    "timestamp": "2021-12-22T06:24:19.332+00:00",
    "status": 500,
    "error": "Internal Server Error",
    "message": "",
    "path": "/testResultError"
  }
}


贴一下控制台错误信息

笑小枫控制台- 2021-12-22 14:25:38 [http-nio-6666-exec-1] ERROR org.apache.catalina.core.ContainerBase.[Tomcat].[localhost].[/].[dispatcherServlet] - Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is java.lang.NullPointerException] with root cause
java.lang.NullPointerException: null
  at com.maple.controller.TestResultController.testResultError(TestResultController.java:19)
  at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
  at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
  at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
  at java.lang.reflect.Method.invoke(Method.java:498)
    ...


统一异常处理配置


接下来我们开始表演，创建一个配置类，配置一下对异常拦截处理，代码如下：

package com.maple.config;
import com.maple.config.exception.ErrorCode;
import com.maple.model.ResultJson;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
/**
 * 异常信息统一处理
 *
 * @author 笑小枫
 * @date 2021/12/20
 */
@Slf4j
@RestControllerAdvice
public class ExceptionAdvice {
    /**
     * 系统异常.
     *
     * @param e 异常信息
     * @return R
     */
    @ExceptionHandler(Exception.class)
    public ResultJson exception(Exception e) {
        log.error("系统异常信息 ex={}", e.getMessage(), e);
        // 未知异常统一抛出9999
        return new ResultJson(ErrorCode.OTHER_ERROR.getCode(), ErrorCode.OTHER_ERROR.getMsg());
    }
}

这里使用了一个异常编码的枚举类ErrorCode.java，代码如下：

package com.maple.config.exception;
import lombok.AllArgsConstructor;
import lombok.Getter;
/**
 * 统一异常信息枚举类
 *
 * @author 笑小枫
 * @date 2021/12/9
 */
@AllArgsConstructor
@Getter
public enum ErrorCode {
    /**
     * 异常信息
     */
    PARAM_ERROR("9001", "请求参数有误，请重试"),
    /**
     * 抛出此异常码，请重新在ErrorMsg定义msg
     */
    COMMON_ERROR("9998", "笑小枫太懒，居然没有定义异常原因"),
    OTHER_ERROR("9999", "未知异常，请联系笑小枫");
    private final String code;
    private final String msg;
}


我们再看一下这个时候返回的结果，显然，这个结果我们就可以接受了。程序中尽量避免出现空指针哈，这里只是模拟>_<…

{
  "status": false,
  "code": "9999",
  "msg": "未知异常，请联系笑小枫",
  "data": null
}


自定义异常的处理


刚刚对统一异常做了处理，那像我们自定义的异常怎么处理呢


首先我们创建一个自定义异常，这里建议先创建一个BaseException的自定义异常，然后不同的小类的异常再继承BaseException异常。 这样我们可以直接拦截BaseException异常就可以了。

BaseException异常这里取名为MapleBaseException.java，代码如下：

package com.maple.config.exception;
import lombok.Data;
import lombok.EqualsAndHashCode;
/**
 * 自定义异常-Base父类，细化的自定义异常，应该继承此类
 * 统一异常处理时，会根据此异常类型做判断，返回结果时，如果是自定义异常自动解析code和errorMsg返回
 *
 * @author 笑小枫
 * @date 2021/12/8
 */
@EqualsAndHashCode(callSuper = true)
@Data
public class MapleBaseException extends RuntimeException {
    private final String code;
    private final String errorMsg;
    public MapleBaseException(String code, String errorMsg) {
        super(errorMsg);
        this.code = code;
        this.errorMsg = errorMsg;
    }
    public MapleBaseException(ErrorCode code) {
        super(code.getMsg());
        this.code = code.getCode();
        this.errorMsg = code.getMsg();
    }
    public MapleBaseException(ErrorCode code, String errorMsg) {
        super(errorMsg);
        this.code = code.getCode();
        this.errorMsg = errorMsg;
    }
}

然后再定义一个校验的自定义异常，代码如下：

package com.maple.config.exception;
/**
 * 检测结果不一致时，抛出此异常
 *
 * @author 笑小枫
 * @date 2021/12/8
 */
public class MapleCheckException extends MapleBaseException {
    public MapleCheckException(String code, String errorMsg) {
        super(code, errorMsg);
    }
    public MapleCheckException(ErrorCode code) {
        super(code);
    }
    public MapleCheckException(ErrorCode code, String errorMsg) {
        super(code, errorMsg);
    }
}

调整一下我们的异常拦截配置类，代码如下：

注意Exception异常拦截上面的@Order(99)，因为我们自定义异常也属于Exception异常，所以使用Order执行时往后排。

package com.maple.config;
import com.maple.config.exception.ErrorCode;
import com.maple.config.exception.MapleBaseException;
import com.maple.model.ResultJson;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.annotation.Order;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
/**
 * 异常信息统一处理
 *
 * @author 笑小枫
 * @date 2021/12/20
 */
@Slf4j
@RestControllerAdvice
public class ExceptionAdvice {
    /**
     * 自定义异常处理
     *
     * @param e 异常信息
     * @return 返回结果
     */
    @ExceptionHandler(MapleBaseException.class)
    public ResultJson mapleBaseException(MapleBaseException e) {
        log.error("自定义异常信息 ex={}", e.getMessage(), e);
        return new ResultJson(e.getCode(), e.getErrorMsg());
    }
    /**
     * 系统异常.
     *
     * @param e 异常信息
     * @return R
     */
    @ExceptionHandler(Exception.class)
    @Order(99)
    public ResultJson exception(Exception e) {
        log.error("系统异常信息 ex={}", e.getMessage(), e);
        // 未知异常统一抛出9999
        return new ResultJson(ErrorCode.OTHER_ERROR.getCode(), ErrorCode.OTHER_ERROR.getMsg());
    }
}

我们再模拟一下抛出自定义异常，代码如下：

package com.maple.controller;
import com.maple.config.exception.ErrorCode;
import com.maple.config.exception.MapleCheckException;
import lombok.Data;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @author 笑小枫
 * @date 2021/12/7
 */
@RestController
@RequiredArgsConstructor
@RequestMapping("/example")
public class TestResultController {
    @GetMapping("/testMapleError")
    public Test testMapleError() {
        Test test = new Test();
        test.setName("笑小枫");
        if (test.getAge() == null) {
            throw new MapleCheckException(ErrorCode.COMMON_ERROR);
        }
        return test;
    }
    @Data
    static class Test {
        private String name;
        private Integer age;
        private String remark;
    }
}


最后，我们来看一下结果


{
  "status": false,
  "code": "9998",
  "msg": "笑小枫太懒，居然没有定义异常原因",
  "data": null
}


贴一下控制台异常信息

笑小枫控制台- 2021-12-22 14:38:26 [http-nio-6666-exec-2] ERROR com.maple.config.ExceptionAdvice - 自定义异常信息 ex=笑小枫太懒，居然没有定义异常原因
com.maple.config.exception.MapleCheckException: 笑小枫太懒，居然没有定义异常原因
  at com.maple.controller.TestResultController.testResultError(TestResultController.java:23)
  at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
  at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
  at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
  at java.lang.reflect.Method.invoke(Method.java:498)
  ...


@Validated对入参校验的异常处理


上面的说的@Validated对入参校验的异常处理，这里简单贴一下代码，不做详细概述。系统抛出异常格式太丑，这里做了简单优化.

package com.maple.config;
import com.maple.config.exception.ErrorCode;
import com.maple.config.exception.MapleBaseException;
import com.maple.model.ResultJson;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.annotation.Order;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.List;
/**
 * 异常信息统一处理
 *
 * @author 笑小枫
 * @date 2021/12/20
 */
@Slf4j
@RestControllerAdvice
public class ExceptionAdvice {
    /**
     * 自定义异常处理
     *
     * @param e 异常信息
     * @return 返回结果
     */
    @ExceptionHandler(MapleBaseException.class)
    public ResultJson mapleBaseException(MapleBaseException e) {
        log.error("自定义异常信息 ex={}", e.getMessage(), e);
        return new ResultJson(e.getCode(), e.getErrorMsg());
    }
    /**
     * 参数校验异常处理
     *
     * @param e 异常信息
     * @return 返回结果
     */
    @ExceptionHandler(value = {BindException.class, MethodArgumentNotValidException.class})
    public ResultJson validException(MethodArgumentNotValidException e) {
        log.error("参数校验异常信息 ex={}", e.getMessage(), e);
        BindingResult result = e.getBindingResult();
        StringBuilder stringBuilder = new StringBuilder();
        if (result.hasErrors()) {
            List<ObjectError> errors = result.getAllErrors();
            errors.forEach(p -> {
                FieldError fieldError = (FieldError) p;
                stringBuilder.append(fieldError.getDefaultMessage());
            });
        }
        return new ResultJson(ErrorCode.PARAM_ERROR.getCode(), stringBuilder.toString());
    }
    /**
     * 系统异常.
     *
     * @param e 异常信息
     * @return R
     */
    @ExceptionHandler(Exception.class)
    @Order(99)
    public ResultJson exception(Exception e) {
        log.error("系统异常信息 ex={}", e.getMessage(), e);
        // 未知异常统一抛出9999
        return new ResultJson(ErrorCode.OTHER_ERROR.getCode(), ErrorCode.OTHER_ERROR.getMsg());
    }
}


关于笑小枫


本章到这里结束了，喜欢的朋友关注一下我呦，大伙的支持，就是我坚持写下去的动力。

老规矩，懂了就点赞收藏；不懂就问，日常在线，我会就会回复哈~

后续文章会陆续更新，文档会同步在CSDN和GitHub保持同步更新。

CSDN：https://zhangfz.blog.csdn.net

GitHub文档：https://github.com/hack-feng/Java-Notes

文章标签：
Java
关键词：
Spring Boot参数
Spring Boot系统
Spring Boot检验
Spring Boot自定义参数
Spring Boot自定义异常
笑小枫
目录
相关文章
程序三两行
|
19天前
|
Java 数据库连接 Spring
Spring Boot命令行启动添加参数
Spring Boot命令行启动添加参数
程序三两行
21 0
喜欢猪猪
|
1月前
|
XML Java 数据库连接
spring boot 参数的过滤注解与实战
在Spring Boot应用中，对于入参的过滤，通常会涉及到对Web层的数据验证和处理。Spring Boot借助Spring框架提供了强大的验证框架支持，主要基于JSR-303/JSR-380（Bean Validation API）规范，以及Spring自身的@Valid或@Validated注解来实现请求参数的验证。以下是一些常见的使用案例来展示如何对参数进行过滤和验证。
喜欢猪猪
29 1
小z1
|
1月前
|
缓存 前端开发 Java
【二十八】springboot之通过threadLocal+参数解析器实现同session一样保存当前登录信息的功能
【二十八】springboot之通过threadLocal+参数解析器实现同session一样保存当前登录信息的功能
小z1
34 1
牵着猫散步的鼠鼠
|
3天前
|
缓存 Java Sentinel
Springboot 中使用 Redisson+AOP+自定义注解 实现访问限流与黑名单拦截
Springboot 中使用 Redisson+AOP+自定义注解 实现访问限流与黑名单拦截
牵着猫散步的鼠鼠
10 1
浩泽学编程
|
1月前
|
Java 数据库 数据安全/隐私保护
【SpringBoot】Validator组件+自定义约束注解实现手机号码校验和密码格式限制
【SpringBoot】Validator组件+自定义约束注解实现手机号码校验和密码格式限制
浩泽学编程
112 1
zhishijike
|
1月前
|
小程序 Java
基于springboot的医护人员排班系统
基于springboot的医护人员排班系统
zhishijike
29 0
东北赵四
|
6天前
|
前端开发 Java
SpringBoot之实体参数的详细解析
SpringBoot之实体参数的详细解析
东北赵四
10 0
蓝易云
|
8天前
|
JSON Java 数据格式
Spring Boot实现各种参数校验
这些是Spring Boot中实现参数校验的一些常见方法，你可以根据项目需求选择适合的方式来进行参数校验。
蓝易云
12 0
小蜗牛耶
|
8天前
|
小程序 JavaScript Java
基于SpringBoot+Vue+uniapp微信小程序的医院核酸检测服务系统的详细设计和实现
基于SpringBoot+Vue+uniapp微信小程序的医院核酸检测服务系统的详细设计和实现
小蜗牛耶
34 0
源码星辰
|
9天前
|
人工智能 移动开发 前端开发
Springboot医院智慧导诊系统源码：精准推荐科室
医院智慧导诊系统是在医疗中使用的引导患者自助就诊挂号，在就诊的过程中有许多患者不知道需要挂什么号，要看什么病，通过智慧导诊系统，可输入自身疾病的症状表现，或选择身体部位，在经由智慧导诊系统多维度计算，精准推荐科室，引导患者挂号就诊，实现科学就诊，不用担心挂错号。
源码星辰
18 2

热门文章

最新文章

  • 1
    SpringBoot集成Redis
  • 2
    SpringBoot-Run启动流程
  • 3
    SpringBoot 企业级简化开发（一）
  • 4
    基于 java + Springboot + vue +mysql 大学生实习管理系统（含源码）
  • 5
    SpringBoot项目调用HTTP接口5种方式你了解多少？
  • 6
    SpringBoot3集成Swagger出现错误Error starting ApplicationContext. To display the condition evaluation repor
  • 7
    SpringBoot集成Redis解决表单重复提交接口幂等（亲测可用）
  • 8
    Springboot+Spring security +jwt认证+动态授权
  • 9
    【mybatis】第一篇，Springboot中使用插件PageHelper不生效解决方案
  • 10
    SpringBoot实现多线程定时任务动态定时任务配置文件配置定时任务
  • 1
    SpringBoot启动后出现Please sign in页面
    45
  • 2
    Spring Boot的定时任务与异步任务
    53
  • 3
    SpringBoot整合Mybatis连接Oracle数据库
    65
  • 4
    通用Shell脚本执行Spring Boot项目Jar包
    29
  • 5
    【SpringBoot系列】SpringBoot集成Fast Mybatis
    173
  • 6
    Spring Boot集成Redis启动失败【Caused by: java.lang.ClassNotFoundException: org.apache.commons.pool2.impl.G】
    66
  • 7
    Spring Boot 整合xxl-job实现分布式定时任务
    73
  • 8
    【二十二】springboot整合拦截器实战并对比过滤器
    33
  • 9
    【二十一】springboot整合过滤器实战
    15
  • 10
    【二十】springboot整合ElasticSearch实战（万字篇）
    216

    • 相关课程

    更多
  • 微服务+全栈在线教育实战项目演练（SpringCloud Alibaba+SpringBoot）
  • SpringBoot实战教程
  • SpringBoot快速掌握 - 核心技术
  • SpringBoot快速掌握 - 高级应用
  • Springboot项目云开发快速迁移

    • 相关电子书

    更多
  • 面向失败设计
  • 低代码开发师（初级）实战教程
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    部署LAMP环境（Alibaba Cloud Linux 3）