SpringBoot接口返回结果封装方法实例详解

 更新时间:2021年09月22日 09:09:20   作者:北极熊的微笑  
在实际项目中,一般会把结果放在一个封装类中,封装类中包含http状态值,状态消息,以及实际的数据。这里主要记录两种方式,通过实例代码给大家介绍的非常详细,需要的朋友参考下吧

rest接口会返回各种各样的数据,如果对接口的格式不加约束,很容易造成混乱。

在实际项目中,一般会把结果放在一个封装类中,封装类中包含http状态值,状态消息,以及实际的数据。这里主要记录两种方式:(效果如下)

 

1、采用Map对象作为返回对象。

/**
 * Http请求接口结果封装方法
 *
 * @param object  数据对象
 * @param msgSuccess 提示信息(请求成功)
 * @param msgFailed 提示信息(请求失败)
 * @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、根据不同类型结果,调用不同的封装方法。

/**
 * 格式化请求结果(List类型)
 *
 * @param <T>
 * @param objectList 对象列表
 * @param msgSuccess 信息提示(请求成功)
 * @param msgFailed 信息提示(请求失败)
 * @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;
}

/**
 * 格式化请求结果(Object类型)
 *
 * @param <T>
 * @param object 对象信息
 * @param msgSuccess 信息提示(请求成功)
 * @param msgFailed 信息提示(请求失败)
 * @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;
}

/**
 * 格式化请求结果(Boolean类型)
 *
 * @param result 请求结果
 * @param msgSuccess 信息提示(请求成功)
 * @param msgFailed 信息提示(请求失败)
 * @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;
}

到此这篇关于SpringBoot接口返回结果封装方法的文章就介绍到这了,更多相关SpringBoot接口封装内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring IoC容器知识点详解

    Spring IoC容器知识点详解

    在本篇文章里小编给各位整理的是关于Spring IoC容器的相关知识点内容,有需要的朋友们可以学习下。
    2019-09-09
  • Spring cloud如何实现FeignClient指定Zone调用

    Spring cloud如何实现FeignClient指定Zone调用

    这篇文章主要介绍了Spring cloud如何实现FeignClient指定Zone调用方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • 解决Tomcat修改get提交请求乱码问题

    解决Tomcat修改get提交请求乱码问题

    这篇文章主要介绍了Tomcat修改get提交请求乱码问题的解决方案,需要的朋友参考下
    2017-04-04
  • Spring中Bean的单例和多例使用说明

    Spring中Bean的单例和多例使用说明

    这篇文章主要介绍了Spring中Bean的单例和多例使用说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • Java实体类中Set按照对象的某个字段对set排序

    Java实体类中Set按照对象的某个字段对set排序

    这篇文章主要介绍了Java实体类中Set按照对象的某个字段对set排序,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-06-06
  • Java中获取类路径classpath的简单方法(推荐)

    Java中获取类路径classpath的简单方法(推荐)

    下面小编就为大家带来一篇Java中获取类路径classpath的简单方法(推荐)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-09-09
  • Java源码解析之object类

    Java源码解析之object类

    前些天看到别人讨论阅读源码有什么用这个问题,有一句话说的特别好:学习别人实现某个功能的设计思路,来提高自己的编程水平。本文主要介绍了Java源码解析之object类,需要的朋友可以参考。
    2017-10-10
  • Java 处理超大数类型之BigInteger案例详解

    Java 处理超大数类型之BigInteger案例详解

    这篇文章主要介绍了Java 处理超大数类型之BigInteger案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-09-09
  • Java数据结构之图的基础概念和数据模型详解

    Java数据结构之图的基础概念和数据模型详解

    在现实生活中,有许多应用场景会包含很多点以及点点之间的连接,而这些应用场景我们都可以用即将要学习的图这种数据结构去解决。本文主要介绍了图的基础概念和数据模型,感兴趣的可以了解一下
    2022-11-11
  • Spring Data环境搭建实现过程解析

    Spring Data环境搭建实现过程解析

    这篇文章主要介绍了Spring Data环境搭建实现过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-08-08

最新评论