2. 程式人生 > 實用技巧 >SpringBoot處理全域性統一異常

SpringBoot處理全域性統一異常

阿新 • • 發佈：2020-08-03

在後端發生異常或者是請求出錯時，前端通常顯示如下

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註解

@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {

    @ResponseBody
    @ExceptionHandler(NullPointerException.class)
    public BaseResult globalException(HttpServletResponse response,NullPointerException ex){


        log.info("GlobalExceptionHandler...");
 
log.info("錯誤程式碼："  + response.getStatus());
BaseResult result = new WebResult(WebResult.RESULT_FAIL,"request error:"+response.getStatus()
                                        ,"GlobalExceptionHandler:"+ex.getMessage());
        return result;
}

}

註解@ControllerAdvice表示這是一個控制器增強類，當控制器發生異常且符合類中定義的攔截異常類，將會被攔截。

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

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface ControllerAdvice {
    @AliasFor("basePackages")
    String[] value() default {};

    @AliasFor("value")
    String[] basePackages() default {};

    Class<?>[] basePackageClasses() default {};

    Class<?>[] assignableTypes() default {};

    Class<? extends Annotation>[] annotations() default {};
}

註解ExceptionHandler定義攔截的異常類

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

第二種: 使用ErrorController類來實現。

系統預設的錯誤處理類為BasicErrorController，將會顯示如上的錯誤頁面。

這裡編寫一個自己的錯誤處理類，上面預設的處理類將不會起作用。

getErrorPath()返回的路徑伺服器將會重定向到該路徑對應的處理類，本例中為error方法。

@Slf4j
@RestController
public 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("訪問/error" + "  錯誤程式碼："  + response.getStatus());
        BaseResult result = new WebResult(WebResult.RESULT_FAIL,"HttpErrorController error:"+response.getStatus());
return result;
    }
    @Override
    public String getErrorPath() {
        return ERROR_PATH;
    }
}

測試

以上定義了一個統一的返回類BaseResult，方便前端進行處理。

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;

    //返回物件
    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;
    }
}

編寫一個測試控制器

@Slf4j
@RestController
@RequestMapping("/user")
public class TestController {

    @RequestMapping("/info1")
    public String test(){
      log.info("/user/info1");

      throw new NullPointerException("TestController have exception");

    }
}

1.發出一個錯誤的請求,也就是沒有對應的處理類。

從返回可以看到是由HttpErrorController類處理

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

2.發出一個正常的請求(TestController的test()處理)，處理類中丟擲空異樣

從返回中可以看出是由GlobalExceptionHandler類處理

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

區別

1.註解@ControllerAdvice方式只能處理控制器丟擲的異常。此時請求已經進入控制器中。

2.類ErrorController方式可以處理所有的異常，包括未進入控制器的錯誤，比如404,401等錯誤

3.如果應用中兩者共同存在，則@ControllerAdvice方式處理控制器丟擲的異常，類ErrorController方式未進入控制器的異常。

4.@ControllerAdvice方式可以定義多個攔截方法，攔截不同的異常類，並且可以獲取丟擲的異常資訊，自由度更大。

https://www.cnblogs.com/lgjlife/p/10988439.html

Spring Boot中Web應用的統一異常處理

我們在做Web應用的時候，請求處理過程中發生錯誤是非常常見的情況。Spring Boot提供了一個預設的對映：/error，當處理中丟擲異常之後，會轉到該請求中處理，並且該請求有一個全域性的錯誤頁面用來展示異常內容。

選擇一個之前實現過的Web應用（Chapter3-1-2）為基礎，啟動該應用，訪問一個不存在的URL，或是修改處理內容，直接丟擲異常，如：

@RequestMapping("/hello")
public String hello() throws Exception {
    throw new Exception("發生錯誤");
}

此時，可以看到類似下面的報錯頁面，該頁面就是Spring Boot提供的預設error對映頁面。

alt=預設的錯誤頁面

統一異常處理

雖然，Spring Boot中實現了預設的error對映，但是在實際應用中，上面你的錯誤頁面對使用者來說並不夠友好，我們通常需要去實現我們自己的異常提示。

