springboot 统一异常处理(包含统一数据校验)

1、统一异常处理的优势

在开发中,我们是否遇到过如下两种奇葩现象:

(1)只要没有成功,不管什么原因,前端界面给出提示:服务端错误/异常。哪怕是数据校验不过,也这样提示(嗯,反正先把锅甩出去再说,具体什么原因我才不在乎呢,老子就是这么聪明);

如果想学习Java工程化、高性能及分布式、深入浅出。微服务、Spring,MyBatis,Netty源码分析的朋友可以加我的Java高级交流:787707172,群里有阿里大牛直播讲解技术,以及Java大型互联网技术的视频免费分享给大家。

(2)前端不做任何提示,一切提示信息都来自后端,成功的时候自然没什么,失败的时候,比如将Exception的描述信息(e.getMessage)返回。

现象(1)没什么好说的,直接拖出去枪毙吧;现象(2)先把产品经理宰了再说吧,看起来好像很专业的样子,出了什么问题直接看response返回的结果就知道个大概,研发测试都很方便,只是,大家想过没有,研发测试运维的问题,凭什么要用户买单,你见过淘宝京东有时候出了问题给你类似于“out of memory”的异常提示吗?

那么异常统一处理有什么好处呢?

提高用户体验;

业务逻辑和异常处理逻辑解耦;

对异常进行分类统一处理,减少冗余代码;

便于代码风格统一,并且更优雅(比如参数校验的时候,得写很多if else,并且不同的人写法不一致);

2、统一异常处理的实现

2.1 springboot的默认异常处理

Spring Boot提供了一个默认的映射:/error,当处理中抛出异常之后,会转到该请求中处理,并且该请求有一个全局的错误页面用来展示异常内容。

比如:

@RestController

public class Test {

@RequestMapping(value = {"/test"},method = RequestMethod.GET)

public String test(@RequestParam("id")Integer id){

return "id:"+id;

}

}

运行后访问结果如下:

这种直接返回错误页面,对于用户而言,显然是太不友好了哈!

2.2 统一异常处理

java异常详解

首先,定义自己的异常类,随便起个名字哈,MyException.java

@Data

public class MyException extends Exception{

private Integer code;

private String Message;

public MyException(Integer code,String Message) {

this.code = code;

this.Message = Message;

}

}

然后定义自己的异常处理类,ExceptionHandle.java

如果想学习Java工程化、高性能及分布式、深入浅出。微服务、Spring,MyBatis,Netty源码分析的朋友可以加我的Java高级交流:787707172,群里有阿里大牛直播讲解技术,以及Java大型互联网技术的视频免费分享给大家。

如果返回的对象是JSON的话,可以用@RestControllerAdvice

@ControllerAdvice

public class ExceptionHandle {

private final static Logger logger = LoggerFactory.getLogger(ExceptionHandle.class);

@ExceptionHandler(value = Exception.class)

@ResponseBody

public Result handle(Exception e) {

if (e instanceof MyException) {

MyException myException = (MyException) e;

return ResultUtil.error(boyException.getCode(), boyException.getMessage());

}else {

logger.error("【系统异常】{}", e);

return new Result(-1, "未知错误");

}

}

}

3、统一异常处理源码解析

3.1 注解源码解析

java注解详解

@ControllerAdvice

@ExceptionHandler

@RestControllerAdvice与@ExceptionHandler注解是sprngmvc中与异常捕获与处理相关的注解,它的入口也是DispatcherServlet中的doDispatcher()方法中,如下:

this.processDispatchResult(processedRequest,

response, mappedHandler, mv, (Exception)dispatchException);

后面会进入HandlerExceptionResolverComposite的resolveException方法,这个ExceptionHandlerResolverComposite包含三个ExcpetionHandlerResolver,是在springmvc中生成的,在springboot中其生成代码如下:

@Bean

public HandlerExceptionResolver handlerExceptionResolver() {

List exceptionResolvers = new ArrayList<>();

configureHandlerExceptionResolvers(exceptionResolvers);

if (exceptionResolvers.isEmpty()) {

addDefaultHandlerExceptionResolvers(exceptionResolvers);

}

extendHandlerExceptionResolvers(exceptionResolvers);

HandlerExceptionResolverComposite composite = new HandlerExceptionResolverComposite();

composite.setOrder(0);

composite.setExceptionResolvers(exceptionResolvers);

return composite;

}

后面他会进入ExceptionHandlerExceptionResolver类的方法:

protected ModelAndView doResolveHandlerMethodException(HttpServletRequest request,

HttpServletResponse response, @Nullable HandlerMethod handlerMethod,

Exception exception) {

ServletInvocableHandlerMethod exceptionHandlerMethod =

getExceptionHandlerMethod(handlerMethod, exception);

}

在这个方法中的第一行,getExceptionHandlerMethod方法,其进行了查找对应的带有@ControllerAdvice注解的类型和对应匹配的方法,然后在doResolverHandlerMethod方法中进行了处理,这就是整个流程。

@ControllerAdvice的加载过程:

首先在springboot扫描的时候,会把@ControllerAdvice的bean放入到beanFactory里面去,此时只要从beanFactory中获取到需要的bean即可,处理方式在ExceptionHandlerExceptionResolver类中:

@Override

public void afterPropertiesSet() {

// Do this first, it may add ResponseBodyAdvice beans

initExceptionHandlerAdviceCache();

private void initExceptionHandlerAdviceCache() {

if (getApplicationContext() == null) {

return;

}

if (logger.isDebugEnabled()) {

logger.debug("Looking for exception mappings: " + getApplicationContext());

}

List adviceBeans = ControllerAdviceBean.findAnnotatedBeans(getApplicationContext());

封装好后,获取带有@Exceptionhandler的注解方法,即根据异常类型进行调用了。

欢迎工作一到八年的Java工程师朋友们加入Java高级交流:787707172

本群提供免费的学习指导 架构资料 以及免费的解答

不懂得问题都可以在本群提出来 之后还会有直播平台和讲师直接交流噢

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

推荐阅读更多精彩内容