EurekaUser-返回型別和全域性異常

阿新 • • 發佈：2021-07-14

在專案裡面加入統一的返回資訊和異常處理

新建檔案如下

public interface BaseErrorInfoInterface {
    /**
     * 錯誤碼
     */
    String getResultCode();

    /**
     * 錯誤描述
     */
    String getResultMsg();
}

public enum CommonEnum implements BaseErrorInfoInterface {

    // 資料操作錯誤定義
    BODY_NOT_MATCH("400", "請求的資料格式不符!"),
    SIGNATURE_NOT_MATCH( 
"401", "請求的數字簽名不匹配!"),
    NOT_FOUND("404", "未找到該資源!"),
    INTERNAL_SERVER_ERROR("500", "伺服器內部錯誤!"),
    SERVER_BUSY("503", "伺服器正忙，請稍後再試!");

    /**
     * 錯誤碼
     */
    private String resultCode;

    /**
     * 錯誤描述
     */
    private String resultMsg;

    CommonEnum(String resultCode, String resultMsg) {
         
this.resultCode = resultCode;
        this.resultMsg = resultMsg;
    }

    @Override
    public String getResultCode() {
        return resultCode;
    }

    @Override
    public String getResultMsg() {
        return resultMsg;
    }
}

public class BizException extends RuntimeException{
    private 
 static final long serialVersionUID = 1L;

    /**
     * 錯誤碼
     */
    protected String errorCode;
    /**
     * 錯誤資訊
     */
    protected String errorMsg;

    public BizException() {
        super();
    }

    public BizException(BaseErrorInfoInterface errorInfoInterface) {
        super(errorInfoInterface.getResultCode());
        this.errorCode = errorInfoInterface.getResultCode();
        this.errorMsg = errorInfoInterface.getResultMsg();
    }

    public BizException(BaseErrorInfoInterface errorInfoInterface, Throwable cause) {
        super(errorInfoInterface.getResultCode(), cause);
        this.errorCode = errorInfoInterface.getResultCode();
        this.errorMsg = errorInfoInterface.getResultMsg();
    }

    public BizException(String errorMsg) {
        super(errorMsg);
        this.errorMsg = errorMsg;
    }

    public BizException(String errorCode, String errorMsg) {
        super(errorCode);
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }

    public BizException(String errorCode, String errorMsg, Throwable cause) {
        super(errorCode, cause);
        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;
    }

    public String getMessage() {
        return errorMsg;
    }

    @Override
    public Throwable fillInStackTrace() {
        return this;
    }

}

@ControllerAdvice
public class GlobalExceptionHandler {

    private Logger logger = LoggerFactory.getLogger(this.getClass());

    /**
     * 處理自定義的業務異常
     *
     * @param req
     * @param e
     * @return
     */
    @ExceptionHandler(value = BizException.class)
    @ResponseBody
    public BasicResult bizExceptionHandler(HttpServletRequest req, BizException e) {
        logger.error("發生業務異常e:{}", e.getMessage());
        return BasicResult.fail(e.getErrorCode(), e.getErrorMsg());
    }

    /**
     * 處理空指標的異常
     *
     * @param req
     * @param e
     * @return
     */
    @ExceptionHandler(value = NullPointerException.class)
    @ResponseBody
    public BasicResult exceptionHandler(HttpServletRequest req, NullPointerException e) {
        logger.error("發生空指標異常e:{}", e.getMessage());
        return BasicResult.fail(e.getMessage());
    }

    /**
     * 處理其他異常
     *
     * @param req
     * @param e
     * @return
     */
    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public BasicResult exceptionHandler(HttpServletRequest req, Exception e) {
        logger.error("未知異常e:{}", e.getMessage());
        return BasicResult.fail(e.getMessage());
    }