下面我們以之前的Web應用例子為基礎（Chapter3-1-2），進行統一異常處理的改造。

  • 建立全域性異常處理類：通過使用@ControllerAdvice定義統一的異常處理類，而不是在每個Controller中逐個定義。@ExceptionHandler用來定義函式針對的異常型別，最後將Exception物件和請求URL對映到error.html中
@ControllerAdvice
class GlobalExceptionHandler {

    public static final String DEFAULT_ERROR_VIEW = "error";

    @ExceptionHandler(value = Exception.class)
    public ModelAndView defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {
        ModelAndView mav = new ModelAndView();
        mav.addObject("exception", e);
        mav.addObject("url", req.getRequestURL());
        mav.setViewName(DEFAULT_ERROR_VIEW);
        return mav;
    }

}
  • 實現error.html頁面展示：在templates目錄下建立error.html，將請求的URL和Exception物件的message輸出。
<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8" />
    <title>統一異常處理</title>
</head>
<body>
    <h1>Error Handler</h1>
    <div th:text="${url}"></div>
    <div th:text="${exception.message}"></div>
</body>
</html>

啟動該應用，訪問：http://localhost:8080/hello，可以看到如下錯誤提示頁面。

alt=自定義的錯誤頁面

通過實現上述內容之後，我們只需要在Controller中丟擲Exception，當然我們可能會有多種不同的Exception。然後在@ControllerAdvice類中，根據丟擲的具體Exception型別匹配@ExceptionHandler中配置的異常型別來匹配錯誤對映和處理。

返回JSON格式

在上述例子中，通過@ControllerAdvice統一定義不同Exception對映到不同錯誤處理頁面。而當我們要實現RESTful API時，返回的錯誤是JSON格式的資料，而不是HTML頁面，這時候我們也能輕鬆支援。

本質上，只需在@ExceptionHandler之後加入@ResponseBody，就能讓處理函式return的內容轉換為JSON格式。

下面以一個具體示例來實現返回JSON格式的異常處理。

  • 建立統一的JSON返回物件，code：訊息型別，message：訊息內容，url：請求的url，data：請求返回的資料
public class ErrorInfo<T> {

    public static final Integer OK = 0;
    public static final Integer ERROR = 100;

    private Integer code;
    private String message;
    private String url;
    private T data;

    // 省略getter和setter

}
  • 建立一個自定義異常，用來實驗捕獲該異常，並返回json
public class MyException extends Exception {

    public MyException(String message) {
        super(message);
    }
    
}
  • Controller中增加json對映，丟擲MyException異常
@Controller
public class HelloController {

    @RequestMapping("/json")
    public String json() throws MyException {
        throw new MyException("發生錯誤2");
    }

}
  • 為MyException異常建立對應的處理
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(value = MyException.class)
    @ResponseBody
    public ErrorInfo<String> jsonErrorHandler(HttpServletRequest req, MyException e) throws Exception {
        ErrorInfo<String> r = new ErrorInfo<>();
        r.setMessage(e.getMessage());
        r.setCode(ErrorInfo.ERROR);
        r.setData("Some Data");
        r.setUrl(req.getRequestURL().toString());
        return r;
    }

}
 
{
    code: 100，
    data: "Some Data"，
    message: "發生錯誤2"，
    url: "http://localhost:8080/json"
}

至此，已完成在Spring Boot中建立統一的異常處理，實際實現還是依靠Spring MVC的註解，更多更深入的使用可參考Spring MVC的文件。

http://blog.didispace.com/springbootexception/

相關推薦

SpringBoot處理全域性統一異常

在後端發生異常或者是請求出錯時，前端通常顯示如下 Whitelabel Error Page This application has no explicit mapping for /error, so you are seeing this as a fallback.

SpringBoot處理全域性統一異常的實現

在後端發生異常或者是請求出錯時，前端通常顯示如下 Whitelabel Error Page This application has no explicit mapping for /error,so you are seeing this as a fallback.

