SpringBoot處理全局統(tǒng)一異常的方法和區(qū)別

這篇文章主要講解了“SpringBoot處理全局統(tǒng)一異常的方法和區(qū)別”，文中的講解內(nèi)容簡(jiǎn)單清晰，易于學(xué)習(xí)與理解，下面請(qǐng)大家跟著小編的思路慢慢深入，一起來(lái)研究和學(xué)習(xí)“SpringBoot處理全局統(tǒng)一異常的方法和區(qū)別”吧！

前言

在后端發(fā)生異?；蛘呤钦?qǐng)求出錯(cuò)時(shí)，前端通常顯示如下

Whitelabel Error PageThis application has no explicit mapping for /error, so you are seeing this as a fallback.

Fri Jun 07 15:38:07 CST 2019There was an unexpected error (type=Not Found, status=404).No message available

對(duì)于用戶(hù)來(lái)說(shuō)非常不友好。

本文主要講解如何在SpringBoot應(yīng)用中使用統(tǒng)一異常處理。

實(shí)現(xiàn)方式

第一種：使用@ControllerAdvice和@ExceptionHandler注解  第二種: 使用ErrorController類(lèi)來(lái)實(shí)現(xiàn)。

第一種：使用@ControllerAdvice和@ExceptionHandler注解

@Slf4j@ControllerAdvicepublic class GlobalExceptionHandler { @ResponseBody @ExceptionHandler(NullPointerException.class) public BaseResult globalException(HttpServletResponse response,NullPointerException ex){ log.info("GlobalExceptionHandler...");log.info("錯(cuò)誤代碼：" + response.getStatus());BaseResult result = new WebResult(WebResult.RESULT_FAIL,"request error:"+response.getStatus()     ,"GlobalExceptionHandler:"+ex.getMessage()); return result;}}

注解@ControllerAdvice表示這是一個(gè)控制器增強(qiáng)類(lèi)，當(dāng)控制器發(fā)生異常且符合類(lèi)中定義的攔截異常類(lèi)，將會(huì)被攔截。

可以定義攔截的控制器所在的包路徑

@Target({ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@Componentpublic @interface ControllerAdvice { @AliasFor("basePackages") String[] value() default {}; @AliasFor("value") String[] basePackages() default {}; Class<?>[] basePackageClasses() default {}; Class<?>[] assignableTypes() default {}; Class<? extends Annotation>[] annotations() default {};}

注解ExceptionHandler定義攔截的異常類(lèi)

@Target({ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface ExceptionHandler { Class<? extends Throwable>[] value() default {};}

第二種: 使用ErrorController類(lèi)來(lái)實(shí)現(xiàn)。

系統(tǒng)默認(rèn)的錯(cuò)誤處理類(lèi)為BasicErrorController，將會(huì)顯示如上的錯(cuò)誤頁(yè)面。

這里編寫(xiě)一個(gè)自己的錯(cuò)誤處理類(lèi)，上面默認(rèn)的處理類(lèi)將不會(huì)起作用。

getErrorPath()返回的路徑服務(wù)器將會(huì)重定向到該路徑對(duì)應(yīng)的處理類(lèi)，本例中為error方法。

@Slf4j@RestControllerpublic class HttpErrorController implements ErrorController { private final static String ERROR_PATH = "/error"; @ResponseBody @RequestMapping(path = ERROR_PATH ) public BaseResult error(HttpServletRequest request, HttpServletResponse response){ log.info("訪(fǎng)問(wèn)/error" + " 錯(cuò)誤代碼：" + response.getStatus()); BaseResult result = new WebResult(WebResult.RESULT_FAIL,"HttpErrorController error:"+response.getStatus());return result; } @Override public String getErrorPath() { return ERROR_PATH; }}

測(cè)試

以上定義了一個(gè)統(tǒng)一的返回類(lèi)BaseResult，方便前端進(jìn)行處理。

package com.microblog.common.result;import java.io.Serializable;public class BaseResult implements Serializable { private static final long serialVersionUID = 1L; public static final int RESULT_FAIL = 0; public static final int RESULT_SUCCESS = 1; //返回代碼 private Integer code; //返回消息 private String message; //返回對(duì)象 private Object data; public BaseResult(Integer code, String message) {  this.code = code;  this.message = message; } public BaseResult(Integer code, String message, Object object) {  this.code = code;  this.message = message;  this.data = object; } public Integer getCode() {  return code; } public void setCode(Integer code) {  this.code = code; } public String getMessage() {  return message; } public void setMessage(String message) {  this.message = message; } public Object getData() {  return data; } public void setData(Object data) {  this.data = data; }}

編寫(xiě)一個(gè)測(cè)試控制器

@Slf4j@RestController@RequestMapping("/user")public class TestController { @RequestMapping("/info1") public String test(){  log.info("/user/info1");  throw new NullPointerException("TestController have exception"); }}

1.發(fā)出一個(gè)錯(cuò)誤的請(qǐng)求,也就是沒(méi)有對(duì)應(yīng)的處理類(lèi)。

從返回可以看到是由HttpErrorController類(lèi)處理

{"code":0,"message":"HttpErrorController error:404","data":null}

2.發(fā)出一個(gè)正常的請(qǐng)求(TestController的test()處理)，處理類(lèi)中拋出空異樣

從返回中可以看出是由GlobalExceptionHandler類(lèi)處理

{"code":0,"message":"request error:200","data":"GlobalExceptionHandler:TestController have exception"}

區(qū)別

1.注解@ControllerAdvice方式只能處理控制器拋出的異常。此時(shí)請(qǐng)求已經(jīng)進(jìn)入控制器中。

2.類(lèi)ErrorController方式可以處理所有的異常，包括未進(jìn)入控制器的錯(cuò)誤，比如404,401等錯(cuò)誤

3.如果應(yīng)用中兩者共同存在，則@ControllerAdvice方式處理控制器拋出的異常，類(lèi)ErrorController方式未進(jìn)入控制器的異常。

4.@ControllerAdvice方式可以定義多個(gè)攔截方法，攔截不同的異常類(lèi)，并且可以獲取拋出的異常信息，自由度更大。

感謝各位的閱讀，以上就是“SpringBoot處理全局統(tǒng)一異常的方法和區(qū)別”的內(nèi)容了，經(jīng)過(guò)本文的學(xué)習(xí)后，相信大家對(duì)SpringBoot處理全局統(tǒng)一異常的方法和區(qū)別這一問(wèn)題有了更深刻的體會(huì)，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是億速云，小編將為大家推送更多相關(guān)知識(shí)點(diǎn)的文章，歡迎關(guān)注！