restful接口统一返回格式

 

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 successResponse(Object object){
            String retCode = "Y";
            String retMessage = "200";
            Map map = getObjectMap(object,retCode,retMessage,"");
            return map;
        }
    
        /**
         * 请求接口错误。需要返回错误对照表编码
         * @param retMessage  错误信息
         * @param errCode 错误对照表编码   eg: ERROR_500100 调用参数必填
         * @return
         */
        public static Map errCodeResponse(String errCode,String retMessage){
            String retCode = "N";
            Map map = null;
            if(StringUtils.isNotBlank(retMessage)){
                map = getObjectMap("",retCode,errCode,retMessage);
            }
            map = getObjectMap("",retCode,errCode,"");
            return map;
        }
    
        /**
         *
         * @param retMessage 错误信息
         * @return
         */
        public static Map errorResponse(String retMessage){
            String retCode = "N";
            Map map = getObjectMap("",retCode,retMessage,"");
            return map;
        }
    
    
        private static Map getObjectMap(Object object,String retCode,String retMessage,String errCode) {
            Map map = new HashMap();
            Map header = new HashMap();
            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;
        }
}
 

你可能感兴趣的:(杂项)