SpringBoot 全局异常配置_springboot 全局异常的配置-程序员宅基地

技术标签: spring boot  异常  Exception  

文章目录


##前言
在日常web开发中发生了异常,往往是需要通过一个统一的异常处理来保证客户端能够收到友好的提示。
接下来我们介绍一下SpringBoot2.X 的异常处理机制

##1、 默认异常机制
默认异常处理(SpringBoot 默认提供了两种机制,一种是针对于web浏览器访问的错误页面响应,另一种则是针对于 接口测试工具等 的参数响应处理):
> 浏览器访问:
我们随意写一个不存在的请求 如:http://localhost:8080/abc
这里写图片描述
> postman 接口测试:
http://localhost:8080/abc
这里写图片描述

原理:SpringBoot默认提供了程序出错的结果映射路径/error。这个/error请求会在BasicErrorController中处理,其内部是通过判断请求头中的Accept的内容是否为text/html来区分请求是来自客户端浏览器(浏览器通常默认自动发送请求头内容Accept:text/html)还是客户端接口的调用,以此来决定返回页面视图还是 JSON 消息内容。

错误路径映射:

这里写图片描述

数据响应 BasicErrorController的相关代码:
这里写图片描述

##2、自定义json格式异常响应
通过 @ControllerAdvice/@RestControllerAdvice@ExceptionHandler 注解全局异常自定义响应类

首先提供官网的 示例代码

这里写图片描述

接下来我们自定义我们自己的异常处理类
1> 首先定义响应状态码枚举类

 package com.fxbin123.dto;

/**

  • @author: fxbin

  • @datetime: 2018/7/5 18:36

  • @description:
    */
    public enum ResultCode {
    SUCCESS(200),//成功
    FAIL(400),//失败
    UNAUTHORIZED(401),//未认证(签名错误)
    NOT_FOUND(404),//接口不存在
    INTERNAL_SERVER_ERROR(500);//服务器内部错误

    private final int code;

    ResultCode(int code) {
    this.code = code;
    }

    public int code() {
    return code;
    }
    }

2> 定义 响应类

package com.fxbin123.dto;

import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

/**

  • @author: fxbin

  • @datetime: 2018/7/5 18:34

  • @description:
    */
    public class Result {

    /**

    • 状态响应码
      */
      private int code;

    /**

    • 响应结果 成功/失败
      */
      private boolean success;

    /**

    • 响应信息
      */
      private String message;

    /**

    • 响应数据
      */
      @JsonInclude(JsonInclude.Include.NON_NULL)
      private Object data;

    public Result setCode(ResultCode resultCode) {
    this.code = resultCode.code();
    return this;
    }

    public int getCode() {
    return code;
    }

    public boolean isSuccess() {
    return success;
    }

    public Result setSuccess(boolean success) {
    this.success = success;
    return this;
    }

    public String getMessage() {
    return message;
    }

    public Result setMessage(String message) {
    this.message = message;
    return this;
    }

    public Object getData() {
    return data;
    }

    public Result setData(Object data) {
    this.data = data;
    return this;
    }
    }

3> 对响应结果封装,做预处理

package com.fxbin123.dto;

/**

  • @author: fxbin

  • @datetime: 2018/7/5 18:36

  • @description:
    */
    public class ResultGenerator {

    private static final String DEFAULT_SUCCESS_MESSAGE = “SUCCESS”;

    public static Result genSuccessResult() {
    return new Result()
    .setCode(ResultCode.SUCCESS)
    .setSuccess(true)
    .setMessage(DEFAULT_SUCCESS_MESSAGE);
    }

    public static Result genSuccessResult(Object data) {
    return new Result()
    .setCode(ResultCode.SUCCESS)
    .setSuccess(true)
    .setMessage(DEFAULT_SUCCESS_MESSAGE)
    .setData(data);
    }

    public static Result genFailResult(String message) {
    return new Result()
    .setCode(ResultCode.FAIL)
    .setSuccess(false)
    .setMessage(message);
    }
    }

4> 异常处理类

package com.fxbin123.advice;

import com.fxbin123.dto.Result;
import com.fxbin123.dto.ResultGenerator;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.servlet.http.HttpServletRequest;

/**

  • @author: fxbin

  • @datetime: 2018/7/5 18:29

  • @description:
    */
    @RestControllerAdvice
    public class ExceptionControllerAdvice {

    @ExceptionHandler(Exception.class)
    public Result jsonErrorHandler(HttpServletRequest req, Exception e){
    return ResultGenerator.genFailResult(e.getMessage());
    }
    }

5> 接下来写一个测试类,对我们的全局异常配置进行测试

    @GetMapping(value="/abc")
    public Object testException(){
        int i = 5/0;
        return i;
    }

 
 
  

