SpringBoot自定義異常的處理方式

本篇內容主要講解“SpringBoot自定義異常的處理方式”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學習“SpringBoot自定義異常的處理方式”吧!

I. 環境搭建

首先得搭建一個web應用才有可能繼續后續的測試，借助SpringBoot搭建一個web應用屬于比較簡單的活;

創建一個maven項目，pom文件如下

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.7</version>
    <relativePath/> <!-- lookup parent from update -->
</parent>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    <java.version>1.8</java.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.45</version>
    </dependency>
</dependencies>

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </pluginManagement>
</build>
<repositories>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/milestone</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>

II. HandlerExceptionResolver

1. 自定義異常處理

HandlerExceptionResolver顧名思義，就是處理異常的類，接口就一個方法，出現異常之后的回調，四個參數中還攜帶了異常堆棧信息

@Nullable
ModelAndView resolveException(
		HttpServletRequest request, HttpServletResponse response, @Nullable Object handler, Exception ex);

我們自定義異常處理類就比較簡單了，實現上面的接口，然后將完整的堆棧返回給調用方

public class SelfExceptionHandler implements HandlerExceptionResolver {
    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler,
            Exception ex) {
        String msg = GlobalExceptionHandler.getThrowableStackInfo(ex);

        try {
            response.addHeader("Content-Type", "text/html; charset=UTF-8");
            response.getWriter().append("自定義異常處理!!! \n").append(msg).flush();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
}

// 堆棧信息打印方法如下
public static String getThrowableStackInfo(Throwable e) {
    ByteArrayOutputStream buf = new ByteArrayOutputStream();
    e.printStackTrace(new java.io.PrintWriter(buf, true));
    String msg = buf.toString();
    try {
        buf.close();
    } catch (Exception t) {
        return e.getMessage();
    }
    return msg;
}

仔細觀察上面的代碼實現，有下面幾個點需要注意

• 為了確保中文不會亂碼，我們設置了返回頭 response.addHeader("Content-Type", "text/html; charset=UTF-8"); 如果沒有這一行，會出現中文亂碼的情況

• 我們純后端應用，不想返回視圖，直接想Response的輸出流中寫入數據返回 response.getWriter().append("自定義異常處理!!! \n").append(msg).flush();； 如果項目中有自定義的錯誤頁面，可以通過返回ModelAndView來確定最終返回的錯誤頁面

• 上面一個代碼并不會直接生效，需要注冊，可以在WebMvcConfigurer的子類中實現注冊，實例如下

@SpringBootApplication
public class Application implements WebMvcConfigurer {
    @Override
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
        resolvers.add(0, new SelfExceptionHandler());
    }

    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}

2. 測試case

我們依然使用上篇博文的用例來測試

@Controller
@RequestMapping(path = "page")
public class ErrorPageRest {

    @ResponseBody
    @GetMapping(path = "divide")
    public int divide(int sub) {
        return 1000 / sub;
    }
}

下面分別是404異常和500異常的實測情況

500異常會進入我們的自定義異常處理類, 而404依然走的是默認的錯誤頁面，所以如果我們需要捕獲404異常，依然需要在配置文件中添加

# 出現錯誤時, 直接拋出異常
spring.mvc.throw-exception-if-no-handler-found=true
# 設置靜態資源映射訪問路徑
spring.mvc.static-path-pattern=/statics/**
# spring.resources.add-mappings=false

為什么404需要額外處理？

下面盡量以通俗易懂的方式說明下這個問題

• java web應用，除了返回json類數據之外還可能返回網頁，js，css

• 我們通過 @ResponseBody來表明一個url返回的是json數據（通常情況下是這樣的，不考慮自定義實現）

• 我們的@Controller中通過@RequestMapping定義的REST服務，返回的是靜態資源

• 那么js,css,圖片這些文件呢，在我們的web應用中并不會定義一個REST服務

• 所以當接收一個http請求，找不到url關聯映射時，默認場景下不認為這是一個NoHandlerFoundException，不拋異常，而是到靜態資源中去找了(靜態資源中也沒有，為啥不拋NoHandlerFoundException呢？這個異常表示這個url請求沒有對應的處理器，但是我們這里呢，給它分配到了靜態資源處理器了ResourceHttpRequestHandler)

針對上面這點，如果有興趣深挖的同學，這里給出關鍵代碼位置

// 進入方法： `org.springframework.web.servlet.DispatcherServlet#doDispatch`

// debug 節點
Determine handler for the current request.
mappedHandler = getHandler(processedRequest);
if (mappedHandler == null) {
	noHandlerFound(processedRequest, response);
	return;
}

// 核心邏輯
// org.springframework.web.servlet.DispatcherServlet#getHandler
@Nullable
protected HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {
	if (this.handlerMappings != null) {
		for (HandlerMapping hm : this.handlerMappings) {
			if (logger.isTraceEnabled()) {
				logger.trace(
						"Testing handler map [" + hm + "] in DispatcherServlet with name '" + getServletName() + "'");
			}
			HandlerExecutionChain handler = hm.getHandler(request);
			if (handler != null) {
				return handler;
			}
		}
	}
	return null;
}

到此，相信大家對“SpringBoot自定義異常的處理方式”有了更深的了解，不妨來實際操作一番吧！這里是億速云網站，更多相關內容可以進入相關頻道進行查詢，關注我們，繼續學習！