2. 程式人生 > >Spring的全域性異常處理

Spring的全域性異常處理

阿新 • • 發佈：2019-02-01

在J2EE專案的開發中，不管是對底層的資料庫操作過程，還是業務層的處理過程，還是控制層的處理過程，都不可避免會遇到各種可預知的、不可預知的異常需要處理。每個過程都單獨處理異常，系統的程式碼耦合度高，工作量大且不好統一，維護的工作量也很大。那麼，能不能將所有型別的異常處理從各處理過程解耦出來，這樣既保證了相關處理過程的功能較單一，也實現了異常資訊的統一處理和維護？答案是肯定的。下面將介紹使用Spring MVC統一處理異常的解決和實現過程

  1. 使用Spring MVC提供的SimpleMappingExceptionResolver

    2.    實現Spring的異常處理介面HandlerExceptionResolver

自定義自己的異常處理器

    3.    使用@ExceptionHandler註解實現異常處理

(一)SimpleMappingExceptionResolver

使用這種方式具有整合簡單、有良好的擴充套件性、對已有程式碼沒有入侵性等優點，但該方法僅能獲取到異常資訊，若在出現異常時，對需要獲取除異常以外的資料的情況不適用。

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

@Configuration

@EnableWebMvc

@ComponentScan(basePackages = {"com.balbala.mvc.web"})

publicclassWebMVCConfig extendsWebMvcConfigurerAdapter{

 @Bean

  publicSimpleMappingExceptionResolver simpleMappingExceptionResolver()

  {

    SimpleMappingExceptionResolver b = newSimpleMappingExceptionResolver();

    Properties mappings = new

Properties();

    mappings.put("org.springframework.web.servlet.PageNotFound", "page-404");

    mappings.put("org.springframework.dao.DataAccessException", "data-access");

    mappings.put("org.springframework.transaction.TransactionException", "transaction-Failure");

    b.setExceptionMappings(mappings);

    returnb;

  }

}

(二)HandlerExceptionResolver

相比第一種來說,HandlerExceptionResolver能準確顯示定義的異常處理頁面,達到了統一異常處理的目標

1.定義一個類實現HandlerExceptionResolver介面,這次貼一個自己以前的程式碼

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

packagecom.athena.common.handler;

importcom.athena.common.constants.ResponseCode;

importcom.athena.common.exception.AthenaException;

importcom.athena.common.http.RspMsg;

importorg.slf4j.Logger;

importorg.slf4j.LoggerFactory;

importorg.springframework.web.servlet.HandlerExceptionResolver;

importorg.springframework.web.servlet.ModelAndView;

importjavax.servlet.http.HttpServletRequest;

importjavax.servlet.http.HttpServletResponse;

importjava.io.IOException;

importjava.io.PrintWriter;

/**

 * Created by sam on 15/4/14.

 */

publicclassGlobalHandlerExceptionResolver implementsHandlerExceptionResolver { 

 privatestaticfinalLogger LOG = LoggerFactory.getLogger(GlobalHandlerExceptionResolver.class);        

  /**  

  * 在這裡處理所有得異常資訊  

  */

  @Override

  publicModelAndView resolveException(HttpServletRequest req,                     HttpServletResponse resp, Object o, Exception ex) { 

    ex.printStackTrace();  

    if(ex instanceofAthenaException) { 

      //AthenaException為一個自定義異常

      ex.printStackTrace();    

      printWrite(ex.toString(), resp);  

      returnnewModelAndView();

    } 

    //RspMsg為一個自定義處理異常資訊的類

    //ResponseCode為一個自定義錯誤碼的介面

    RspMsg unknownException = null;  

    if(ex instanceofNullPointerException) {   

      unknownException = newRspMsg(ResponseCode.CODE_UNKNOWN, "業務判空異常", null);

    } else{    

      unknownException = newRspMsg(ResponseCode.CODE_UNKNOWN, ex.getMessage(), null);    }  

      printWrite(unknownException.toString(), resp); 

      returnnewModelAndView(); 

  }

  /**  

  * 將錯誤資訊新增到response中  

  *  

  * @param msg  

  * @param response  

  * @throws IOException  

  */

  publicstaticvoidprintWrite(String msg, HttpServletResponse response) {  

     try{     

       PrintWriter pw = response.getWriter();   

       pw.write(msg);   

       pw.flush();   

       pw.close();  

     } catch(Exception e) {    

       e.printStackTrace();  

     } 

  }

}

