說明

在實(shí)際的開發(fā)過程中,很多時候要定義符合自己業(yè)務(wù)的錯誤碼和錯誤信息，而不是統(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 定義一個異常返回的模板類

模板類定義了如何將異常通過什么形式進(jìn)行返回。

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)用返回結(jié)果為

{ "message": "缺少必填參數(shù)", "code": 20011 }

總結(jié)

以上是生活随笔為你收集整理的java异常自定义返回信息,Spring Boot 如何自定义返回错误码错误信息的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。