6> 测试结果
这里写图片描述

##3、自定义异常处理页面
1> 添加*thymeleaf*依赖

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-thymeleaf</artifactId>
      </dependency>

 
 
  
  • 1
  • 2
  • 3
  • 4

2> resource目录下新建templates,并新建error.html

  <!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org" xmlns:layout="http://www.w3.org/1999/xhtml" layout:decorator="layout">
<head>
    <title>Spring Boot 自定义异常页面</title>
    <script type="text/javascript">
    </script>
</head>
<body>
<div layout:fragment="content" th:remove="tag">
    <div  id="navbar">
        <h1>系统异常统一处理</h1>
        <h3 th:text="'错误信息:'+${msg}"></h3>
        <h3 th:text="'请求地址:'+${url}"></h3>
    &lt;h2&gt;Debug&lt;/h2&gt;
    &lt;a th:href="@{'https://www.google.com/webhp?hl=zh-CN#safe=strict&amp;hl=zh-CN&amp;q='+${msg}}"
       class="btn btn-primary btn-lg" target="_blank" id="Google"&gt;Google&lt;/a&gt;
    &lt;a th:href="@{'https://www.baidu.com/s?wd='+${msg}}" class="btn btn-info btn-lg"  target="_blank" id="Baidu"&gt;Baidu&lt;/a&gt;
    &lt;a th:href="@{'http://stackoverflow.com/search?q='+${msg}}"
       class="btn btn-default btn-lg"  target="_blank" id="StackOverFlow"&gt;StackOverFlow&lt;/a&gt;
    &lt;h2&gt;异常堆栈跟踪日志StackTrace&lt;/h2&gt;
    &lt;div th:each="line:${stackTrace}"&gt;
        &lt;div th:text="${line}"&gt;&lt;/div&gt;
    &lt;/div&gt;
&lt;/div&gt;

</div>
<div layout:fragment=“js” th:remove=“tag”>
</div>
</body>
</html>

3> 做错误页面异常处理 返回 ModelAndView

    @ExceptionHandler(Exception.class)
    public Object handleException(Exception e){
            ModelAndView modelAndView = new ModelAndView();
            modelAndView.addObject("msg", e.getMessage());
            modelAndView.addObject("url", req.getRequestURL());
            modelAndView.addObject("stackTrace", e.getStackTrace());
            modelAndView.setViewName("error");
            return modelAndView;
    }

 
 
  

4> 测试 结果如下
这里写图片描述

代码地址

																		 ---end---

 
 
  
  • 1
        </div>
					<link href="https://csdnimg.cn/release/phoenix/mdeditor/markdown_views-258a4616f7.css" rel="stylesheet">
            </div>
版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/zhangjunli/article/details/88863901

智能推荐

没有U盘Win10电脑下如何使用本地硬盘安装Ubuntu20.04(单双硬盘都行)_没有u盘怎么装ubuntu-程序员宅基地

文章浏览阅读3.6k次,点赞2次,收藏2次。DELL7080台式机两块硬盘。_没有u盘怎么装ubuntu

【POJ 3401】Asteroids-程序员宅基地

文章浏览阅读32次。题面Bessie wants to navigate her spaceship through a dangerous asteroid field in the shape of an N x N grid (1 <= N <= 500). The grid contains K asteroids (1 <= K <= 10,000), which are conv...