    /**
     * 處理所有介面資料驗證異常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public BasicResult handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        logger.error("資料繫結異常e:{}", e.getMessage());
        return BasicResult.fail(e.getMessage());
    }

    /**
     * 請求型別異常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
    @ResponseBody
    public BasicResult httpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) {
        logger.error("請求型別異常e:{}", e.getMessage());
        return BasicResult.fail(e.getMessage());
    }

    /**
     * 資料繫結異常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(MissingServletRequestParameterException.class)
    @ResponseBody
    public BasicResult missingServletRequestParameterException(MissingServletRequestParameterException e) {
        logger.error("資料繫結異常e:{}", e.getMessage());
        return BasicResult.fail(CommonEnum.BODY_NOT_MATCH.getResultMsg());
    }
}

public class BasicResult<T> {

    private T data;
    private Long total;
    public Boolean success;

    /**
     * 返回狀態碼
     */
    private String code;
    /**
     * 返回訊息
     */
    private String message;
    /**
     * 異常堆疊
     */
    private String fullStackTrace;

    private final static String SUCCESS_CODE = "0";
    private final static String DEFAULT_FAIL_CODE = "-1";

    public Boolean getSuccess() {
        return success;
    }

    public void setSuccess(Boolean success) {
        this.success = success;
    }