2.加入spring的配置中,這裡只貼出了相關部分

1

2

3

4

5

6

7

8

9

10

11

1

importcom.athena.common.handler.GlobalHandlerExceptionResolver;

importorg.springframework.context.annotation.Bean;

importcom.athena.common.handler.GlobalHandlerExceptionResolver;

importorg.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

/**

 * Created by sam on 15/4/14.

 */

publicclassWebSpringMvcConfig extendsWebMvcConfigurerAdapter {

  @Bean

  publicGlobalHandlerExceptionResolver globalHandlerExceptionResolver() {

   returnnewGlobalHandlerExceptionResolver();

  }

}

(三)@ExceptionHandler

這是筆者現在專案的使用方式,這裡也僅貼出了相關部分

1.首先定義一個父類,實現一些基礎的方法

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

packagecom.balabala.poet.base.spring;

importcom.google.common.base.Throwables;

importcom.raiyee.poet.base.exception.MessageException;

importcom.raiyee.poet.base.utils.Ajax;

importorg.slf4j.Logger;

importorg.slf4j.LoggerFactory;

importorg.springframework.core.annotation.AnnotationUtils;

importorg.springframework.http.HttpStatus;

importorg.springframework.web.bind.annotation.ResponseStatus;

importorg.springframework.web.servlet.ModelAndView;

importjavax.servlet.http.HttpServletRequest;

importjavax.servlet.http.HttpServletResponse;

importjava.io.IOException;

importjava.io.PrintWriter;

importjava.util.Date;

publicclassBaseGlobalExceptionHandler { 

   protectedstaticfinalLogger logger = null; 

   protectedstaticfinalString DEFAULT_ERROR_MESSAGE = "系統忙，請稍後再試";

   protectedModelAndView handleError(HttpServletRequest req, HttpServletResponse rsp, Exception e, String viewName, HttpStatus status) throwsException { 

     if(AnnotationUtils.findAnnotation(e.getClass(), ResponseStatus.class) != null)   

     throwe;  

     String errorMsg = e instanceofMessageException ? e.getMessage() : DEFAULT_ERROR_MESSAGE;   

     String errorStack = Throwables.getStackTraceAsString(e); 

     getLogger().error("Request: {} raised {}", req.getRequestURI(), errorStack);   

     if(Ajax.isAjax(req)) {   

       returnhandleAjaxError(rsp, errorMsg, status); 

     }   

     returnhandleViewError(req.getRequestURL().toString(), errorStack, errorMsg, viewName);

   } 

   protectedModelAndView handleViewError(String url, String errorStack, String errorMessage, String viewName) {   

     ModelAndView mav = newModelAndView();   

     mav.addObject("exception", errorStack);   

     mav.addObject("url", url);  

     mav.addObject("message", errorMessage);

     mav.addObject("timestamp", newDate());   

     mav.setViewName(viewName); 

     returnmav; 

    } 

   protectedModelAndView handleAjaxError(HttpServletResponse rsp, String errorMessage, HttpStatus status) throwsIOException {   

      rsp.setCharacterEncoding("UTF-8");   

      rsp.setStatus(status.value());  

      PrintWriter writer = rsp.getWriter();

      writer.write(errorMessage);   

      writer.flush();   

      returnnull; 

   } 

   publicLogger getLogger() {   

      returnLoggerFactory.getLogger(BaseGlobalExceptionHandler.class);

   }

}

