SpringBoot全局異常處理機(jī)制和配置攔截器方式

更新時(shí)間：2023年12月11日 16:27:20 作者：勇敢流流

這篇文章主要介紹了SpringBoot全局異常處理機(jī)制和配置攔截器方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

SpringBoot全局異常處理機(jī)制和配置攔截器

關(guān)于SpringBoot的全局異常處理，其實(shí)十分簡(jiǎn)單。

首先，要新建一個(gè)SpringBoot項(xiàng)目添加兩個(gè)依賴，spring-boot-starter-web和spring-boot-starter-thymeleaf。

這個(gè)時(shí)候，我們便可以把異常信息展示在thymeleaf頁(yè)面。

編寫(xiě)接口：

以往的SpringMVC配置在SpringBoot項(xiàng)目中依然生效。

所以可以通過(guò)實(shí)現(xiàn)HandlerExceptionResolver接口或者添加@ExceptionHandler注解來(lái)處理全局異常。

@ControllerAdvice
public class GlobalExceptionHandler implements HandlerExceptionResolver {
    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        ModelAndView mv = new ModelAndView("01");
        mv.addObject("error",ex.getMessage());
        return mv;
    }
}

@ControllerAdvice
public class GlobalExceptionHandler2 {
    @ExceptionHandler(ArithmeticException.class)
    public ModelAndView resolveException( Exception ex) {
        ModelAndView mv = new ModelAndView("01");
        mv.addObject("error",ex.getMessage());
        return mv;
    }
}

thymeleaf視圖必須放在/resources/templates文件夾下，此時(shí)需要新建一個(gè)01.html：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>測(cè)試頁(yè)面</title>
</head>
<body>
<h4>異常信息顯示：</h4>
<div th:text="${error}"></div>
</body>
</html>

注意：SpringBoot項(xiàng)目里面freemarker頁(yè)面和thymeleaf頁(yè)面不需要配置視圖解析器，Spring會(huì)自動(dòng)幫我們識(shí)別并渲染ftlh和html頁(yè)面。

測(cè)試：

以上是SpringMVC配置在SpringBoot中依然適用。

但是基于SpringBoot項(xiàng)目的異常配置，SpringBoot自己也有一套全局異常處理機(jī)制。

SpringBoot異常處理

默認(rèn)方案，在靜態(tài)頁(yè)面里面展示異常信息：

但是，必須要在靜態(tài)資源文件夾下新建error文件夾，里面放自己的錯(cuò)誤頁(yè)面信息，4xx和5xx為模糊查詢，SpringBoot支持4xx和5xx的狀態(tài)錯(cuò)誤。

這里為了省事，我就在頁(yè)面里放了一個(gè)div輸出一句話。

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>4xx</title>
</head>
<body>
<div>4xx-static-html</div>
</body>
</html>

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>5xx</title>
</head>
<body>
<div>5xx-static-html</div>
</body>
</html>

測(cè)試結(jié)果為頁(yè)面顯示5xx-static-html，在這里還有一個(gè)小細(xì)節(jié)，假如我們定義了一個(gè)精確的狀態(tài)碼頁(yè)面，例如數(shù)學(xué)算術(shù)錯(cuò)誤為500，定義了一個(gè)500.html，那么是優(yōu)先顯示500的頁(yè)面還是5xx的頁(yè)面呢，這就涉及一個(gè)優(yōu)先級(jí)的問(wèn)題。

在這里先埋下一個(gè)伏筆，繼續(xù)往下走。

我們知道thymeleaf實(shí)際上是一個(gè)動(dòng)態(tài)頁(yè)面，所以同樣的，我們?cè)趖emplates文件下新建error文件夾放兩個(gè)html文件：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>4xx</title>
</head>
<body>
<div>這是動(dòng)態(tài)展示錯(cuò)誤的頁(yè)面：</div>
<table border="1">
    <tr>
        <td>出錯(cuò)路徑</td>
        <td th:text="${path}"></td>
    </tr>
    <tr>
        <td>出錯(cuò)時(shí)間</td>
        <td th:text="${timestamp}"></td>
    </tr>
    <tr>
        <td>錯(cuò)誤信息</td>
        <td th:text="${error}"></td>
    </tr>
    <tr>
        <td>狀態(tài)</td>
        <td th:text="${status}"></td>
    </tr>
</table>
</body>
</html>

當(dāng)我們?cè)趗rl地址請(qǐng)求一個(gè)不存在的頁(yè)面時(shí)觸發(fā)，

測(cè)試：

好了，到這里要開(kāi)始進(jìn)入正題。

由于我們的錯(cuò)誤是數(shù)學(xué)算術(shù)錯(cuò)誤，返回的是java.lang.ArithmeticException，這樣顯然是很難交代的。

首先SpringBoot為我們額外提供了三個(gè)異常信息。

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>5xx</title>
</head>
<body>
<div>這是動(dòng)態(tài)展示錯(cuò)誤的頁(yè)面：</div>
<table border="1">
    <tr>
        <td>出錯(cuò)路徑</td>
        <td th:text="${path}"></td>
    </tr>
    <tr>
        <td>出錯(cuò)時(shí)間</td>
        <td th:text="${timestamp}"></td>
    </tr>
    <tr>
        <td>錯(cuò)誤信息</td>
        <td th:text="${error}"></td>
    </tr>
    <tr>
        <td>狀態(tài)</td>
        <td th:text="${status}"></td>
    </tr>
    <tr>
        <td>異常</td>
        <td th:text="${exception}"></td>
    </tr>
    <tr>
        <td>堆棧</td>
        <td th:text="${trace}"></td>
    </tr>
    <tr>
        <td>異常信息</td>
        <td th:text="${message}"></td>
    </tr>
</table>
</body>
</html>

exception、trace和message。

假如我們配置完5xx.html便急著去測(cè)試，結(jié)果如下：

這三個(gè)東西結(jié)果為空，那么小伙伴們肯定很想知道這三個(gè)東西究竟顯示的是什么玩意兒。

別急，我們可以在application.properties中配置三個(gè)東西。

server.error.include-exception=true
server.error.include-message=always
server.error.include-stacktrace=always

這三個(gè)是什么東西呢，想深究的同學(xué)可以回去看看底層。從字面意思理解，便是開(kāi)啟這三個(gè)東西，默認(rèn)為不展示。

測(cè)試：

原本是測(cè)試顯示的是java.lang.ArithmeticException，在這里只需要進(jìn)行全局異常處理即可。

/**
 * 將該類注冊(cè)到 Spring 容器中，此時(shí)，默認(rèn)的 DefaultErrorAttributes 就會(huì)失效
 */
@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
        //這是默認(rèn)的異常數(shù)據(jù)
        Map<String, Object> map = super.getErrorAttributes(webRequest,options);
        //獲取異常
        String exception = (String) map.get("exception");
        if ("java.lang.ArithmeticException".equals(exception)){
            map.put("exception","數(shù)學(xué)算術(shù)異常");
        }
        return map;
    }
}

注意：狀態(tài)頁(yè)面先找精確，再找模糊，其次是先動(dòng)態(tài)后靜態(tài)。