先後端分離項目 — Java後臺統一錯誤消息處理

時間 2019-11-11

標籤後端分離項目 java 後臺統一錯誤消息處理欄目 Java 简体版

原文原文鏈接

一、前言

通常咱們後臺出錯報Exception都是直接拋出來的，可是微信公衆號，或者支付寶支付等等，他們的異常都有錯誤碼對應錯誤信息，他們是如何根據錯誤信息展現對應的錯誤碼提供給前端的呢，這也就是咱們要說的統一錯誤消息處理機制。前端

二、Java實現

首先建立一個Result類，這個類做用是設置消息碼以及消息文本還有消息數據，以下所示數據庫

package com.xfind.util.result;

public class Result<T> {
    private int code;
    private String message;
    private T data;

    public Result(){

    }

    public Result(int code, String message, T data) {
        this(code, message);
        this.data = data;
    }

    public Result(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

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

    public String getMessage() {
        return message;
    }

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

    public Object getData() {
        return data;
    }

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

設置以後，咱們接下來再建立一個ResultCode類，這個類的做用是具體的消息碼和消息，以下所示：微信

package com.xfind.util.result;

/**
 * 異常處理狀態碼
 */
public enum ResultCode {

    SUCCESS(0, "請求成功"),
    Unknown_Exception(-1, "未知異常"),

    USER_NOT_FOUND(10001, "沒有找到此用戶"),
    USERNAME_NOT_BLANK(10002, "用戶名不能爲空"),
    USERNAME_EXIST(10003, "用戶名已經存在"),
    USERTYPE_ERROR(100031, "用戶類型不正確"),
    PHONE_WROND(10004, "手機號不正確"),
    SMS_CODE_ERROR(10007, "手機驗證碼不正確"),
    PHONE_EXIST(10008, "手機號已經存在"),
    USER_EMPTY_EXCEPTION(10009, "用戶名、手機號或者郵箱爲空"),
    USER_TOKEN_EXCEPTION(10010, "從TOKEN中未查到相關用戶信息"),
    USERNAME_PASSWORD_EXCEPTION(10011, "用戶名或者密碼錯誤"),

    EMAIL_SERVER_ECCEPTION(10012, "阿里雲郵件服務端出錯"),
    EMAIL_CLIENT_ECCEPTION(10013, "阿里雲郵件客戶端出錯"),
    EMAIL_SEND_ECCEPTION(10014, "阿里雲郵件發送出錯"),
    EMAIL_WROND(10015, "郵箱不正確"),
    EMAIL_CODE_WROND(10016, "郵箱驗證碼不正確"),
    EMAIL_EXIST(10017, "郵箱已經存在"),

    LOGIN_METHOD_WROND(10018, "登陸方式不正確"),
    CODE_EMPTY(10019, "驗證碼不爲空"),
    PASSWORD_EMPTY(10020, "密碼不爲空"),
    TOKEN_EXCEPTION(10021, "TOKEN認證出錯"),

    USER_AUTH_FAILD(10022, "用戶認證失敗"),

    USER_ACCESS_DENIED(10023, "用戶無權限登陸"),

    CODE_SEND_FAILD(10030, "驗證碼發送失敗"),

    ACTION_MONGODB_ERROR(10100, "操做MONGODB數據庫出錯"),
    OPERATION_TOO_FREQUENT(10101, "請求過於頻繁，請稍候再試"),

    GOLD_COINS_INSUFFICIENT(10025,"金幣餘額不足"),
    CODE_EXIST(10023,"編號已存在"),
    TESTCODE_EXIST(10033,"答題碼已存在"),
    TESTCODE_NOEXIST(10034,"答題碼不存在"),
    TESTCODE_ERROR(10036,"提交數已達上限"),
    TESTCENTER_NOEXIST(10035,"測試題不存在"),
    NAME_EXIST(10024,"名稱已存在"),
    NOT_EXIST_EMAIL(10025,"該企業用戶沒有分配郵箱"),
    MAIL_REACH_MAX(10026,"達到收取郵箱上限"),
    MAIL_NEW_NOTEXIST(10027,"郵箱中沒有可導入的簡歷"),
    PWD_CONFIRM_ERROR(10029,"兩次密碼不一致"),
    PWD_ERROR(10030,"密碼不正確"),
    ENTER_OR_TALENT_NOT_EXITS(10028,"企業或人才庫簡歷不存在"),
    PHONE_EMPTY(10031, "手機號不能爲空"),
    EMAIL_EMPTY(10032, "郵箱不能爲空"),
    NO_USABLE_MAIL(10040,"沒有可用郵箱"),

    REQUESTRECORD_EXIST(10050,"簡歷已投遞"),
    TALENTRESERVER_EXIST(10051,"簡歷已存在於人才儲備庫中，請勿重複添加"),

    DEVICE_ID_EMPTY(10052,"設備ID:deviceId不能爲空"),
    DELETE_CONNECT_ERROR(10053,"刪除connect出錯");

    private int code;
    private String message;

    ResultCode(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

好了，有了Result和ResultCode類，咱們就能夠來編寫異常並返回給前端了，不過在這以前咱們還要建立兩個類：DomainException和SuccessResult，app

package com.xfind.exception;

import com.xfind.util.result.ResultCode;

public class DomainException extends RuntimeException {
    private int errCode = ResultCode.Unknown_Exception.getCode();

    public DomainException() {
        super(ResultCode.Unknown_Exception.getMessage());
    }

    public DomainException(ResultCode resultCode) {
        super(resultCode.getMessage());
        this.errCode = resultCode.getCode();
    }

    public int getErrCode() {
        return errCode;
    }

    public void setErrCode(int errCode) {
        this.errCode = errCode;
    }
}

DomainException的做用是要拋出的異常類，從代碼中能夠看出它是繼承RuntimeException類的，因此可使用throw new DomainException(ResultCode.XX);這樣就能夠拋到前端。dom

package com.xfind.util.result;


public class SuccessResult<T> extends Result<T> {
    public SuccessResult(){

    }

    public SuccessResult(T data) {
        super(ResultCode.SUCCESS.getCode(), ResultCode.SUCCESS.getMessage(), data);
    }
}

這個類的做用是輔助類，把Code和Message都封裝到這個類，就能夠直接返回到前端了。測試

三、設置統一異常處理

咱們再添加一個GlobalExceptionHandler類，來處理每一個拋出DomainException類返回的數據，前返回Result給前端了，以下所示：this

/**
 * 統一異常處理
 */
@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(value = DomainException.class)
    public Result domainExceptionHandler(HttpServletRequest req,
                                         DomainException e) throws Exception {
        e.printStackTrace();
        Result result = new Result(e.getErrCode(), e.getMessage());
        return result;
    }
}

四、測試

如今咱們編寫一個類來測試咱們剛剛寫的類的運行狀況，以下所示阿里雲

@GetMapping("/isRegister")
    public ResponseEntity isRegister(@RequestParam String user) {
        boolean has_phone = smsService.isExist(user);
        if (has_phone) {
            throw new DomainException(ResultCode.PHONE_EXIST);
        }

        boolean has_email = emailService.isExist(user);
        if (has_email) {
            throw new DomainException(ResultCode.EMAIL_EXIST);
        }
        String str = "該手機號或者郵箱沒有被註冊，能夠註冊本系統";
        Result result = new SuccessResult<>(str);
        return ResponseEntity.ok(result);
    }

該方法是判斷用戶是否已經被註冊，方法裏面先判斷是否有相同手機或者郵箱，若是有就招聘異常給前端，不然則返回正確信息給前端，咱們使用POSTMan來測試下
1）首先咱們輸入一個已經存在的手機號spa