SpringBoot处理全局统一异常的实现
在后端发生异常或者是请求出错时，前端通常显示如下
WhitelabelErrorPage
Thisapplicationhasnoexplicitmappingfor/error,soyouareseeingthisasafallback.FriJun0715:38:07CST2019
Therewasanunexpectederror(type=NotFound,status=404).
Nomessageavailable
对于用户来说非常不友好。
本文主要讲解如何在SpringBoot应用中使用统一异常处理。
实现方式
- 第一种：使用@ControllerAdvice和@ExceptionHandler注解
- 第二种:使用ErrorController类来实现。
第一种：使用@ControllerAdvice和@ExceptionHandler注解
@Slf4j
@ControllerAdvice
publicclassGlobalExceptionHandler{
@ResponseBody
@ExceptionHandler(NullPointerException.class)
publicBaseResultglobalException(HttpServletResponseresponse,NullPointerExceptionex){
log.info("GlobalExceptionHandler...");
log.info("错误代码："+response.getStatus());
BaseResultresult=newWebResult(WebResult.RESULT_FAIL,"requesterror:"+response.getStatus()
,"GlobalExceptionHandler:"+ex.getMessage());
returnresult;
}
}
注解@ControllerAdvice表示这是一个控制器增强类，当控制器发生异常且符合类中定义的拦截异常类，将会被拦截。
可以定义拦截的控制器所在的包路径
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public@interfaceControllerAdvice{
@AliasFor("basePackages")
String[]value()default{};
@AliasFor("value")
String[]basePackages()default{};
Class[]basePackageClasses()default{};
Class[]assignableTypes()default{};
Class[]annotations()default{};
}
注解ExceptionHandler定义拦截的异常类
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public@interfaceExceptionHandler{
Class[]value()default{};
}
第二种:使用ErrorController类来实现。
系统默认的错误处理类为BasicErrorController，将会显示如上的错误页面。
这里编写一个自己的错误处理类，上面默认的处理类将不会起作用。
getErrorPath()返回的路径服务器将会重定向到该路径对应的处理类，本例中为error方法。
@Slf4j
@RestController
publicclassHttpErrorControllerimplementsErrorController{
privatefinalstaticStringERROR_PATH="/error";
@ResponseBody
@RequestMapping(path=ERROR_PATH)
publicBaseResulterror(HttpServletRequestrequest,HttpServletResponseresponse){
log.info("访问/error"+"错误代码："+response.getStatus());
BaseResultresult=newWebResult(WebResult.RESULT_FAIL,"HttpErrorControllererror:"+response.getStatus());
returnresult;
}
@Override
publicStringgetErrorPath(){
returnERROR_PATH;
}
}
测试
以上定义了一个统一的返回类BaseResult，方便前端进行处理。
packagecom.microblog.common.result;
importjava.io.Serializable;
publicclassBaseResultimplementsSerializable{
privatestaticfinallongserialVersionUID=1L;
publicstaticfinalintRESULT_FAIL=0;
publicstaticfinalintRESULT_SUCCESS=1;
//返回代码
privateIntegercode;
//返回消息
privateStringmessage;
//返回对象
privateObjectdata;
publicBaseResult(Integercode,Stringmessage){
this.code=code;
this.message=message;
}
publicBaseResult(Integercode,Stringmessage,Objectobject){
this.code=code;
this.message=message;
this.data=object;
}
publicIntegergetCode(){
returncode;
}
publicvoidsetCode(Integercode){
this.code=code;
}
publicStringgetMessage(){
returnmessage;
}
publicvoidsetMessage(Stringmessage){
this.message=message;
}
publicObjectgetData(){
returndata;
}
publicvoidsetData(Objectdata){
this.data=data;
}
}
编写一个测试控制器
@Slf4j
@RestController
@RequestMapping("/user")
publicclassTestController{
@RequestMapping("/info1")
publicStringtest(){
log.info("/user/info1");
thrownewNullPointerException("TestControllerhaveexception");
}
}
1.发出一个错误的请求,也就是没有对应的处理类。
从返回可以看到是由HttpErrorController类处理
{"code":0,"message":"HttpErrorControllererror:404","data":null}
2.发出一个正常的请求(TestController的test()处理)，处理类中抛出空异样
从返回中可以看出是由GlobalExceptionHandler类处理
{"code":0,"message":"requesterror:200","data":"GlobalExceptionHandler:TestControllerhaveexception"}
区别
1.注解@ControllerAdvice方式只能处理控制器抛出的异常。此时请求已经进入控制器中。
2.类ErrorController方式可以处理所有的异常，包括未进入控制器的错误，比如404,401等错误
3.如果应用中两者共同存在，则@ControllerAdvice方式处理控制器抛出的异常，类ErrorController方式未进入控制器的异常。
4.@ControllerAdvice方式可以定义多个拦截方法，拦截不同的异常类，并且可以获取抛出的异常信息，自由度更大。
到此这篇关于SpringBoot处理全局统一异常的实现的文章就介绍到这了,更多相关SpringBoot全局统一异常内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票！
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。