前言:
在實際的應用開發中,很多時候往往因為一些不可控的因素導致程序出現一些錯誤,這個時候就要及時把異常信息反饋給客戶端,便于客戶端能夠及時地進行處理,而針對代碼導致的異常,我們一般有兩種處理方式,一種是throws直接拋出,一種是使用try..catch捕獲,一般的話,如果邏輯的異常,需要知道異常信息,我們往往選擇將異常拋出,如果只是要保證程序在出錯的情況下 依然可以繼續運行,則使用try..catch來捕獲。
但是try..catch會導致代碼量的增加,讓后期我們的代碼變得臃腫且難以維護。當然,springboot作為一個如此優秀的框架,肯定不會坐視不管的,通過springboot自帶的注解,我們可以方便的自定義我們的全局異常處理器,并且以json格式返回給我們的客戶端。
代碼實戰:
捕獲全局異常:
首先呢,我們新建我們負責全局異常捕捉處理的類: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層面發生的異常。如果需要掃描自定路徑下的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";
}
}
結果:
{"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());
//其他業務代碼...
return map;
}
測試:
@GetMapping("/test1")
public String test1(){
String name = null;
if(name == null){
throw new MyException("101","用戶名為空");
}
return "Hello World";
}
輸出:
{"msg":"用戶名為空","code":"101"}
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持億速云。
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。