1. 程式人生 > >SpringBoot之統一異常處理

SpringBoot之統一異常處理

我們在做Web應用的時候,請求處理過程中發生錯誤是非常常見的情況。

Spring Boot提供了一個預設的對映:/error,當處理中丟擲異常之後,會轉到該請求中處理,並且該請求有一個全域性的錯誤頁面用來展示異常內容。

alt=預設的錯誤頁面

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

下面我們以之前的Web應用例子為基礎,進行統一異常處理的改造。

  • 建立全域性異常處理類:通過使用@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=自定義的錯誤頁面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統一異常處理

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

SpringBoot初始教程統一異常處理(三)

SpringBoot初始教程之統一異常處理(三) 1.介紹 在日常開發中發生了異常,往往是需要通過一個統一的異常處理處理所有異常,來保證客戶端能夠收到友好的提示。SpringBoot在頁面  發生異常的時候會自動把請求轉到/error,SpringBoot內建了一個BasicErr

SpringBoot進階統一異常處理(含原始碼)

淺談異常處理 在J2EE專案的開發中,不管是對底層的資料庫操作過程,還是業務層的處理過程,還是控制層的處理過程,都不可避免會遇到各種可預知的、不可預知的異常需要處理。每個過程都單獨處理異常,系統的程式碼耦合度高,工作量大且不好統一,維護的工作量也很大。

springboot(九)--統一異常處理(500)、錯誤頁處理(404)

如題,本篇我們介紹下springboot中統一異常500處理,以及錯誤頁404處理。 一、統一異常處理(500) 主要針對於伺服器出現500異常的情況,返回自定義的500頁面到使用者瀏覽器,或者輸出錯誤json資料到使用者瀏覽器。 如果ex是業務層丟擲的自定義異常則或取

Springboot統一異常處理

@ControllerAdvicepublic class ExceptionHandle {private final static Logger logger = LoggerFactory.get

SpringBoot從入門到放棄》第(五)篇——統一異常處理

在平時的開發測試過程中,經常能看到下面的錯誤頁面,該頁面是SpringBoot提供的預設error對映頁面,該頁面如果直接傳遞給使用者,那將非常的不友好,因此,我們通常需要去實現自定義的異常提示。 建立全域性異常處理類:通過使用@ControllerAdvice定義統一的異常處理類,而不是在

SpringBoot進階web進階3~統一異常處理

規定返回結果Result類     我們為了解決邏輯在一個地方處理,另一個地方不需要再接收它返回的資訊,所以我們引入了異常。預設的Exception只接受message的欄位,但我們通常還有code, 所以自定義一個Exception如下:

springboot 統一異常處理

sping nbsp 用法 異常處理 exc png 不能 run ges 在sping框架裏定義我們想要的異常類,不能繼承Exception,要繼承RuntimeException,原因在於spring框架只對拋出的異常是RuntimeException,才會進行事務回滾

企業分布式微服務雲SpringCloud SpringBoot mybatis (五)Spring Boot中Web應用的統一異常處理

src one exception learn 微服務 public .net 可能 訪問 我們在做Web應用的時候,請求處理過程中發生錯誤是非常常見的情況。Spring Boot提供了一個默認的映射:/error,當處理中拋出異常之後,會轉到該請求中處理,並且該請求有一個

springboot統一異常處理

ddl ice 運行 ppi stc 之間 事務回滾 提示 throws 對於與數據庫相關的 Spring MVC 項目,我們通常會把 事務 配置在 Service層,當數據庫操作失敗時讓 Service 層拋出運行時異常,Spring 事物管理器就會進行回滾。 如此一來,

spring 或 springboot統一異常處理

pbo catch ada pass ann href TP let copy spring 或 springboot統一異常處理https://blog.csdn.net/xzmeasy/article/details/76150370 一,本文介紹spring MV

SpringBoot統一異常處理統一回復介面

SpringBoot及Mybait壞境搭建詳見上一篇 一.定義回覆介面格式類 package com.example.demo.bean; /* * * Created by Ay on 2018/9/20 */ //返回的格式類 public class ResultBean&l

SpringMVC全域性異常處理 ——統一返回格式(自定義異常

SpringMVC之全域性異常處理 老規矩開篇咱們先介紹一下背景 因當前APP越來越流行,或是提供的第三方介面等等都需要你來統一返回格式。這個時候問題就來了 ,很多時候系統的異常以及為了程式碼的可讀性我們必然會抽出很多的間接層(例如資料格式校驗、資料有效性校驗等),一層層的retur

第六篇:SpringBoot統一異常處理

一、什麼是異常處理 異常(Exception)是程式在執行時可能出現的會導致程式執行終止的錯誤。這種錯誤是不能通過編譯系統檢查出來的,如果不進行異常處理,程式將中斷無法提供服務。 二、如何使用Spring Boot異常處理 案例: 獲取某個女生的年齡並判斷小於10,返

SpringBoot表單驗證、AOP處理請求和統一異常處理

表單驗證 假如表單引數很多,用@RequestParam方式就不合適了,引數中可直接使用@Valid Girl gir /** * 新增一個女生 * @return */ @PostMapping(value = "/a

springboot-表單驗證|AOP|統一異常處理

@PostMapping(value = "/girls") public Object addGirl(Girl girl) {//此處不用使用多個@RequestParam("name") Result result = new Re

Springboot統一異常處理並儲存到資料庫

一.統一異常處理之前我們平時在專案中遇到異常,用try-catch這種標準的捕獲方式處理就可以解決問題,但是在每個介面中都這麼寫,這種重複造輪子的事情對於我們程式設計師當然是不太願意的。然而我們可以在springboot專案中利用@ControllerAdvice 這個註解可

Springboot(10)輕鬆搞定統一異常處理

原始碼地址 異常的捕獲方式 方式一 HandlerExceptionResolver介面 實現該介面,註冊到spring容器中,當controller中產生異常的時候會呼叫該介面來處理,注意,當返回值指定檢視時會自動跳轉至指定的檢視中去,如果返回null

springboot統一異常處理方法

@ControllerAdvice註解將作用在所有註解了@RequestMapping的控制器的方法上 @ExceptionHandler:用於全域性處理控制器裡的異常 所以在寫專案的時候都service層和mapper層都使用拋異常的方式,把異常都拋到controller層,然後來統一處理.這

服務閘道器zuul三:zuul統一異常處理

過濾器中丟擲異常的問題 首先,我們可以來看看預設情況下,過濾器中丟擲異常Spring Cloud Zuul會發生什麼現象。我們建立一個pre型別的過濾器,並在該過濾器的run方法實現中丟擲一個異常。比如下面的實現,在run方法中呼叫的doSomething方法將丟擲Runt