springboot的异常处理、自定义异常处理

一、springboot的异常处理

首先,说一下,Springboot支持两种方式的默认处理机制:一种是客户端的(基于接口),一种是网页的。说白了就是根据请求的时候Accept的类型去进行异常的处理,在html中,Accept的类型是text/html,而基于接口去访问的话,Accept的类型是/
我们可以截图来看一下

网页中的请求

接口中的请求

然后,在这两种请求方式的基础上,我来随便写一个我后台中没有定义的一个接口(当然了,肯定会报404)


网页404

可以看到,在基于springboot的项目中,如果访问了一个未知的资源路径,系统会自动跳到一个Whitelabel Error Page的html页面中


接口请求的error

而在模拟客户端请求的时候,会返回一串json,里面展示了错误的一些状态等信息。那么,在springboot中是如何区分这两种请求方式的呢?

二、剖析源码

源码:BasicErrorController

@RequestMapping(
        produces = {"text/html"}
    )
    public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
        HttpStatus status = this.getStatus(request);
        Map<String, Object> model = Collections.unmodifiableMap(this.getErrorAttributes(request, this.isIncludeStackTrace(request, MediaType.TEXT_HTML)));
        response.setStatus(status.value());
        ModelAndView modelAndView = this.resolveErrorView(request, response, status, model);
        return modelAndView == null ? new ModelAndView("error", model) : modelAndView;
    }

    @RequestMapping
    @ResponseBody
    public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
        Map<String, Object> body = this.getErrorAttributes(request, this.isIncludeStackTrace(request, MediaType.ALL));
        HttpStatus status = this.getStatus(request);
        return new ResponseEntity(body, status);
    }

可以看到,在BasicErrorController中,有两个重载的方法,一个是返回一个modelAndView,一个是返回一个map,而这两个异常处理的区别就是,在返回modelAndView的那个方法上边,匹配了produces ="text/html",但是在返回map的方法中则没有进行详细的指定,由此我们可以大致了解boot的默认异常处理机制


springboot异常处理源码

三、自定义异常

1.出现问题自动跳转到固定页面

我先来演示一遍效果,同样,我访问一个我系统后台没有定义的一个接口(404错误),然后通过浏览器访问


404错误页面

可以看到,访问一个不存在的接口资源,页面跳转到了一个我自己定义的一个页面

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>404</title>
</head>
<body>
404您所访问的页面不存在。。。
</body>
</html>

那么这个是怎么出现的呢?
我们知道在boot的项目结构中,在src->main->resources目录下是配置我们的配置文件的,在此目录下我们再新建一个文件夹resources,然后在新的文件夹下面再新建一个文件夹,命名为error,(注意目录结构),然后我们就可以在error目录下新建html,想让什么错误走什么样的html就去写,就比如我之前已经预测出我访问接口会报404,那么我就可以创建404.html,以此类推还可以新建500之类的错误

错误处理

2.客户端模拟访问异常处理

那么在客户端模拟访问接口的时候,并不是返回页面,boot默认返回的是一个map,而且可读性很差,那么我们怎么办呢?请看下面

四、自定义异常

1、新建自定义异常

我们在实际开发过程中,为了提高系统代码的质量,我们会新建很多自定义异常,比如我创建一个自定义异常UserNotExitException,然后为了方便阅读,我会定义一个接口,去传递一个id,出现异常的时候将id传给这个异常,我们来看代码
自定义异常代码:

package com.tinner.exception;

import com.sun.javafx.iio.ios.IosDescriptor;

public class UserNotExitException extends RuntimeException {
    public UserNotExitException( Integer id){
        super("user not exit");
        this.id = id;
    }
    private Integer id;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }
}

接口代码:

    @GetMapping("/getUser/{id:\\d+}")
    public User getUser(@PathVariable Integer id){
        throw new UserNotExitException(id);
    }

为了方便我直接抛出了这个异常,而且我在抛出这个异常的时候将父类的构造方法重写,返回一个user not exit的消息,我们来看接口访问:

自定义异常

我们可以看到返回的message改变了,但是这个json的可读性还是有些差,下面我将会介绍一个自己定义的返回对象

2、自定义接口返回对象

我来新建一个ControllerExceptionHandler这个类,这个类中必须加入注解@ControllerAdvice,我定义一个handleUserNotExitException方法,返回一个map,传参必须传递UserNotExitException这个异常(也就是说,你想处理什么异常,就必须将这个异常传递到这个方法中),在这个异常中我提前定义了一个成员变量id,我想将这个id返回给客户端,同时告诉它一些详细信息,那么我们可以在map中put相关信息,代码如下:


@ControllerAdvice
public class ControllerExceptionHandler {

    @ExceptionHandler(UserNotExitException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public Map<String,Object> handleUserNotExitException(UserNotExitException ex){
        Map<String,Object> map  = new HashedMap();
        map.put("id",ex.getId());
        map.put("message",ex.getMessage());
        return map;
    }
}

我们可以看到在这个方法上边我写了三个注解,第一个注解是告诉框架这个方法是用来处理什么异常的;第二个注解是为了接口返回的;第三个注解是告诉框架在服务器发生什么错误的时候来走这个方法(HttpStatus.INTERNAL_SERVER_ERROR是服务器错误的时候500)
然后我们重新访问一遍这个接口


处理自定义异常返回
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,367评论 6 512
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,959评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,750评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,226评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,252评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,975评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,592评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,497评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,027评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,147评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,274评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,953评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,623评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,143评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,260评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,607评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,271评论 2 358

推荐阅读更多精彩内容

  • Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架,建立于...
    Hsinwong阅读 22,423评论 1 92
  • 五百余年前,阳明先生被贬修文龙场驿当了一个小小的不入流的驿丞。某曰遇一小官携一子一仆赴滇就任,路过此地时三人不幸得...
    自由自游阅读 1,054评论 0 2
  • 今年的三月份我如约到了乡下的姑妈家替她采琼花酿造琼花酒。 我姑妈今年已经九十多岁了,而她每年的三月份都会酿一坛琼花...
    写书林自道阅读 861评论 0 0
  • 我知道自己对金钱是没有什么欲望的,可雁行老师做采访的那天,我突然有个重大的发现:我不想要那么多钱!!! 我对这个发...
    在上海慢走阅读 508评论 3 0