Spring-Boot中的统一异常处理

spring-boot中可以通过使用ControllerAdvice或RestControllerAdvice注解结合ExceptionHandler注解实现统一异常处理,由于spring-boot启动时会自动扫描并注入,因此使用起来非常方便,下面介绍基本的实现方式

1. 新建统一异常处理类

其实统一异常处理本质上是采用ControllerAdvice注解定义一个切面,通过类似Controller的方式来返回异常结果。首先我们可以新建一个处理类CommonExceptionHandler。

CommonExceptionHandler.java

//在类上使用RestControllerAdvice注解,表示返回的是一个body,可以把这个类看作一个controller
//这里也可以使用ControllerAdvice注解,这时需要在下面的方法中添加ResponseBody的注解
@RestControllerAdvice
@Slf4j
public class CommonExceptionHandler {
}

2. 配置具体的异常处理方法

之后我们可以在这个类中使用ExceptionHandler注解配置异常处理,类似与controller中的action,当系统抛出特定异常时,这里的方法会按照配置执行。

CommonExceptionHandler.java

@RestControllerAdvice
@Slf4j
public class CommonExceptionHandler {

    //注解中的value可以指定捕获的异常类型,可以支持多个异常
    @ExceptionHandler(value = {AuthException.class, AuthenticationException.class})  //缺少权限
    public Result handle(AuthException e) {
        log.error(e.getMessage());//输出日志
        return ResultUtil.error(401, e.getMessage());//返回结果
    }
    
    @ExceptionHandler(value = Exception.class)  //内部错误
    public Result handle(Exception e) {
        log.error(e.getMessage());
        return ResultUtil.error(500, e.getMessage());
    }
}
}

这里我采用了自定义的返回类型Result,可以根据自己的需求修改。

3. controller抛出异常

由于ControllerAdvice是从controller层捕获到异常,因此需要确保controller能抛出异常,这样才能使得异常被正确处理。

TestController.java

@RequestMapping(value = "/test", method = RequestMethod.GET)
public String Test() throws Exception {//需要抛出异常
    logger.error("Test log");
    throw new Exception("Test log");
}

最后的输出结果:

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

推荐阅读更多精彩内容