• 如果您觉得本站非常有看点,那么赶紧使用Ctrl+D 收藏吧

Restful API返回统一响应体

java 来源:bossaiaboy 8次浏览

参考文档:
https://github.com/kuitos/kuitos.github.io/issues/9

对于客户端开发或者网站开发而言,调用接口返回有统一的响应体,可以针对性的设计界面,代码结构更加清晰,层次也更加分明。

所以需要调用api时,要求返回结构的数据实体。以下就分享以下我的实现方法;

1、建立统一数据结构类

@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class ResponseResult<T> {

	private boolean success;
	private String message;
	private T data;
	private String errorcode;
	public boolean isSuccess() {
		return success;
	}
	public void setSuccess(boolean success) {
		this.success = success;
	}
	public String getMessage() {
		return message;
	}
	public void setMessage(String message) {
		this.message = message;
	}
	public T getData() {
		return data;
	}
	public void setData(T data) {
		this.data = data;
	}
	public String getErrorcode() {
		return errorcode;
	}
	public void setErrorcode(String errorcode) {
		this.errorcode = errorcode;
	}
	public ResponseResult() {
    }
}

2、建立结果返回静态方法

public class RestResultGenerator {

	public static <T> ResponseResult<T> genResult(T data,String message){
		
		
		ResponseResult<T> result = new ResponseResult<T>();
		result.setData(data);
		result.setSuccess(true);
		result.setMessage(message);
		return result;
	}
}

3、在Controller层所有的接口返回都可以定义成 ResponseResult,而在Service层做逻辑处理,根据特定的业务来返回特定的结果;


版权声明:本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系管理员进行删除。
喜欢 (0)