SpringBoot-@ControllerAdvice 攔截異常並統一處理

SpringBoot是爲了簡化Spring應用的建立、運行、調試、部署等一系列問題而誕生的產物，

自動裝配的特性讓咱們能夠更好的關注業務自己而不是外部的XML配置，咱們只需遵循規範，引入相關的依賴就能夠輕易的搭建出一個 WEB 工程

 

實際項目開發中，程序每每會發生各式各樣的異常狀況，特別是身爲服務端開發人員的咱們，

老是不停的編寫接口提供給前端調用，分工協做的狀況下，避免不了異常的發生，若是直接將錯誤的信息直接暴露給用戶，

這樣的體驗可想而知，且對黑客而言，詳細異常信息每每會提供很是大的幫助…

初窺異常

一個簡單的異常請求的接口

@GetMapping("/test1")
public String test1() {
    // 這裏只是模擬異常，假設業務處理的時候出現錯誤了，或者空指針了等等...
    int i = 10 / 0;
    return "test1";
}

打開瀏覽器訪問它的時候發現

又或者是用postman等模擬工具

若是這接口是給第三方調用或者是本身公司的系統，看到這種錯誤估計得暴走吧….

笨方法（極其不建議）

採用try-catch的方式，手動捕獲異常信息，而後返回對應的結果集，相信不少人都看到過相似的代碼（如：封裝成Result對象）；

該方法雖然間接性的解決錯誤暴露的問題，一樣的弊端也很明顯，增長了大量的代碼量，當異常過多的狀況下對應的catch層愈發的多了起來，

很難管理這些業務異常和錯誤碼之間的匹配，因此最好的方法就是經過簡單配置全局掌控….

@GetMapping("/test2")
public Map<String, String> test2() {
    Map<String, String> result = new HashMap<>(16);
    // TODO 直接捕獲全部代碼塊，而後在 cache
    try {
        int i = 10 / 0;
        result.put("code", "200");
        result.put("data", "具體返回的結果集");
    } catch (Exception e) {
        result.put("code", "500");
        result.put("message", "請求錯誤");
    }
    return result;
}

具體代碼

經過上面的閱讀你們也大體能瞭解到爲啥須要對異常進行全局捕獲了，接下來就看看Spring Boot提供的解決方案

導入依賴

在pom.xml中添加上spring-boot-starter-web的依賴便可

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

自定義異常

在應用開發過程當中，除系統自身的異常外，不一樣業務場景中用到的異常也不同，爲了與標題輕鬆搞定全局異常更加的貼切，定義個本身的異常，看看如何捕獲…

/**
 * 自定義異常
 */
public class CustomException extends RuntimeException {
    private static final long serialVersionUID = 4564124491192825748L;

    private int code;

    public CustomException() {
        super();
    }
    public CustomException(int code, String message) {
        super(message);
        this.setCode(code);
    }
    public int getCode() {
        return code;
    }
    public void setCode(int code) {
        this.code = code;
    }
}

異常信息模板

定義返回的異常信息的格式，這樣異常信息風格更爲統一

/**
 * 異常信息模板
 */
public class ErrorResponseEntity {

    private int code;
    private String message;

    public ErrorResponseEntity(int code, String message) {
        this.code = code;
        this.message = message;
    }
    // 省略 get/set
}

控制層

仔細一看是否是和平時正常寫的代碼沒啥區別，不要急，接着看….

import com.winterchen.exception.CustomException;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ExceptionController {

    @GetMapping("/test3")
    public String test3(Integer num) {
        // TODO 演示須要，實際上參數是否爲空經過 @RequestParam(required = true)  就能夠控制
        if (num == null) {
            throw new CustomException(400, "num不能爲空");
        }
        int i = 10 / num;
        return "result:" + i;
    }
}

異常處理（關鍵）

註解概述

• @ControllerAdvice捕獲Controller層拋出的<wiz_tmp_highlight_tag class="cm-searching">異常，若是添加@ResponseBody返回信息則爲JSON格式。
• @RestControllerAdvice至關於@ControllerAdvice與@ResponseBody的結合體。
• @ExceptionHandler統一處理一種類的<wiz_tmp_highlight_tag class="cm-searching">異常，減小代碼重複率，下降複雜度。

建立一個GlobalExceptionHandler類，並添加上@RestControllerAdvice註解就能夠定義出異常通知類了，而後在定義的方法中添加上@ExceptionHandler便可實現異常的捕捉…

import com.winterchen.exception.CustomException;
import com.winterchen.exception.ErrorResponseEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * 全局異常處理
 */
@RestControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    /**
     * 定義要捕獲的異常 能夠多個 @ExceptionHandler({})
     * @param request  request
     * @param e        exception
     * @param response response
     * @return 響應結果
     */
    @ExceptionHandler(CustomException.class)
    public ErrorResponseEntity customExceptionHandler(HttpServletRequest request, final Exception e, HttpServletResponse response) {
        response.setStatus(HttpStatus.BAD_REQUEST.value());
        CustomException exception = (CustomException) e;
        return new ErrorResponseEntity(exception.getCode(), exception.getMessage());
    }

    /**
     * 捕獲  RuntimeException 異常
     * 若是你以爲在一個 exceptionHandler 經過  if (e instanceof xxxException) 太麻煩
     * 那麼你還能夠本身寫多個不一樣的 exceptionHandler 處理不一樣異常
     * @param request  request
     * @param e        exception
     * @param response response
     * @return 響應結果
     */
    @ExceptionHandler(RuntimeException.class)
    public ErrorResponseEntity runtimeExceptionHandler(HttpServletRequest request, final Exception e, HttpServletResponse response) {
        response.setStatus(HttpStatus.BAD_REQUEST.value());
        RuntimeException exception = (RuntimeException) e;
        return new ErrorResponseEntity(400, exception.getMessage());
    }

    /**
     * 通用的接口映射異常處理方
     */
    @Override
    protected ResponseEntity<Object> handleExceptionInternal(Exception ex, Object body, HttpHeaders headers, HttpStatus status, WebRequest request) {
        if (ex instanceof MethodArgumentNotValidException) {
            MethodArgumentNotValidException exception = (MethodArgumentNotValidException) ex;
            return new ResponseEntity<>(new ErrorResponseEntity(status.value(), exception.getBindingResult().getAllErrors().get(0).getDefaultMessage()), status);
        }
        if (ex instanceof MethodArgumentTypeMismatchException) {
            MethodArgumentTypeMismatchException exception = (MethodArgumentTypeMismatchException) ex;
            logger.error("參數轉換失敗，方法：" + exception.getParameter().getMethod().getName() + "，參數：" + exception.getName()
                    + ",信息：" + exception.getLocalizedMessage());
            return new ResponseEntity<>(new ErrorResponseEntity(status.value(), "參數轉換失敗"), status);
        }
        return new ResponseEntity<>(new ErrorResponseEntity(status.value(), "參數轉換失敗"), status);
    }
}

主函數

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SpringBootExceptionApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBootExceptionApplication.class, args);
    }
}

測試

完成準備事項後，啓動Chapter17Application，經過下面的測試結果能夠發現，真的是so easy，代碼變得整潔了，擴展性也變好了…

訪問http://localhost:8080/test3

{"code":400,"message":"num不能爲空"}

訪問http://localhost:8080/test3?num=0

{"code":400,"message":"/ by zero"}

訪問http://localhost:8080/test3?num=5

result:2

 

轉載連接：http://blog.battcn.com/2018/06/01/springboot/v2-other-exception/