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接口封装内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java中数学相关类的使用教程

    Java中数学相关类的使用教程

    Java是一种广泛使用的编程语言,它提供了许多数学运算的函数和方法,使得开发者可以轻松地进行各种数学计算,下面这篇文章主要给大家介绍了关于Java中数学相关类使用的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-05-05
  • 一文学习Java NIO的ByteBuffer工作原理

    一文学习Java NIO的ByteBuffer工作原理

    很多网友说JDK又在写Bug!下面通过通过本文学习下为何Java NIO的ByteBuffer这么垃圾,涉及到ByteBuf API 的优点及工作原理解析,感兴趣的朋友跟随小编一起看看吧
    2021-05-05
  • Java中调用DLL动态库的操作方法

    Java中调用DLL动态库的操作方法

    在Java编程中,有时我们需要调用本地代码库,特别是Windows平台上的DLL(动态链接库),本文中,我们将详细讨论如何在Java中加载和调用DLL动态库,并通过具体示例来展示这个过程,感兴趣的朋友跟随小编一起看看吧
    2024-03-03
  • 详解JVM的内存对象介绍[创建和访问]

    详解JVM的内存对象介绍[创建和访问]

    这篇文章主要介绍了JVM的内存对象介绍[创建和访问],文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-03-03
  • Java23种设计模式中的单例模式你了解吗

    Java23种设计模式中的单例模式你了解吗

    这篇文章主要为大家详细介绍了Java23种设计模式中的单例模式,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-02-02
  • SpringCloud Zuul的使用简介

    SpringCloud Zuul的使用简介

    这篇文章主要介绍了SpringCloud Zuul的使用简介,帮助大家更好的理解和学习使用Spring Cloud,感兴趣的朋友可以了解下
    2021-04-04
  • Java中去除字符串中所有空格的几种方法

    Java中去除字符串中所有空格的几种方法

    这篇文章介绍了Java中去除字符串中所有空格的几种方法,有需要的朋友可以参考一下
    2013-07-07
  • 使用IDEA异常断点来定位java.lang.ArrayStoreException的问题

    使用IDEA异常断点来定位java.lang.ArrayStoreException的问题

    这篇文章主要介绍了使用IDEA异常断点来定位java.lang.ArrayStoreException的问题,平常开发过程中面对这种描述不够清楚,无法定位具体原因的问题该如何处理,下面我们来一起学习一下吧
    2019-06-06
  • 详解SpringBoot基础之banner玩法解析

    详解SpringBoot基础之banner玩法解析

    SpringBoot项目启动时会在控制台打印一个默认的启动图案,这个图案就是我们要讲的banner,这篇文章主要介绍了SpringBoot基础之banner玩法解析,感兴趣的小伙伴们可以参考一下
    2019-04-04
  • IDEA2020.1使用LeetCode插件运行并调试本地样例的方法详解

    IDEA2020.1使用LeetCode插件运行并调试本地样例的方法详解

    这篇文章主要介绍了IDEA2020.1使用LeetCode插件运行并调试本地样例的方法,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2020-09-09

最新评论