Spring Boot处理全局统一异常的两种方法与区别

忘是亡心i 2023-07-19 12:27 13阅读 0赞

[https://www.jb51.net/article/162919.htm][https_www.jb51.net_article_162919.htm]

**前言**

在后端发生异常或者是请求出错时，前端通常显示如下

> Whitelabel Error Page  
> This application has no explicit mapping for /error, so you are seeing this as a fallback.
> 
> Fri Jun 07 15:38:07 CST 2019  
> There was an unexpected error (type=Not Found, status=404).  
> No message available

对于用户来说非常不友好。

本文主要讲解如何在SpringBoot应用中使用统一异常处理。

**实现方式**

*  第一种：使用@ControllerAdvice和@ExceptionHandler注解
 *  第二种: 使用ErrorController类来实现。

**第一种：使用@ControllerAdvice和@ExceptionHandler注解**

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </td> 
 <td> <code>@Slf4j</code> <code>@ControllerAdvice</code> <code>public</code> <code>class</code> <code>GlobalExceptionHandler { </code> &nbsp; <code>&nbsp;</code><code>@ResponseBody</code> <code>&nbsp;</code><code>@ExceptionHandler</code><code>(NullPointerException.</code><code>class</code><code>)</code> <code>&nbsp;</code><code>public</code> <code>BaseResult globalException(HttpServletResponse response,NullPointerException ex){ </code> &nbsp; &nbsp; <code>&nbsp;</code><code>log.info(</code><code>"GlobalExceptionHandler..."</code><code>);</code> <code>log.info(</code><code>"错误代码："</code> <code>+ response.getStatus());</code> <code>BaseResult result = </code><code>new</code> <code>WebResult(WebResult.RESULT_FAIL,</code><code>"request error:"</code><code>+response.getStatus()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>,</code><code>"GlobalExceptionHandler:"</code><code>+ex.getMessage());</code> <code>&nbsp;</code><code>return</code> <code>result;</code> <code>}</code> &nbsp; <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

注解@ControllerAdvice表示这是一个控制器增强类，当控制器发生异常且符合类中定义的拦截异常类，将会被拦截。

可以定义拦截的控制器所在的包路径

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </td> 
 <td> <code>@Target</code><code>({ElementType.TYPE})</code> <code>@Retention</code><code>(RetentionPolicy.RUNTIME)</code> <code>@Documented</code> <code>@Component</code> <code>public</code> <code>@interface</code> <code>ControllerAdvice { </code> <code>&nbsp;</code><code>@AliasFor</code><code>(</code><code>"basePackages"</code><code>)</code> <code>&nbsp;</code><code>String[] value() </code><code>default</code> <code>{};</code> &nbsp; <code>&nbsp;</code><code>@AliasFor</code><code>(</code><code>"value"</code><code>)</code> <code>&nbsp;</code><code>String[] basePackages() </code><code>default</code> <code>{};</code> &nbsp; <code>&nbsp;</code><code>Class&lt;?&gt;[] basePackageClasses() </code><code>default</code> <code>{};</code> &nbsp; <code>&nbsp;</code><code>Class&lt;?&gt;[] assignableTypes() </code><code>default</code> <code>{};</code> &nbsp; <code>&nbsp;</code><code>Class&lt;? </code><code>extends</code> <code>Annotation&gt;[] annotations() </code><code>default</code> <code>{};</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

注解ExceptionHandler定义拦截的异常类

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>@Target</code><code>({ElementType.METHOD})</code> <code>@Retention</code><code>(RetentionPolicy.RUNTIME)</code> <code>@Documented</code> <code>public</code> <code>@interface</code> <code>ExceptionHandler { </code> <code>&nbsp;</code><code>Class&lt;? </code><code>extends</code> <code>Throwable&gt;[] value() </code><code>default</code> <code>{};</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**第二种: 使用ErrorController类来实现。**

系统默认的错误处理类为BasicErrorController，将会显示如上的错误页面。

这里编写一个自己的错误处理类，上面默认的处理类将不会起作用。

getErrorPath()返回的路径服务器将会重定向到该路径对应的处理类，本例中为error方法。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 </td> 
 <td> <code>@Slf4j</code> <code>@RestController</code> <code>public</code> <code>class</code> <code>HttpErrorController </code><code>implements</code> <code>ErrorController { </code> &nbsp; <code>&nbsp;</code><code>private</code> <code>final</code> <code>static</code> <code>String ERROR_PATH = </code><code>"/error"</code><code>;</code> &nbsp; <code>&nbsp;</code><code>@ResponseBody</code> <code>&nbsp;</code><code>@RequestMapping</code><code>(path = ERROR_PATH )</code> <code>&nbsp;</code><code>public</code> <code>BaseResult error(HttpServletRequest request, HttpServletResponse response){ </code> <code>&nbsp;</code><code>log.info(</code><code>"访问/error"</code> <code>+ </code><code>" 错误代码："</code> <code>+ response.getStatus());</code> <code>&nbsp;</code><code>BaseResult result = </code><code>new</code> <code>WebResult(WebResult.RESULT_FAIL,</code><code>"HttpErrorController error:"</code><code>+response.getStatus());</code> <code>return</code> <code>result;</code> <code>&nbsp;</code><code>}</code> <code>&nbsp;</code><code>@Override</code> <code>&nbsp;</code><code>public</code> <code>String getErrorPath() { </code> <code>&nbsp;</code><code>return</code> <code>ERROR_PATH;</code> <code>&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

测试

以上定义了一个统一的返回类BaseResult，方便前端进行处理。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 </td> 
 <td> <code>package</code> <code>com.microblog.common.result;</code> &nbsp; <code>import</code> <code>java.io.Serializable;</code> &nbsp; &nbsp; <code>public</code> <code>class</code> <code>BaseResult </code><code>implements</code> <code>Serializable { </code> &nbsp; <code>&nbsp;</code><code>private</code> <code>static</code> <code>final</code> <code>long</code> <code>serialVersionUID = 1L;</code> &nbsp; <code>&nbsp;</code><code>public</code> <code>static</code> <code>final</code> <code>int</code> <code>RESULT_FAIL = </code><code>0</code><code>;</code> <code>&nbsp;</code><code>public</code> <code>static</code> <code>final</code> <code>int</code> <code>RESULT_SUCCESS = </code><code>1</code><code>;</code> &nbsp; <code>&nbsp;</code><code>//返回代码</code> <code>&nbsp;</code><code>private</code> <code>Integer code;</code> &nbsp; <code>&nbsp;</code><code>//返回消息</code> <code>&nbsp;</code><code>private</code> <code>String message;</code> &nbsp; <code>&nbsp;</code><code>//返回对象</code> <code>&nbsp;</code><code>private</code> <code>Object data;</code> &nbsp; <code>&nbsp;</code><code>public</code> <code>BaseResult(Integer code, String message) { </code> <code>&nbsp;&nbsp;</code><code>this</code><code>.code = code;</code> <code>&nbsp;&nbsp;</code><code>this</code><code>.message = message;</code> <code>&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;</code><code>public</code> <code>BaseResult(Integer code, String message, Object object) { </code> <code>&nbsp;&nbsp;</code><code>this</code><code>.code = code;</code> <code>&nbsp;&nbsp;</code><code>this</code><code>.message = message;</code> <code>&nbsp;&nbsp;</code><code>this</code><code>.data = object;</code> <code>&nbsp;</code><code>}</code> &nbsp; &nbsp; <code>&nbsp;</code><code>public</code> <code>Integer getCode() { </code> <code>&nbsp;&nbsp;</code><code>return</code> <code>code;</code> <code>&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;</code><code>public</code> <code>void</code> <code>setCode(Integer code) { </code> <code>&nbsp;&nbsp;</code><code>this</code><code>.code = code;</code> <code>&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;</code><code>public</code> <code>String getMessage() { </code> <code>&nbsp;&nbsp;</code><code>return</code> <code>message;</code> <code>&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;</code><code>public</code> <code>void</code> <code>setMessage(String message) { </code> <code>&nbsp;&nbsp;</code><code>this</code><code>.message = message;</code> <code>&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;</code><code>public</code> <code>Object getData() { </code> <code>&nbsp;&nbsp;</code><code>return</code> <code>data;</code> <code>&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;</code><code>public</code> <code>void</code> <code>setData(Object data) { </code> <code>&nbsp;&nbsp;</code><code>this</code><code>.data = data;</code> <code>&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

编写一个测试控制器

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td> <code>@Slf4j</code> <code>@RestController</code> <code>@RequestMapping</code><code>(</code><code>"/user"</code><code>)</code> <code>public</code> <code>class</code> <code>TestController { </code> &nbsp; <code>&nbsp;</code><code>@RequestMapping</code><code>(</code><code>"/info1"</code><code>)</code> <code>&nbsp;</code><code>public</code> <code>String test(){ </code> <code>&nbsp;&nbsp;</code><code>log.info(</code><code>"/user/info1"</code><code>);</code> &nbsp; <code>&nbsp;&nbsp;</code><code>throw</code> <code>new</code> <code>NullPointerException(</code><code>"TestController have exception"</code><code>);</code> &nbsp; <code>&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

1.发出一个错误的请求,也就是没有对应的处理类。

从返回可以看到是由HttpErrorController类处理

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>{ </code><code>"code"</code><code>:</code><code>0</code><code>,</code><code>"message"</code><code>:</code><code>"HttpErrorController error:404"</code><code>,</code><code>"data"</code><code>:</code><code>null</code><code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

2.发出一个正常的请求(TestController的test()处理)，处理类中抛出空异样

从返回中可以看出是由GlobalExceptionHandler类处理

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>{ </code><code>"code"</code><code>:</code><code>0</code><code>,</code><code>"message"</code><code>:</code><code>"request error:200"</code><code>,</code><code>"data"</code><code>:</code><code>"GlobalExceptionHandler:TestController have exception"</code><code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**区别**

1.注解@ControllerAdvice方式只能处理控制器抛出的异常。此时请求已经进入控制器中。

2.类ErrorController方式可以处理所有的异常，包括未进入控制器的错误，比如404,401等错误

3.如果应用中两者共同存在，则@ControllerAdvice方式处理控制器抛出的异常，类ErrorController方式未进入控制器的异常。

4.@ControllerAdvice方式可以定义多个拦截方法，拦截不同的异常类，并且可以获取抛出的异常信息，自由度更大。

**总结**

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对脚本之家的支持。

[https_www.jb51.net_article_162919.htm]: https://www.jb51.net/article/162919.htm