工业机器视觉系统的构成与开发过程(理论篇—1)_工业机器视觉系统的构成与开发过程(理论篇—1-程序员宅基地

文章浏览阅读2.6w次,点赞21次,收藏112次。机器视觉则主要是指工业领域视觉的应用研究,例如自主机器人的视觉,用于检测和测量的视觉系统等。它通过在工业领域将图像感知、图像处理、控制理论与软件、硬件紧密结合,并研究解决图像处理和计算机视觉理论在实际应用过程中的问题,以实现高效的运动控制或各种实时操作。_工业机器视觉系统的构成与开发过程(理论篇—1

plt.legend的用法-程序员宅基地

文章浏览阅读5.9w次,点赞32次,收藏58次。legend 传奇、图例。plt.legend()的作用:在plt.plot() 定义后plt.legend() 会显示该 label 的内容,否则会报error: No handles with labels found to put in legend.plt.plot(result_price, color = 'red', label = 'Training Loss') legend作用位置:下图红圈处。..._plt.legend

深入理解 C# .NET Core 中 async await 异步编程思想_netcore async await-程序员宅基地

文章浏览阅读2.2k次,点赞3次,收藏11次。深入理解 C# .NET Core 中 async await 异步编程思想引言一、什么是异步?1.1 简单实例(WatchTV并行CookCoffee)二、深入理解(异步)2.1 当我需要异步返回值时,怎么处理?2.2 充分利用异步并行的高效性async await的秘密引言很久没来CSDN了,快小半年了一直在闲置,也写不出一些带有思想和深度的文章;之前就写过一篇关于async await 的异步理解 ,现在回顾,真的不要太浅和太陋,让人不忍直视!好了,废话不再啰嗦,直入主题:一、什么是异步?_netcore async await

IntelliJ IDEA设置类注释和方法注释带作者和日期_idea作者和日期等注释-程序员宅基地

文章浏览阅读6.5w次,点赞166次,收藏309次。当我看到别人的类上面的多行注释是是这样的:这样的:这样的:好装X啊!我也想要!怎么办呢?往下瞅:跟着我左手右手一个慢动作~~~File--->Settings---->Editor---->File and Code Templates --->Includes--->File Header:之后点applay--..._idea作者和日期等注释

随便推点

发行版Linux和麒麟操作系统下netperf 网络性能测试-程序员宅基地

文章浏览阅读175次。Netperf是一种网络性能的测量工具,主要针对基于TCP或UDP的传输。Netperf根据应用的不同,可以进行不同模式的网络性能测试,即批量数据传输(bulk data transfer)模式和请求/应答(request/reponse)模式。工作原理Netperf工具以client/server方式工作。server端是netserver,用来侦听来自client端的连接,c..._netperf 麒麟

万字长文详解 Go 程序是怎样跑起来的?| CSDN 博文精选-程序员宅基地

文章浏览阅读1.1k次,点赞2次,收藏3次。作者| qcrao责编 | 屠敏出品 | 程序员宅基地刚开始写这篇文章的时候,目标非常大,想要探索 Go 程序的一生:编码、编译、汇编、链接、运行、退出。它的每一步具体如何进行,力图弄清 Go 程序的这一生。在这个过程中,我又复习了一遍《程序员的自我修养》。这是一本讲编译、链接的书,非常详细,值得一看!数年前,我第一次看到这本书的书名,就非常喜欢。因为它模仿了周星驰喜剧..._go run 每次都要编译吗

C++之istringstream、ostringstream、stringstream 类详解_c++ istringstream a >> string-程序员宅基地

文章浏览阅读1.4k次,点赞4次,收藏2次。0、C++的输入输出分为三种:(1)基于控制台的I/O (2)基于文件的I/O (3)基于字符串的I/O 1、头文件[cpp] view plaincopyprint?#include 2、作用istringstream类用于执行C++风格的字符串流的输入操作。 ostringstream类用_c++ istringstream a >> string

MySQL 的 binglog、redolog、undolog-程序员宅基地

文章浏览阅读2k次,点赞3次,收藏14次。我们在每个修改的地方都记录一条对应的 redo 日志显然是不现实的,因此实现方式是用时间换空间,我们在数据库崩了之后用日志还原数据时,在执行这条日志之前,数据库应该是一个一致性状态,我们用对应的参数,执行固定的步骤,修改对应的数据。1,MySQL 就是通过 undolog 回滚日志来保证事务原子性的,在异常发生时,对已经执行的操作进行回滚,回滚日志会先于数据持久化到磁盘上(因为它记录的数据比较少,所以持久化的速度快),当用户再次启动数据库的时候,数据库能够通过查询回滚日志来回滚将之前未完成的事务。_binglog

我的第一个Chrome小插件-基于vue开发的flexbox布局CSS拷贝工具_chrome css布局插件-程序员宅基地

文章浏览阅读3k次。概述之前介绍过 移动Web开发基础-flex弹性布局(兼容写法) 里面有提到过想做一个Chrome插件,来生成flexbox布局的css代码直接拷贝出来用。最近把这个想法实现了,给大家分享下。play-flexbox插件介绍play-flexbox一秒搞定flexbox布局,可直接预览效果,拷贝CSS代码快速用于页面重构。 你也可以通过点击以下链接(codepen示例)查_chrome css布局插件

win10下安装TensorFlow-gpu的流程(包括cuda、cuDnn下载以及安装问题)-程序员宅基地

文章浏览阅读308次。我自己的配置是GeForce GTX 1660 +CUDA10.0+CUDNN7.6.0 + TensorFlow-GPU 1.14.0Win10系统安装tensorflow-gpu(按照步骤一次成功)https://blog.csdn.net/zqxdsy/article/details/103152190环境配置——win10下TensorFlow-GPU安装(GTX1660 SUPER+CUDA10+CUDNN7.4)https://blog.csdn.net/jiDxiaohuo/arti