2.針對你需要捕捉的異常實現相對應的處理方式

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

packagecom.balabala.poet.base.spring;

importorg.slf4j.Logger;

importorg.slf4j.LoggerFactory;

importorg.springframework.http.HttpStatus;

importorg.springframework.web.bind.annotation.ControllerAdvice;

importorg.springframework.web.bind.annotation.ExceptionHandler;

importorg.springframework.web.bind.annotation.ResponseStatus;

importorg.springframework.web.servlet.ModelAndView;

importorg.springframework.web.servlet.NoHandlerFoundException;

importjavax.servlet.http.HttpServletRequest;

importjavax.servlet.http.HttpServletResponse;

@ControllerAdvice

publicclassGlobalExceptionHandler extendsBaseGlobalExceptionHandler { 

   //比如404的異常就會被這個方法捕獲

   @ExceptionHandler(NoHandlerFoundException.class) 

   @ResponseStatus(HttpStatus.NOT_FOUND) 

    publicModelAndView handle404Error(HttpServletRequest req, HttpServletResponse rsp, Exception e) throwsException { 

       returnhandleError(req, rsp, e, "error-front", HttpStatus.NOT_FOUND); 

    } 

   //500的異常會被這個方法捕獲

   @ExceptionHandler(Exception.class)  

   @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)

   publicModelAndView handleError(HttpServletRequest req, HttpServletResponse rsp, Exception e) throwsException {

       returnhandleError(req, rsp, e, "error-front", HttpStatus.INTERNAL_SERVER_ERROR);

   } 

   //TODO 你也可以再寫一個方法來捕獲你的自定義異常

   //TRY NOW!!!

   @Override

   publicLogger getLogger() {  

      returnLoggerFactory.getLogger(GlobalExceptionHandler.class); 

   }

 }

相關推薦

spring 全域性異常處理類

spring全域性異常處理 @ControllerAdvice 註解包含@Component註解，在context:component-scan掃描包的時候，注意掃描方式，需要把異常處理類掃描進去 package com.admin.exceptionc

spring boot 統一返回資料及全域性異常處理

