Springboot之自定义全局异常处理的实现
前言:
在实际的应用开发中,很多时候往往因为一些不可控的因素导致程序出现一些错误,这个时候就要及时把异常信息反馈给客户端,便于客户端能够及时地进行处理,而针对代码导致的异常,我们一般有两种处理方式,一种是throws直接抛出,一种是使用try..catch捕获,一般的话,如果逻辑的异常,需要知道异常信息,我们往往选择将异常抛出,如果只是要保证程序在出错的情况下依然可以继续运行,则使用try..catch来捕获。
但是try..catch会导致代码量的增加,让后期我们的代码变得臃肿且难以维护。当然,springboot作为一个如此优秀的框架,肯定不会坐视不管的,通过springboot自带的注解,我们可以方便的自定义我们的全局异常处理器,并且以json格式返回给我们的客户端。
代码实战:
捕获全局异常:
首先呢,我们新建我们负责全局异常捕捉处理的类:MyControllerAdvice,代码如下:
@ControllerAdvice publicclassMyControllerAdvice{ @ResponseBody @ExceptionHandler(value=Exception.class) publicMapexceptionHandler(Exceptionex){ Map map=newHashMap (); map.put("code",100); map.put("msg",ex.getMessage()); //这里可以加上我们其他的异常处理代码,比如日志记录,,, returnmap; } }
注解说明:
@ControllerAdvice通过AOP的方式配合@ExceptionHandler()注解捕获在Controller层面发生的异常。如果需要扫描自定路径下的Controller,添加basePackages属性
@ControllerAdvice(basePackages="com.example.demo.controller")
@RestControllerAdvice:和@ControllerAdvice作用相同,可以理解为 @ResponseBody+@ControllerAdvice的组合使用。
@ExceptionHandler():该注解作用主要在于声明一个或多个类型的异常,当符合条件的Controller抛出这些异常之后将会对这些异常进行捕获,然后按照其标注的方法的逻辑进行处理,从而改变返回的视图信息。
测试:
@RestController publicclassUserController{ @GetMapping("/test") publicStringtest(){ intnum=1/0; return"HelloWorld"; } }
结果:
{"msg":"/byzero","code":100}
捕获自定义异常:
自定义我们的异常信息类MyException并继承RuntimeException:
publicclassMyExceptionextendsRuntimeException{ privateStringerrorCode; privateStringerrorMsg; publicMyException(StringerrorCode,StringerrorMsg){ this.errorCode=errorCode; this.errorMsg=errorMsg; } publicStringgetErrorCode(){ returnerrorCode; } publicvoidsetErrorCode(StringerrorCode){ this.errorCode=errorCode; } publicStringgetErrorMsg(){ returnerrorMsg; } publicvoidsetErrorMsg(StringerrorMsg){ this.errorMsg=errorMsg; } }
修改我们的MyControllerAdvice,将MyException添加进去:
@ResponseBody @ExceptionHandler(value=MyException.class) publicMapmyExceptionHandler(MyExceptionmex){ Map map=newHashMap (); map.put("code",mex.getErrorCode()); map.put("msg",mex.getErrorMsg()); //其他业务代码... returnmap; }
测试:
@GetMapping("/test1") publicStringtest1(){ Stringname=null; if(name==null){ thrownewMyException("101","用户名为空"); } return"HelloWorld"; }
输出:
{"msg":"用户名为空","code":"101"}
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。