Spring Boot 如何自定義返回錯誤碼錯誤信息

說明

• 在實際的開發過程中,很多時候要定義符合自己業務的錯誤碼和錯誤信息，而不是統一的而不是統一的下面這種格式返回到調用端

INTERNAL_SERVER_ERROR(500, "Internal Server Error"),

下面我們來看看如何將我們自定義的錯誤碼和錯誤信息返回到調用端。

1 自定義錯誤碼

• 首先我們要定義一個枚舉類

public enum ErrorEnum {
	/*
	 * 錯誤信息
	 * */
	E_20011(20011, "缺少必填參數"),

	;

	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做參數
     */
    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調用返回結果為
  { "message": "缺少必填參數", "code": 20011 }