記錄關於spring boot 統一返回資料及全域性異常處理的操作實現。 一、統一返回資料 1、定義一個超類：BaseResponseVo @Data @NoArgsConstructor public class BaseResponseVo{ protected Integer r

Spring Boot-錯誤處理及自定義全域性異常處理機制

正常的Web應用開發時，需要考慮到應用執行發生異常時或出現錯誤時如何來被處理，例如捕獲必要的異常資訊，記錄日誌方便日後排錯，友好的使用者響應輸出等等。 當然應用發生錯誤，有可能是應用自身的問題，也有可能是客戶端操作的問題。 Spring Boot預設提供了一種錯誤處理機制。 預設錯誤處理機制

Spring Boot 全域性異常處理 與 Hibernate Validator校驗框架整合

Hibernate Validator校驗框架的使用 Spring boot已經集成了hibernate-validator，不需要引入maven，其他框架也可以自己引入： <dependency> <groupId>org.h

Spring 中全域性異常處理 @ExceptionHandler

最近在專案中整理了一些關於 Springboot 和 Spring 的 Exception 處理, 記錄下來也分享給其他需要的人. 學習全域性異常處理之前, 首先我們來了解兩個註解. @ControllerAdvice 和 @ExceptionHandler @Con

Spring Boot 統一返回資料結構以及全域性異常處理

前言 看了廖師兄的視訊後,結合自己以前的程式設計經驗總結下 : 在 web 開發過程中, 後端要統一返回的資料結構,便於前端處理。例如每個請求,我們都需要知道 : code : 伺服器返回的狀態碼(主要給程式設計師看)。例如 : 200 : 請求成功。

spring 的全域性異常處理

import java.util.*; import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.sprin

Spring Boot 2 Webflux的全域性異常處理

本文首先將會回顧Spring 5之前的SpringMVC異常處理機制，然後主要講解Spring Boot 2 Webflux的全域性異常處理機制。 SpringMVC的異常處理 Spring 統一異常處理有 3 種方式，分別為： 使用 @ExceptionHandler 註解 實現 Handl

Spring Boot 學習筆記（十三）——全域性異常處理

預設異常處理機制 1、Whitelabel Error Page 當客戶端訪問頁面不存在，或服務端處理髮生異常，一般瀏覽器客戶端傳送的請求頭中為：Accept：text/html；所以就返回一個html文件。 這裡有一個很重要的類：BasicErrorContr

【本人禿頂程式設計師】Spring Cloud Gateway的全域性異常處理

←←←←←←←←←←←← 我都禿頂了，還不點關注！ Spring Cloud Gateway中的全域性異常處理不能直接用@ControllerAdvice來處理，通過跟蹤異常資訊的丟擲，找到對應的原始碼，自定義一些處理邏輯來符合業務的需求。 閘道器都是給介面做代理轉發的，後端對應的都

springboot全域性異常處理(包含404錯誤處理) 一:解決spring boot中rest介面404,500等錯誤返回統一的json格式(備用地址) 二:SpringBoot入門——區域性與全域性的異常處理(備用地址)

個人整理參考文件: 一:解決spring boot中rest介面404,500等錯誤返回統一的json格式(備用地址) 二:SpringBoot入門——區域性與全域性的異常處理(備用地址) 三:SpringBoot全域性異常處理(備用地址) 四:sprin

spring web 全域性異常處理

@ControllerAdvice註解 + @ExceptionHandler註解 實現一個異常處理類，在類上應用@ControllerAdvice註解，並在異常處理方法上應用@ExceptionHandler註解。那麼在web應用中，當Controller的@RequestMapping方法丟擲指

Spring Cloud Gateway的全域性異常處理

Spring Cloud Gateway中的全域性異常處理不能直接用@ControllerAdvice來處理，通過跟蹤異常資訊的丟擲，找到對應的原始碼，自定義一些處理邏輯來符合業務的需求。 閘道器都是給介面做代理轉發的，後端對應的都是REST API，返回資料格

spring boot 全域性異常處理及自定義異常類

全域性異常處理：定義一個處理類，使用@ControllerAdvice註解。@ControllerAdvice註解：控制器增強，一個被@Component註冊的元件。配合@ExceptionHandler來增強所有的@requestMapping方法。例如：@Exceptio

Spring Cloud 全域性異常處理類

這個是放在系統內部的 全域性異常處理類： package com.hg.service.bussiness.system.execption; import com.hg.core.code.BaseCode; import com.hg.core

Spring運用（三）------全域性異常處理（HandlerExceptionResolver）

前言 大家在使用Spring框架編寫Controller的時候，都會遇到這樣一種情況，就是想做一個全域性異常處理，目的是不要每個人都單獨攔截處理系統類的異常。 正文 下面我將介紹一種方法，利用HandlerExceptionResolver做一個統一的

Spring Boot 菜鳥教程 6 全域性異常處理

GitHub @ControllerAdvice原始碼 package org.springframework.web.bind.annotation; import java.lang.annotation.Annotation; impor

Spring Boot 2 全域性異常處理

1、建立 MyRestControllerAdvice 類，並新增 @RestControllerAdviceimport com.tm.common.dto.Rjson; import com.tm.common.exception.BusinessException; i

Spring MVC 全域性異常處理-RESTAPI介面返回統一JSON格式-自定義異常處理--404異常捕捉

寫之前大概兩週草草的將一些程式碼儲存在草稿箱，今天有空來看，結果都沒有了【怨念】—重新整理一下了 —–【轉載請標註出處】 第一部分：需求 第二部分：實現方式 第三部分：404異常捕捉不能實現分析 第四部分：原因和原始碼分析 第五部分：最終總結 需求

Spring的全域性異常處理

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