Springboot處理全域性異常並自動獲取狀態碼

技術標籤：程式碼 傳送請求後，一旦出現異常，系統自動捕獲 狀態碼由response.getStatus()方法獲取

框架 Spring Boot 技術入門到整合 7-1 Springboot配置全域性的異常捕獲 -web頁面跳轉

0　　　　課程地址 https://www.imooc.com/video/16723/0 1　　　　本節介紹 發生異常不在介面顯示500，404等業務人員看不明白的錯誤，轉化為易讀懂的方式。

框架 Spring Boot 技術入門到整合 7-3 Springboot配置全域性的異常捕獲 -同時相容web和ajax

0　　　　課程地址 https://www.imooc.com/video/16725 1　　　　課程demo 1.1　　課程demo（前兩節的一個整合）

【轉】 SpringBoot統一異常處理

【轉】 SpringBoot統一異常處理 　　一：在實際開發中，當我們程式報錯時，不是直接顯示錯誤內容給使用者，一般都會統一跳轉到錯誤頁面。定義一個異常方法，如下：

springboot專案全域性異常處理@ControllerAdvice（方式二）

SpringMVC 中 @ControllerAdvice 註解的三種使用場景！ @ControllerAdvice ，很多初學者可能都沒有聽說過這個註解，實際上，這是一個非常有用的註解，顧名思義，這是一個增強的 Controller。使用這個 Controller

看看人家SpringBoot的全域性異常處理多麼優雅...

首先還是Maven的相關依賴: <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

springboot統一異常處理

技術標籤：筆記ideajava springboot統一異常處理 1、首先引入依賴（若不用資料校驗則忽略這一步）

《SpringBoot 專案全域性異常處理》

技術標籤：SpringBoot專案spring bootspringjava後端 前提 為什麼使用全域性異常處理？

springboot-統一異常處理

技術標籤：spring boot 目錄 統一異常處理404錯誤統一處理 統一異常處理 呼叫服務介面時如果出現異常，則會按照預設的http返回格式進行返回，如果需要自定義異常返回格式，則需要通過@RestControllerAdvice實

SpringBoot專案全域性異常處理

一.為什麼要配置全域性異常？ 不配置全域性異常，服務端報錯場景 1/0、空指標等

springboot 統一異常處理程式碼例項

package *.web.controller; import java.io.Serializable; import java.io.UnsupportedEncodingException; import java.sql.SQLException;

SpringBoot 統一異常處理

1.前言 在做專案的時候，常常會遇到這些情況， ​ （一）、繁多的if..else 造成大量的引數程式碼判斷，於是就在實體類欄位中新增@NotBlank,@NotNull等註解代替，可是註解上自定義的message 訊息無法規範的返回到前端

【SpringBoot】統一返回物件和統一異常處理

為什麼要統一異常 Java異常分為unchecked和checked，對於unchecked的那些異常一般都是程式碼寫的有問題，比如你沒有處理null物件，直接就用這個物件的方法或者屬性了(NullPointException)，或者是除0(ArithmeticExc

springboot 後端統一返回資料格式，異常統一處理

springboot 後端統一返回資料格式，異常統一處理 模板 場景： 後端給前端的資料型別可能會是基本資料型別、String字串、物件、陣列、或者異常提示等。前端拿到你返回的資料去展示或者給出錯誤提示，但他不可能說每個

基於spring 的統一異常處理

將業務執行過程中會產生的各種異常，對其進行統一處理是所有web專案的通用需求，spring 作為最流行的web框架，自然是提供瞭解決方案。

SpringMVC統一異常處理例項程式碼

一、需求 一般專案中都需要作異常處理，基於系統架構的設計考慮，使用統一的異常處理方法。

SpringMVC統一異常處理三種方法詳解

這篇文章主要介紹了SpringMVC-統一異常處理三種方法詳解,文中通過示例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

Spring Cloud Gateway全域性通用異常處理的實現

為什麼需要全域性異常處理 在傳統 Spring Boot 應用中， 我們 @ControllerAdvice 來處理全域性的異常，進行統一包裝返回