定義一個http restful服務返回值工具包


多系統之間通訊現在最常用的是使用標准的http服務,如:restful,定義企業通用的數據格式。怎樣定義一個標准,定義一種編碼規范,讓所有的開發者遵循這個標准?  結合我們公司服務返回數據的格式,自己寫了一個通用的工具類,有興趣的朋友可以使用一下。

1. 定義一個ResponseVO對象,代碼如下:

 

 

<span style="font-size: 16px;">public class ResponseVO {
	//狀態碼
	private int code;
	//返回消息
	private String message;
	//版本號
	private String version = "v1.0";
	//data對象
	private Object data;
	
	public String getVersion() {
		return version;
	}
	public void setVersion(String version) {
		this.version = version;
	}
	public int getCode() {
		return code;
	}
	public void setCode(int code) {
		this.code = code;
	}
	public String getMessage() {
		return message;
	}
	public void setMessage(String message) {
		this.message = message;
	}
	public Object getData() {
		return data;
	}
	public void setData(Object data) {
		this.data = data;
	}
	public ResponseVO() {
		super();
	}
	public ResponseVO(int code, String message, Object data) {
		super();
		this.code = code;
		this.message = message;
		this.data = data;
	}
}</span>

 

  2. 定義標准的ResponseCode,代碼如下:

<span style="font-size: 16px;">/**
 * 公共服務響應狀態碼
 * @author ant
 *
 */
public enum ResponseCode {
	RESPONSE_CODE_FAILURE(10000,"請求失敗、結果處理失敗"),
	RESPONSE_CODE_SUCCESS(10001,"請求成功、結果處理成功"),
	RESPONSE_CODE_PARAM_FORMAT_ERROR(10002,"請求失敗、參數格式錯誤"),
	RESPONSE_CODE_PARAM_ERROR(10003,"參數錯誤"),
	RESPONSE_CODE_REQ_CANNOT_EMPTY(10004,"必要的請求參數不能為空"),
	RESPONSE_CODE_USER_DOES_NOT_EXIST(10005,"用戶不存在"),
	RESPONSE_CODE_QUERY_SUCCESS(10006,"數據查詢成功"),
	RESPONSE_CODE_QUERY_NO_DATA(10007,"無數據或者結果"),
	USER_LOGIN_PWD_ERROR(10008,"用戶名密碼錯誤"),
	REQUEST_URL_NOT_SERVICE(10009,"訪問了非服務路徑"),
	RESPONSE_CODE_UNLOGIN_ERROR(421,"未登錄異常"),
	RESPONSE_CODE_LOGIN_SUCCESS(200,"用戶登錄成功"),
	RESPONSE_CODE_NO_PERMISSION(403,"無權訪問該系統"),
	RESPONSE_CODE_SYSTEM_ERROR(500,"系統內部異常"),
	RESPONSE_CODE_TIME_OUT(504,"上游服務端網關超時");
	
	private int code; //狀態碼  
        private String message; //返回消息
    
        // 構造方法  
        private ResponseCode(int code,String message) {  
                this.code = code;  
                this.message = message;  
        }  

	public int getCode() {
		return code;
	}

	public void setCode(int code) {
		this.code = code;
	}

	public String getMessage() {
		return message;
	}

	public void setMessage(String message) {
		this.message = message;
	}  

	public static ResponseVO buildEnumResponseVO(ResponseCode responseCode, Object data) {
		return new ResponseVO(responseCode.getCode(),responseCode.getMessage(),data);
	}
	
	public static Map<String, Object> buildReturnMap(ResponseCode responseCode, Object data) {
		Map<String, Object> map = new HashMap<String, Object>();
		map.put("code", responseCode.getCode());
		map.put("message", responseCode.getMessage());
		map.put("data", data);
		return map;
	}	
}
</span>

  

願意了解框架技術或者源碼的朋友直接求求交流分享技術:2042849237
分布式的一些解決方案,有願意了解的朋友可以找我們團隊探討
更多詳細源碼參考來源


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM