快捷導(dǎo)航

Springboot之自定義全局異常處理的實現(xiàn)

更新時間：2019年08月28日 14:07:42 作者：韓數(shù)

這篇文章主要介紹了Springboot之自定義全局異常處理的實現(xiàn),文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

前言：

在實際的應(yīng)用開發(fā)中，很多時候往往因為一些不可控的因素導(dǎo)致程序出現(xiàn)一些錯誤，這個時候就要及時把異常信息反饋給客戶端，便于客戶端能夠及時地進行處理，而針對代碼導(dǎo)致的異常，我們一般有兩種處理方式，一種是throws直接拋出，一種是使用try..catch捕獲，一般的話，如果邏輯的異常，需要知道異常信息，我們往往選擇將異常拋出，如果只是要保證程序在出錯的情況下依然可以繼續(xù)運行，則使用try..catch來捕獲。

但是try..catch會導(dǎo)致代碼量的增加,讓后期我們的代碼變得臃腫且難以維護。當然，springboot作為一個如此優(yōu)秀的框架，肯定不會坐視不管的，通過springboot自帶的注解，我們可以方便的自定義我們的全局異常處理器，并且以json格式返回給我們的客戶端。

代碼實戰(zhàn)：

捕獲全局異常：

首先呢，我們新建我們負責全局異常捕捉處理的類:MyControllerAdvice，代碼如下:

@ControllerAdvice
public class MyControllerAdvice {


  @ResponseBody
  @ExceptionHandler(value = Exception.class)
  public Map<String,Object> exceptionHandler(Exception ex){
    Map<String,Object> map = new HashMap<String,Object>();
    map.put("code",100);
    map.put("msg",ex.getMessage());
    //這里可以加上我們其他的異常處理代碼，比如日志記錄，，，
    return map;
  }

}

注解說明：
@ControllerAdvice 通過AOP的方式配合@ExceptionHandler()注解捕獲在Controller層面發(fā)生的異常。如果需要掃描自定路徑下的Controller，添加basePackages屬性

@ControllerAdvice(basePackages ="com.example.demo.controller")

@RestControllerAdvice : 和@ControllerAdvice作用相同，可以理解為 @ResponseBody+@ControllerAdvice 的組合使用。

@ExceptionHandler()：該注解作用主要在于聲明一個或多個類型的異常，當符合條件的Controller拋出這些異常之后將會對這些異常進行捕獲，然后按照其標注的方法的邏輯進行處理，從而改變返回的視圖信息。

測試：

@RestController
public class UserController {


  @GetMapping("/test")
  public String test(){
    int num = 1/0;
    return "Hello World";
  }
}

結(jié)果：

{"msg":"/ by zero","code":100}

捕獲自定義異常：

自定義我們的異常信息類MyException 并繼承RuntimeException：

public class MyException extends RuntimeException {

  private String errorCode;
  private String errorMsg;

  public MyException(String errorCode, String errorMsg) {
    this.errorCode = errorCode;
    this.errorMsg = errorMsg;
  }


  public String getErrorCode() {
    return errorCode;
  }

  public void setErrorCode(String errorCode) {
    this.errorCode = errorCode;
  }

  public String getErrorMsg() {
    return errorMsg;
  }

  public void setErrorMsg(String errorMsg) {
    this.errorMsg = errorMsg;
  }
  
}

修改我們的MyControllerAdvice，將MyException添加進去：

  @ResponseBody
  @ExceptionHandler(value = MyException.class)
  public Map<String,Object> myExceptionHandler(MyException mex){
    Map<String,Object> map = new HashMap<String,Object>();
    map.put("code",mex.getErrorCode());
    map.put("msg",mex.getErrorMsg());
    //其他業(yè)務(wù)代碼...
    return map;
  }

測試：

  @GetMapping("/test1")
  public String test1(){
    String name = null;
    if(name == null){
      throw new MyException("101","用戶名為空");
    }
    return "Hello World";
  }

輸出：