Spring Boot 如何自定義返回錯誤碼錯誤信息
更新時間：2019年08月13日 10:18:58 作者：小魚兒_karl
這篇文章主要介紹了Spring Boot 如何自定義返回錯誤碼錯誤信息的相關知識，非常不錯，具有一定的參考借鑒價值,需要的朋友可以參考下
說明
•在實際的開發(fā)過程中,很多時候要定義符合自己業(yè)務的錯誤碼和錯誤信息，而不是統(tǒng)一的而不是統(tǒng)一的下面這種格式返回到調(diào)用端
INTERNAL_SERVER_ERROR(500, "Internal Server Error"),
下面我們來看看如何將我們自定義的錯誤碼和錯誤信息返回到調(diào)用端。
1 自定義錯誤碼
•首先我們要定義一個枚舉類
public enum ErrorEnum {
/*
* 錯誤信息
* */
E_20011(20011, "缺少必填參數(shù)"),
;
private Integer errorCode;
private String errorMsg;
ErrorEnum(Integer errorCode, String errorMsg) {
this.errorCode = errorCode;
this.errorMsg = errorMsg;
}
public Integer getErrorCode() {
return errorCode;
}
public String getErrorMsg() {
return errorMsg;
}
2 定義一個異常類
•定義一個異常類繼承RuntimeException類
public class BusinessException extends RuntimeException {
private static final long serialVersionUID = 1L;
private Integer code;
/**
* @param errorEnum 以錯誤的ErrorEnum做參數(shù)
*/
public BusinessException(ErrorEnum errorEnum) {
super(errorEnum.getErrorMsg());
this.code = errorEnum.getErrorCode();
this.resultJson = CommonUtil.errorJson(errorEnum);
}
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
}
3 定義一個異常返回的模板類
•模板類定義了如何將異常通過什么形式進行返回。
public class ExceptionResponse {
private String message;
private Integer code;
public ExceptionResponse(Integer code, String message) {
this.message = message;
this.code = code;
}
public static ExceptionResponse create(Integer code, String message) {
return new ExceptionResponse(code, message);
}
public Integer getCode() {
return code;
}
public String getMessage() {
return message;
}
}
4 定義全局處理 Controller 層異常
@ControllerAdvice
@Slf4j
public class ExceptionHandler {
@ResponseBody
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler(Exception.class)
public ExceptionResponse handleException(Exception ex) {
if (ex instanceof BusinessException) {
log.warn(ex.getMessage(), ex);
BusinessException businessException = (BusinessException) ex;
return ExceptionResponse.create(businessException.getCode(), businessException.getMessage());
} else {
log.error(ex.getMessage(), ex);
return ExceptionResponse.create(HttpStatus.INTERNAL_SERVER_ERROR.value(), ex.getMessage());
}
}
}
5 演示效果
•定義Controller層
@PostMapping("test/exception")
public String testException() {
throw new BusinessException(ErrorEnum.E_20011);
}
•通過postMan調(diào)用返回結果為
{ "message": "缺少必填參數(shù)", "code": 20011 }
總結
以上所述是小編給大家介紹的Spring Boot 如何自定義返回錯誤碼錯誤信息 ,希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持！
如果你覺得本文對你有幫助，歡迎轉載，煩請注明出處，謝謝！
相關文章
SpringBoot整合RocketMQ實現(xiàn)發(fā)送同步消息
RocketMQ 是一款開源的分布式消息中間件,由阿里巴巴開源,它具有高可用性、高性能、低延遲等特點,廣泛應用于阿里巴巴集團內(nèi)部以及眾多外部企業(yè)的業(yè)務系統(tǒng)中,本文給大家介紹了SpringBoot整合RocketMQ實現(xiàn)發(fā)送同步消息,需要的朋友可以參考下2024-04-04
這篇文章主要介紹了Maven的安裝+配置本地倉庫路徑方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-09-09
這篇文章主要介紹了java 序列化與反序列化的實例詳解的相關資料,需要的朋友可以參考下2017-07-07
這篇文章主要為大家詳細介紹了Spring注入值到Bean的三種方式，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-07-07
使用springboot 獲取控制器參數(shù)的幾種方法小結
這篇文章主要介紹了使用springboot 獲取控制器參數(shù)的幾種方法小結，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-12-12
java8之后，常用的Map接口中添加了一些非常實用的函數(shù)，可以大大簡化一些特定場景的代碼編寫，提升代碼可讀性，快跟隨小編一起來看看吧2022-11-11
使用maven整合Spring+SpringMVC+Mybatis框架詳細步驟(圖文)
這篇文章主要介紹了使用maven整合Spring+SpringMVC+Mybatis框架詳細步驟(圖文)，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2019-05-05
這篇文章主要為大家介紹了關于分布式的面試問題，分布式鎖的實現(xiàn)及應用不同場景下的使用，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步2022-03-03
這篇文章主要給大家介紹了關于Java判斷一個實體是不是空的簡單方法,實際項目中我們會有很多地方需要判空校驗,文中給出了詳細的示例代碼,需要的朋友可以參考下2023-07-07
這篇文章主要介紹了Java 線程優(yōu)先級詳解及實例的相關資料,需要的朋友可以參考下2017-04-04