com.xiaoleilu.ucloud.core.Response Maven / Gradle / Ivy

Go to download
package com.xiaoleilu.ucloud.core;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.xiaoleilu.hutool.StrUtil;

/**
 * API响应内容
 * @author Looly
 *
 */
public class Response{
	
	private static final String RET_CODE = "RetCode";
	private static final String MESSAGE = "Message";
	private static final String TOTAL_COUNT = "TotalCount";
	
	private JSONObject json;
	
	/**
	 * 将返回的JSON字符串转为响应对象
	 * @param jsonStr 响应JSON字符串
	 * @return 响应对象
	 */
	public static Response parse(String jsonStr) {
		return new Response(jsonStr);
	}
	
	/**
	 * 构造
	 * @param jsonStr Response JSON字符串
	 */
	public Response(String jsonStr) {
		//对于文件操作，不返回内容，此时表示成功
		if(StrUtil.isBlank(jsonStr)) {
			json = new JSONObject();
			json.put(RET_CODE, RetCode.OK);
		}else {
			json = JSON.parseObject(jsonStr);
		}
		
	}
	
	/**
	 * 获得对象
	 * @param key KEY
	 * @return 对象
	 */
	public Object get(String key) {
		return this.json.get(key);
	}
	
	/**
	 * 获得响应状态码
	 * @return 响应状态码
	 */
	public int getRetCode() {
		return this.json.getIntValue(RET_CODE);
	}
	
	/**
	 * 获得返回的消息（一般为错误消息）
	 * @return 返回消息
	 */
	public String getMessage() {
		return this.json.getString(MESSAGE);
	}
	
	/**
	 * 获得满足条件结果数
	 * @return 满足条件结果数
	 */
	public int getTotalCount() {
		return this.json.getIntValue(TOTAL_COUNT);
	}
	
	/**
	 * 获得响应JSON对象
	 * @return 响应JSON对象
	 */
	public JSONObject getJson(){
		return this.json;
	}
	
	/**
	 * @return 请求是否正常
	 */
	public boolean isOk() {
		return RetCode.OK == this.getRetCode();
	}
	
	/**
	 * 输出格式化后的JSON字符串
	 * @return 格式化后的JSON字符串
	 */
	public String toPretty(){
		return JSON.toJSONString(this.json, true);
	}
	
	@Override
	public String toString() {
		return this.json.toJSONString();
	}
	
	/**
	 * API返回码
	 * @author Looly
	 *
	 */
	public static class RetCode {
		/** API请求正常 */
		public final static int OK = 0;
		
		/** API请求未知异常 */
		public final static int ERROR= -1;
		
		/** 用户不存在 */
		public final static int USER_NOT_EXISTS= 171;
		
		/** 验证签名错误 */
		public final static int SIGNATURE_VERFY_AC_ERROR= 172;
		
		/** 主机未关 */
		public final static int UHOST_NOT_SHUTDOWN= 8010;
	}
}