分享

定义一个http restful服务返回值工具包

 开始6m01rwbqw6 2017-12-12

多系统之间通讯现在最常用的是使用标准的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

分布式的一些解决方案,有愿意了解的朋友可以找我们团队探讨

更多详细源码参考来源:http:///technology

    本站是提供个人知识管理的网络存储空间,所有内容均由用户发布,不代表本站观点。请注意甄别内容中的联系方式、诱导购买等信息,谨防诈骗。如发现有害或侵权内容,请点击一键举报。
    转藏 分享 献花(0

    0条评论

    发表

    请遵守用户 评论公约

    类似文章 更多