快捷導(dǎo)航

SpringBoot接口返回結(jié)果封裝方法實(shí)例詳解

更新時(shí)間：2021年09月22日 09:09:20 作者：北極熊的微笑

在實(shí)際項(xiàng)目中，一般會(huì)把結(jié)果放在一個(gè)封裝類中，封裝類中包含http狀態(tài)值，狀態(tài)消息，以及實(shí)際的數(shù)據(jù)。這里主要記錄兩種方式，通過實(shí)例代碼給大家介紹的非常詳細(xì)，需要的朋友參考下吧

rest接口會(huì)返回各種各樣的數(shù)據(jù)，如果對(duì)接口的格式不加約束，很容易造成混亂。

在實(shí)際項(xiàng)目中，一般會(huì)把結(jié)果放在一個(gè)封裝類中，封裝類中包含http狀態(tài)值，狀態(tài)消息，以及實(shí)際的數(shù)據(jù)。這里主要記錄兩種方式：（效果如下）

1、采用Map對(duì)象作為返回對(duì)象。

/**
 * Http請(qǐng)求接口結(jié)果封裝方法
 *
 * @param object  數(shù)據(jù)對(duì)象
 * @param msgSuccess 提示信息（請(qǐng)求成功）
 * @param msgFailed 提示信息（請(qǐng)求失?。?
 * @param isOperate 是否操作類型（增、刪、改）
 * @return
 */
public static Map<String, Object> getResponse(Object object, String msgSuccess, String msgFailed, boolean isOperate) {
    Map<String, Object> data = new HashMap<>();
    if (object != null) {
        data.put("success", true);
        data.put("msg", msgSuccess);
        data.put("result", 1);
    } else {
        data.put("success", false);
        data.put("msg", msgFailed);
        data.put("result", 0);
    }
    if (!isOperate) {
        data.put("data", object);
    } else {
        data.put("data", null);
    }
    return data;
}

2、根據(jù)不同類型結(jié)果，調(diào)用不同的封裝方法。

/**
 * 格式化請(qǐng)求結(jié)果（List類型）
 *
 * @param <T>
 * @param objectList 對(duì)象列表
 * @param msgSuccess 信息提示（請(qǐng)求成功）
 * @param msgFailed 信息提示（請(qǐng)求失?。?
 * @return
 */
@SuppressWarnings("unchecked")
public static <T> Tb_Response<T> getResponse(List<T> objectList, String msgSuccess, String msgFailed) {
    Tb_Response<T> tb_Response = new Tb_Response<T>();
    if (objectList.size() > 0) {
        tb_Response.setSuccess(true);
        tb_Response.setMsg(msgSuccess);
        tb_Response.setResult(1);
        tb_Response.setData((List<T>) objectList);
    } else {
        tb_Response.setSuccess(false);
        tb_Response.setMsg(msgFailed);
        tb_Response.setResult(0);
    }
    return (Tb_Response<T>) tb_Response;
}

/**
 * 格式化請(qǐng)求結(jié)果（Object類型）
 *
 * @param <T>
 * @param object 對(duì)象信息
 * @param msgSuccess 信息提示（請(qǐng)求成功）
 * @param msgFailed 信息提示（請(qǐng)求失?。?
 * @return
 */
@SuppressWarnings("unchecked")
public static <T> Tb_ResponseData<T> getResponseData(T object, String msgSuccess, String msgFailed) {
    Tb_ResponseData<T> tb_ResponseData = new Tb_ResponseData<T>();
    if (object != null) {
        tb_ResponseData.setSuccess(true);
        tb_ResponseData.setMsg(msgSuccess);
        tb_ResponseData.setResult(1);
        tb_ResponseData.setData((T) object);
    } else {
        tb_ResponseData.setSuccess(false);
        tb_ResponseData.setMsg(msgFailed);
        tb_ResponseData.setResult(0);
        tb_ResponseData.setData(null);
    }
    return (Tb_ResponseData<T>) tb_ResponseData;
}

/**
 * 格式化請(qǐng)求結(jié)果（Boolean類型）
 *
 * @param result 請(qǐng)求結(jié)果
 * @param msgSuccess 信息提示（請(qǐng)求成功）
 * @param msgFailed 信息提示（請(qǐng)求失?。?
 * @return
 */
public static Tb_ResponseData<Boolean> getResponseData(boolean result, String msgSuccess, String msgFailed) {
    Tb_ResponseData<Boolean> tb_ResponseData = new Tb_ResponseData<Boolean>();
    if (result) {
        tb_ResponseData.setSuccess(true);
        tb_ResponseData.setMsg(msgSuccess);
        tb_ResponseData.setResult(1);
    } else {
        tb_ResponseData.setSuccess(false);
        tb_ResponseData.setMsg(msgFailed);
        tb_ResponseData.setResult(0);
    }
    tb_ResponseData.setData(null);
    return tb_ResponseData;
}

到此這篇關(guān)于SpringBoot接口返回結(jié)果封裝方法的文章就介紹到這了,更多相關(guān)SpringBoot接口封裝內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: