SpringBoot使用統(tǒng)一異常處理詳解

更新時間：2019年05月06日 11:24:14 作者：simonsfan

這篇文章主要為大家詳細介紹了SpringBoot使用統(tǒng)一異常處理，具有一定的參考價值，感興趣的小伙伴們可以參考一下

場景：針對異常處理，我們原來的做法是一般在最外層捕獲異常即可，例如在Controller中

@Controller
public class HelloController {
 
  private static final Logger logger = LoggerFactory.getLogger(HelloController.class);
 
  @GetMapping(value = "/hello")
  @ResponseBody
  public Result hello() {
    try {
      //TODO 具體的邏輯省略……
    } catch (Exception e) {
      logger.error("hello接口異常={}", e);
      return ResultUtil.success(-1, "system error", null);
    }
    return ResultUtil.success(0, "success", null);
  }
}

這樣的話也能解決部分問題，但是無法獲取到自己指定的異常，引入全局統(tǒng)一異常處理的話將會極大的改善代碼，減少冗余代碼的產(chǎn)生。

自定義異常類:注意要繼承自RuntimeException而不是Exception，繼承自Exception的話，當拋出自定義異常時spring事務不會回滾

public class GlobalException extends RuntimeException {
 
  private Integer code; //因為我需要將異常信息也返回給接口中，所以添加code區(qū)分
 
  public GlobalException(Integer code,String message) {
    super(message);  //把自定義的message傳遞個異常父類
    this.code = code;
  }
 
  public Integer getCode() {
    return code;
  }
 
  public void setCode(Integer code) {
    this.code = code;
  }
}

自定義統(tǒng)一異常處理器:比較關鍵的兩個注解@ControllerAdvice、@ExceptionHandler

@ControllerAdvice
public class ExceptionHandle {
 
  @ResponseBody  //因為我需要將拋出的異常返回給接口，所以加上此注解
  @ExceptionHandler
  public Result handle(Exception e) {
    if (e instanceof GlobalException) {
      GlobalException ge = (GlobalException) e;
      return ResultUtil.success1(ge.getCode(), ge.getMessage());
    }
    return ResultUtil.success1(-1, "system error!");
  }
 
}

寫個測試類測試下

@GetMapping(value = "/hello1")
@ResponseBody
public Result hello(@RequestParam(value = "age", defaultValue = "50", required = false) Integer age) throws GlobalException {
  if (age < 10) {
    throw new GlobalException(ConstantEnum.LESS10.getCode(), ConstantEnum.LESS10.getMsg());
  } else if (age > 50) {
    throw new GlobalException(ConstantEnum.MORE50.getCode(), ConstantEnum.MORE50.getMsg());
  } else {
    return ResultUtil.success1(0, "success");
  }
}

把code、message封裝在了ConstantEnum枚舉里面，方便統(tǒng)一維護

public enum ConstantEnum {
 
  ERROR(-1, "system error!"),
  SUCCESS(100, "success"),
  LESS10(101, "自定義異常信息-我小于10歲"),
  MORE50(5001, "自定義異常信息-我大于50歲");
 
  private Integer code;
  private String msg;
 
  public Integer getCode() {
    return code;
  }
 
  public String getMsg() {
    return msg;
  }
 
  ConstantEnum(Integer code, String msg) {
    this.code = code;
    this.msg = msg;
  }
}