restful接口统一返回格式

最新推荐文章于 2025-03-08 20:00:00 发布

雨化甜

最新推荐文章于 2025-03-08 20:00:00 发布

阅读量2.8k

点赞数

分类专栏：杂项文章标签： restful统一返回格式

本文链接：https://blog.youkuaiyun.com/menglonghuanying/article/details/90404022

版权

杂项专栏收录该内容

2 篇文章

订阅专栏

本文介绍了如何设计RESTful接口的统一返回格式，包括成功响应和错误响应。成功响应包含`retCode`为'Y'、`retMessage`为'200'以及具体数据。错误响应则根据错误类型提供不同的`errCode`和`retMessage`，确保接口调用的标准化和易读性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

import java.util.HashMap;
import java.util.Map;

import org.apache.commons.lang3.StringUtils;

/**
* @Version : 1.0
* @Description : 公共服务接口返会数据--统一格式
*/
public class CommonResult {

   /**
   * 接口调用正确时
   * @param object 调用接口
   * @return
   */
   public static Map<String,Object> successResponse(Object object){
   String retCode = "Y";
   String retMessage = "200";
   Map<String, Object> map = getObjectMap(object,retCode,retMessage,"");
   return map;
   }

   /**
   * 请求接口错误。需要返回错误对照表编码
   * @param retMessage 错误信息
   * @param errCode 错误对照表编码 eg: ERROR_500100 调用参数必填
   * @return
   */
   public static Map<String,Object> errCodeResponse(String errCode,String retMessage){
   String retCode = "N";
   Map<String, Object> map = null;
   if(StringUtils.isNotBlank(retMessage)){
       map = getObjectMap("",retCode,errCode,retMessage);
   }
   map = getObjectMap("",retCode,errCode,"");
   return map;
   }

   /**
   *
   * @param retMessage 错误信息
   * @return
   */
   public static Map<String,Object> errorResponse(String retMessage){
       String retCode = "N";
   Map<String, Object> map = getObjectMap("",retCode,retMessage,"");
   return map;
   }


   private static Map<String, Object> getObjectMap(Object object,String retCode,String retMessage,String errCode) {
   Map<String, Object> map = new HashMap<String, Object>();
   Map<String, Object> header = new HashMap<String, Object>();
   header.put("retCode", retCode);
   header.put("retMessage", retMessage);
   if(StringUtils.isNotBlank(errCode)){
       header.put("errCode", errCode);
   }
   map.put("header", header);
   map.put("body", object);
   return map;
   }
}