springboot框架的全局異常處理方案詳解
更新時間：2021年03月12日 14:27:58 作者：一起隨緣
這篇文章主要介紹了springboot框架的全局異常處理方案,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
系統(tǒng)框架搭建的前期過程中，為了約束代碼規(guī)范，我們會對一些通用功能做一些處理，比如聲明一些系統(tǒng)公用錯誤類、封裝通用返回結果、統(tǒng)一異常處理等，這樣做的優(yōu)勢是團隊開發(fā)過程中能夠形成統(tǒng)一的代碼規(guī)范，增強代碼可讀性，同時又便于后期代碼維護。本文主要介紹下框架中異常的處理：
1.聲明全局異常處理類，并添加@ControllerAdvice和@RestController注解
代碼如下：
@ControllerAdvice
@RestController
public class GlobalExceptionHandler {
private final Logger logger = Logger.getLogger(GlobalExceptionHandler.class);
//空指針異常
@ExceptionHandler(NullPointerException.class)
public Map<String, Object> nullPointer(NullPointerException e,HttpServletRequest req){
logger.error(e.getMessage());
e.printStackTrace();
return ResultObject.newResultObj(ErrorCode.NULLPOINTER);
}
//IO異常
@ExceptionHandler(IOException.class,HttpServletRequest req, HttpServletResponse res)
public Map<String, Object> IOException(IOException e){
logger.error(e.getMessage());
e.printStackTrace();
return ResultObject.newResultObj(ErrorCode.IOEXCEPTION);
}
//權限不足異常
@ExceptionHandler(UnauthorizedException.class)
public Map<String, Object> unauth(HttpServletRequest req, HttpServletResponse res){
return ResultObject.newResultObj(ErrorCode.UNAUTH);
}
//未登錄異常
@ExceptionHandler(AuthorizationException.class)
public Map<String, Object> unlogin(HttpServletRequest req, HttpServletResponse res){
return ResultObject.newResultObj(ErrorCode.NOTLOGIN);
}
//其它異常
@ExceptionHandler(Exception.class)
public Map<String, Object> error(Exception e,HttpServletRequest req, HttpServletResponse res){
logger.error(e.getMessage());
e.printStackTrace();
return ResultObject.newResultObj(ErrorCode.SYSTEM);
}
}
2.聲明系統(tǒng)通用錯誤處理類
/**
* 系統(tǒng)通用錯誤處理類
*/
public class ErrorCode {
//返回碼
private int code = 0;
//描述信息
private String errmsg = "SUCCESS";
//成功
public static final ErrorCode SUCCESS = new ErrorCode(0,"SUCCESS");
public static final ErrorCode PARAMS = new ErrorCode(100000,"參數(shù)錯誤");
public static final ErrorCode SYSTEM = new ErrorCode(100001,"系統(tǒng)錯誤");
public static final ErrorCode UNLOGIN = new ErrorCode(100002,"未登錄");
public static final ErrorCode UNAUTH = new ErrorCode(100003,"權限錯誤");
public static final ErrorCode NULLPOINTER = new ErrorCode(100004,"空指針錯誤");
public static final ErrorCode IOEXCEPTION = new ErrorCode(100005,"IO錯誤");
public static final ErrorCode UPLOAD_FAIL = new ErrorCode(100006,"文件上傳失敗");
public static final ErrorCode REPEAT = new ErrorCode(100007,"數(shù)據已存在");
public ErrorCode() {}
@Override
public String toString() {
return String.format("{\"errmsg\": \"%s\", \"code\": %d}", errmsg, code);
}
public int getCode() {
return code;
}
public ErrorCode setCode(int code) {
this.code = code;
return this;
}
public String getErrmsg() {
return errmsg;
}
public ErrorCode setErrmsg(String errmsg) {
this.errmsg = errmsg;
return this;
}
public ErrorCode(int code, String errmsg) {
this.code = code;
this.errmsg = errmsg;
}
}
3.聲明全局異常處理類中的結果返回類
import java.util.HashMap;
import java.util.Map;
import javax.servlet.http.HttpServletResponse;
import com.xxx.ErrorCode;//此處引用自己errorCode類所在的包路徑
import org.json.JSONObject;
public class ResultObject {
/**
* 輸出錯誤信息
* @param errorCode
*/
public static Map<String, Object> newResultObj(ErrorCode errorCode){
Map<String, Object> obj = new HashMap<String, Object>();
obj.put("code", errorCode.getCode());
obj.put("errmsg", errorCode.getErrmsg());
return obj;
}
/**
* 輸出帶數(shù)據的成功信息
* @param data
*/
public static Map<String, Object> newResultObj(Object data){
Map<String, Object> obj = new HashMap<String, Object>();
obj.put("code", ErrorCode.SUCCESS.getCode());
obj.put("errmsg", ErrorCode.SUCCESS.getErrmsg());
if(null != data){
obj.put("data", data);
}
return obj;
}
/**
* 輸出帶數(shù)據的錯誤信息
* @param errorCode
* @param data
*/
public static Map<String, Object> newResultObj(ErrorCode errorCode, Object data){
Map<String, Object> obj = new HashMap<String, Object>();
obj.put("code", errorCode.getCode());
obj.put("errmsg", errorCode.getErrmsg());
if(null != data){
obj.put("data", data);
}
return obj;
}
/**
* 輸出結果
*/
public static void outputResult(HttpServletResponse response, ErrorCode errorCode){
try {
JSONObject json = new JSONObject();
json.put("code", errorCode.getCode());
json.put("errmsg", errorCode.getErrmsg());
response.setCharacterEncoding("UTF-8");
response.setContentType("application/json;charset=UTF-8");
response.getWriter().write(json.toString());
} catch (Exception e1) {
}
}
}
到此這篇關于springboot框架的全局異常處理方案的文章就介紹到這了,更多相關springboot全局異常處理內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
springboot結合redis實現(xiàn)搜索欄熱搜功能及文字過濾
本文主要介紹了springboot結合redis實現(xiàn)搜索欄熱搜功能及文字過濾，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-02-02
這篇文章主要介紹了Maven構建忽略測試失敗的解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-03-03
這篇文章主要介紹了Java解壓rar文件的兩種實現(xiàn)方法,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-06-06
在剛開始學習Java的時候，就了解了Java基礎中的變量，雖然知道這個以后會經常用到，但沒想到了基本語法這里，竟然又冒出來了成員變量和局部變量。變來變去太容易讓人搞暈了，今天我們就挑揀出來梳理一下！2016-07-07
這篇文章主要為大家詳細介紹了java+mysql實現(xiàn)登錄和注冊功能，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-04-04
大趨勢下目前很多的項目都采用了前后端分離的方式進行開發(fā),最近我接觸到的項目大多數(shù)都是采用了前后端分離的方式進行開發(fā),下面這篇文章主要給大家介紹了關于springboot項目中使用Swagger的簡單示例,需要的朋友可以參考下2023-04-04
下面給大家解析字符串連接方面的知識，包括string，stringbuffer和stringbuilder等方面的知識，對java字符串知識感興趣的朋友一起學習吧2016-12-12
這篇文章主要介紹了解決Java?API不能遠程訪問HBase的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-06-06
這篇文章主要介紹了java異常處理詳細介紹及實例的相關資料,本文對java異常進行了知識層次的總結，需要的朋友可以參考下2017-04-04
JAVA不可變類(immutable)機制與String的不可變性(推薦)
這篇文章主要介紹了JAVA不可變類(immutable)機制與String的不可變性(推薦)的相關資料,非常不錯，具有參考借鑒價值，需要的朋友可以參考下2016-08-08