SpringBoot系列教程web篇之全局異常處理

時間 2019-11-05

標籤 springboot 系列教程 web 全局異常處理欄目 Spring 简体版

原文原文鏈接

當咱們的後端應用出現異常時，一般會將異常情況包裝以後再返回給調用方或者前端，在實際的項目中，不可能對每個地方都作好異常處理，再優雅的代碼也可能拋出異常，那麼在 Spring 項目中，能夠怎樣優雅的處理這些異常呢?前端

本文將介紹一種全局異常處理方式，主要包括如下知識點java

@ControllerAdvice Controller 加強
@ExceptionHandler 異常捕獲
@ResponseStatus 返回狀態碼
NoHandlerFoundException 處理（404 異常捕獲）

右鍵查看原文: SpringBoot系列教程web篇之全局異常處理git

github

I. 環境搭建

首先得搭建一個 web 應用纔有可能繼續後續的測試，藉助 SpringBoot 搭建一個 web 應用屬於比較簡單的活;web

建立一個 maven 項目，pom 文件以下spring

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

依然是通常的流程，pom 依賴搞定以後，寫一個程序入口json

/**
 * Created by @author yihui in 15:26 19/9/13.
 */
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}

II. 異常處理

1. @ControllerAdvice

咱們一般利用@ControllerAdvice配合註解@ExceptionHandler來實現全局異常捕獲處理後端

@ControllerAdvice爲全部的 Controller 織入加強方法
@ExceptionHandler標記在方法上，表示當出現對應的異常拋出到上層時（即沒有被業務捕獲），這個方法會被觸發

下面咱們經過實例進行功能演示數組

a. 異常捕獲

咱們定義兩個異常捕獲的 case，一個是除 0，一個是數組越界異常websocket

@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {

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

    @ResponseBody
    @ExceptionHandler(value = ArithmeticException.class)
    public String handleArithmetic(HttpServletRequest request, HttpServletResponse response, ArithmeticException e)
            throws IOException {
        log.info("divide error!");
        return "divide 0: " + getThrowableStackInfo(e);
    }

    @ResponseBody
    @ExceptionHandler(value = ArrayIndexOutOfBoundsException.class)
    public String handleArrayIndexOutBounds(HttpServletRequest request, HttpServletResponse response,
            ArrayIndexOutOfBoundsException e) throws IOException {
        log.info("array index out error!");
        return "aryIndexOutOfBounds: " + getThrowableStackInfo(e);
    }
}

在上面的測試中，咱們將異常堆棧返回調用方

b. 示例服務

增長几個測試方法

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

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

    private int[] ans = new int[]{1, 2, 3, 4};

    @ResponseBody
    @GetMapping(path = "ary")
    public int ary(int index) {
        return ans[index];
    }
}

c. 測試說明

實例測試以下，上面咱們聲明捕獲的兩種異常被攔截並輸出對應的堆棧信息；

可是須要注意

404 和未捕獲的 500 異常則顯示的 SpringBoot 默認的錯誤頁面；
此外咱們捕獲返回的 http 狀態碼是 200

2. @ResponseStatus

上面的 case 中捕獲的異常返回的狀態碼是 200，可是在某些 case 中，可能更但願返回更合適的 http 狀態碼，此時可使用ResponseStatus來指定

使用方式比較簡單，加一個註解便可

@ResponseBody
@ExceptionHandler(value = ArithmeticException.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public String handleArithmetic(HttpServletRequest request, HttpServletResponse response, ArithmeticException e)
        throws IOException {
    log.info("divide error!");
    return "divide 0: " + getThrowableStackInfo(e);
}

3. 404 處理

經過@ControllerAdvice配合@ExceptionHandler能夠攔截 500 異常，若是我但願 404 異常也能夠攔截，能夠如何處理？

首先修改配置文件application.properties，將NoHandlerFoundException拋出來

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

其次是定義異常捕獲

@ResponseBody
@ExceptionHandler(value = NoHandlerFoundException.class)
@ResponseStatus(HttpStatus.NOT_FOUND)
public String handleNoHandlerError(NoHandlerFoundException e, HttpServletResponse response) {
    return "noHandlerFound: " + getThrowableStackInfo(e);
}

再次測試以下，404 被咱們捕獲並返回堆棧信息