SpringBoot自定義異常的處理方式

本篇內(nèi)容主要講解“SpringBoot自定義異常的處理方式”，感興趣的朋友不妨來(lái)看看。本文介紹的方法操作簡(jiǎn)單快捷，實(shí)用性強(qiáng)。下面就讓小編來(lái)帶大家學(xué)習(xí)“SpringBoot自定義異常的處理方式”吧!

I. 環(huán)境搭建

首先得搭建一個(gè)web應(yīng)用才有可能繼續(xù)后續(xù)的測(cè)試，借助SpringBoot搭建一個(gè)web應(yīng)用屬于比較簡(jiǎn)單的活;

創(chuàng)建一個(gè)maven項(xiàng)目，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顧名思義，就是處理異常的類，接口就一個(gè)方法，出現(xiàn)異常之后的回調(diào)，四個(gè)參數(shù)中還攜帶了異常堆棧信息

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

我們自定義異常處理類就比較簡(jiǎn)單了，實(shí)現(xiàn)上面的接口，然后將完整的堆棧返回給調(diào)用方

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;
}

仔細(xì)觀察上面的代碼實(shí)現(xiàn)，有下面幾個(gè)點(diǎn)需要注意

• 為了確保中文不會(huì)亂碼，我們?cè)O(shè)置了返回頭 response.addHeader("Content-Type", "text/html; charset=UTF-8"); 如果沒(méi)有這一行，會(huì)出現(xiàn)中文亂碼的情況

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

• 上面一個(gè)代碼并不會(huì)直接生效，需要注冊(cè)，可以在WebMvcConfigurer的子類中實(shí)現(xiàn)注冊(cè)，實(shí)例如下

@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. 測(cè)試case

我們依然使用上篇博文的用例來(lái)測(cè)試

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

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

下面分別是404異常和500異常的實(shí)測(cè)情況

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

# 出現(xiàn)錯(cuò)誤時(shí), 直接拋出異常
spring.mvc.throw-exception-if-no-handler-found=true
# 設(shè)置靜態(tài)資源映射訪問(wèn)路徑
spring.mvc.static-path-pattern=/statics/**
# spring.resources.add-mappings=false

為什么404需要額外處理？

下面盡量以通俗易懂的方式說(shuō)明下這個(gè)問(wèn)題

• java web應(yīng)用，除了返回json類數(shù)據(jù)之外還可能返回網(wǎng)頁(yè)，js，css

• 我們通過(guò) @ResponseBody來(lái)表明一個(gè)url返回的是json數(shù)據(jù)（通常情況下是這樣的，不考慮自定義實(shí)現(xiàn)）

• 我們的@Controller中通過(guò)@RequestMapping定義的REST服務(wù)，返回的是靜態(tài)資源

• 那么js,css,圖片這些文件呢，在我們的web應(yīng)用中并不會(huì)定義一個(gè)REST服務(wù)

• 所以當(dāng)接收一個(gè)http請(qǐng)求，找不到url關(guān)聯(lián)映射時(shí)，默認(rèn)場(chǎng)景下不認(rèn)為這是一個(gè)NoHandlerFoundException，不拋異常，而是到靜態(tài)資源中去找了(靜態(tài)資源中也沒(méi)有，為啥不拋NoHandlerFoundException呢？這個(gè)異常表示這個(gè)url請(qǐng)求沒(méi)有對(duì)應(yīng)的處理器，但是我們這里呢，給它分配到了靜態(tài)資源處理器了ResourceHttpRequestHandler)

針對(duì)上面這點(diǎn)，如果有興趣深挖的同學(xué)，這里給出關(guān)鍵代碼位置

// 進(jìn)入方法： `org.springframework.web.servlet.DispatcherServlet#doDispatch`

// debug 節(jié)點(diǎn)
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;
}

到此，相信大家對(duì)“SpringBoot自定義異常的處理方式”有了更深的了解，不妨來(lái)實(shí)際操作一番吧！這里是億速云網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！