    public boolean isSuccess() {
        return Objects.equals(BasicResult.SUCCESS_CODE, this.code);
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public String getFullStackTrace() {
        return fullStackTrace;
    }

    public void setFullStackTrace(String fullStackTrace) {
        this.fullStackTrace = fullStackTrace;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    public Long getTotal() {
        return total;
    }

    public void setTotal(Long total) {
        this.total = total;
    }


    /**
     * 成功
     *
     * @return
     */
    public static BasicResult success() {
        BasicResult basicResult = new BasicResult();
        basicResult.setCode(SUCCESS_CODE);
        return basicResult;
    }

    /**
     * 成功
     *
     * @param data
     * @param <T>
     * @return
     */
    public static <T> BasicResult<T> success(T data) {
        BasicResult<T> basicResult = new BasicResult<>();
        basicResult.setCode(SUCCESS_CODE);
        basicResult.setData(data);
        return basicResult;
    }

    /**
     * 成功
     *
     * @param data
     * @param message
     * @param <T>
     * @return
     */
    public static <T> BasicResult<T> success(T data, String message) {
        BasicResult<T> basicResult = new BasicResult<>();
        basicResult.setCode(SUCCESS_CODE);
        basicResult.setMessage(message);
        basicResult.setData(data);
        return basicResult;
    }

    /**
     * 成功
     *
     * @param data
     * @param <T>
     * @return
     */
    public static <T> BasicResult<T> success(T data, long total) {
        BasicResult<T> basicResult = new BasicResult<>();
        basicResult.setCode(SUCCESS_CODE);
        basicResult.setData(data);
        basicResult.setTotal(total);
        return basicResult;
    }

    /**
     * 成功
     *
     * @param data
     * @param message
     * @param <T>
     * @return
     */
    public static <T> BasicResult<T> success(T data, String message, Boolean success) {
        BasicResult<T> basicResult = new BasicResult<>();
        basicResult.setCode(SUCCESS_CODE);
        basicResult.setMessage(message);
        basicResult.setData(data);
        basicResult.setSuccess(success);
        return basicResult;
    }

    /**
     * 成功
     *
     * @param data
     * @param total
     * @param <T>
     * @return
     */
    public static <T> BasicResult<T> success(T data, Long total) {
        BasicResult<T> basicResult = new BasicResult<>();
        basicResult.setCode(SUCCESS_CODE);
        basicResult.setData(data);
        basicResult.setTotal(total);
        return basicResult;
    }

    /**
     * 失敗
     *
     * @param code
     * @param <T>
     * @return
     */
    static <T> BasicResult<T> fail(String code, Throwable throwable) {
        BasicResult<T> basicResult = new BasicResult<>();
        basicResult.setCode(code);
        basicResult.setMessage(throwable.getMessage());
        basicResult.setFullStackTrace(JSON.toJSONString(throwable));
        return basicResult;
    }

    /**
     * 失敗
     *
     * @param code
     * @param <T>
     * @return
     */
    public static <T> BasicResult<T> fail(String code, String message) {
        BasicResult<T> basicResult = new BasicResult<>();
        basicResult.setCode(code);
        basicResult.setMessage(message);
        return basicResult;
    }


    /**
     * 失敗
     *
     * @param message
     * @param <T>
     * @return
     */
    public static <T> BasicResult<T> fail(String message) {
        BasicResult<T> basicResult = new BasicResult<>();
        basicResult.setCode(DEFAULT_FAIL_CODE);
        basicResult.setMessage(message);
        return basicResult;
    }

    /**
     * 失敗
     *
     * @param throwable
     * @param <T>
     * @return
     */
    static <T> BasicResult<T> fail(Throwable throwable, Boolean isFull) {
        BasicResult<T> basicResult = new BasicResult<>();
        basicResult.setCode("500");
        basicResult.setMessage("系統出錯啦");
        if (isFull) {
            basicResult.setFullStackTrace(JSON.toJSONString(throwable));
        } else {
            basicResult.setFullStackTrace(throwable.getMessage());
        }
        return basicResult;
    }
}

其中需要對UserAction類進行改造，讓我們去訪問的時候會被對應的異常捕獲

@RestController
@RequestMapping("/user")
public class UserAction {

    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @Value("${server.port}")
    String port;

    @Resource
    private UserMapper userMapper;

    @PostMapping("/hi")
    public BasicResult<String> hi(@RequestParam String name) {
        logger.info("----- selectAll method test ------");
        List<User> userList = userMapper.selectList(null);
        logger.info("userList:{}", JSON.toJSON(userList));
        return BasicResult.success("hi " + name + ",i am from port:" + port);
    }

    @GetMapping("/getUser")
    public BasicResult<String> getUser(@RequestParam Integer name) {
        logger.info("----- selectAll method test ------");
        List<User> userList = userMapper.selectList(null);
        logger.info("userList:{}", JSON.toJSON(userList));
        return BasicResult.success("hi " + name + ",i am from port:" + port);
    }
}

BasicResult 是包裝的統一返回資訊。

GlobalExceptionHandler是程式異常的時候對異常的捕獲，然後返回對應的錯誤資訊。

BizException是自定義的系統異常。
啟動專案，瀏覽器訪問http://127.0.0.1:10001/user/hi

控制檯輸出如圖

異常會在HttpRequestMethodNotSupportedException進行處理，然後返回給使用者設定的統一的資料格式。

返回格式如下

EurekaUser-返回型別和全域性異常

在專案裡面加入統一的返回資訊和異常處理新建檔案如下 public interface BaseErrorInfoInterface {

全域性Response物件和全域性異常捕獲和日誌

全域性Response物件和全域性異常捕獲和日誌 1. 全域性Response物件 from rest_framework.response import Response

spring cloud stream 區域性異常和全域性異常混亂

技術標籤：網路java分散式bugredis 緣由：保證訊息不丟失(provider端) 可能會因為mq不可用，或者某些情況，導致訊息傳送失敗。

SpringBoot後端實體類校驗和全域性異常處理

技術標籤：javaspring boot SpringBoot後端實體類校驗和全域性異常處理實體類檢驗實體類Controller類

【SpringBoot】統一返回物件和統一異常處理

為什麼要統一異常 Java異常分為unchecked和checked，對於unchecked的那些異常一般都是程式碼寫的有問題，比如你沒有處理null物件，直接就用這個物件的方法或者屬性了(NullPointException)，或者是除0(ArithmeticExc

SpringBoot全域性異常處理後返回時,區分方法返回型別json還是頁面

在處理異常時，我們需要對API請求丟擲的異常時，我們要以JSON的形式返回錯誤資訊。而在請求頁面時報錯的話，我們需要在跳轉到相應的報錯頁面進行友好提示。

python ctypes庫2_指定引數型別和返回型別詳解

python函式的引數型別和返回型別預設為int。如果需要傳遞一個float值給dll，那麼需要指定引數的型別。

Spring Boot 捕捉全域性異常統一返回值的問題

在前後端分離的情況下，我們經常會定義一個統一的反回資料格式，通常都會包含狀態碼，返回資訊，返回的資料，是否成功等引數。

【Python高階程式設計014 ● 多工程式設計 ●關於int型別和list型別全域性變數的補充說明】

---------Python基礎程式設計--------- Author : AI菌【內容講解】 int型別全域性變數, 每次值改變,記憶體地址也會改變,使用時需要globa關鍵字申明

package com.**.commons.config.web;import java.util.List;import org.springframework.http.HttpStatus;import org.springframework.validation.BindingResult;import org.springframework.validation.ObjectError