restful接口统一返回格式

超、凢脫俗 2022-01-29 06:51 441阅读 0赞

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;  
        \}  
\}