栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

公司项目JAVA开发规范总结——统一接口返回规范

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

公司项目JAVA开发规范总结——统一接口返回规范

一、统一接口返回规范

概述:所有的接口返回,都应按照该格式去进行返回给前端

PacketHttpRes_V32类:

@Data
@Accessors(chain = true)
@JsonIgnoreProperties(allowSetters = true, value = {"httpStatus"})
@ApiModel("PacketHttpRes_V32")
public class PacketHttpRes_V32 {

	@ApiModelProperty(value = "结果码 200:成功 500:具体异常信息 400:参数异常 401:未授权的请求 403:无权访问")
	@JSONField(name="ReturnCode")
	private Integer returnCode;

	@ApiModelProperty(value = "接口请求结果描述信息")
	@JSONField(name="ReturnCode_Msg")
	private String returnCode_Msg;

	@ApiModelProperty(value = "错误码 0:正常 1:名称重复 2:不存在 3:数量超出限制 4:")
	@JSONField(name="ResultCode")
	private Integer resultCode;

	@ApiModelProperty(value = "业务处理结果描述信息")
	@JSONField(name="ResultCode_Msg")
	private String resultCode_Msg;

	@ApiModelProperty(value = "业务处理结果数据体")
	@JSONField(name="Data")
	private T data;
	
	public PacketHttpRes_V32() {}

	public PacketHttpRes_V32(Integer returnCode, String returnCode_Msg, Integer resultCode, String resultCode_Msg,
				   T data) {
		super();
		this.returnCode = returnCode;
		this.returnCode_Msg = returnCode_Msg;
		this.resultCode = resultCode;
		this.resultCode_Msg = resultCode_Msg;
		this.data = data;
	}

}

为了更加方便使用,已对该类进行静态方法封装,如下:

public static  PacketHttpRes_V32 makeOKResponse(T data) {
    return new PacketHttpRes_V32()
        .setReturnCode(ReturnCode.success_code)
        .setReturnCode_Msg(ReturnCode.success_message)
        .setResultCode(ReturnCode.err_nomean_code)
        .setResultCode_Msg(ReturnCode.err_nomean_message)
        .setData(data);
}

public static  PacketHttpRes_V32 makeOKResponse(String message) {
    return new PacketHttpRes_V32()
        .setReturnCode(ReturnCode.success_code)
        .setReturnCode_Msg(ReturnCode.success_message)
        .setResultCode(ReturnCode.err_nomean_code)
        .setResultCode_Msg(message);
}

public static  PacketHttpRes_V32 makeOKResponse(String message, Integer code, T data) {
    return new PacketHttpRes_V32()
        .setReturnCode(ReturnCode.success_code)
        .setReturnCode_Msg(ReturnCode.success_message)
        .setResultCode(code)
        .setResultCode_Msg(message)
        .setData(data);
}

public static  PacketHttpRes_V32 makeFailResponse(String message) {
    message = Optional.ofNullable(message).orElse(ReturnCode.server_exception_message);
    return new PacketHttpRes_V32()
        .setReturnCode(ReturnCode.success_code)
        .setReturnCode_Msg(ReturnCode.success_message)
        .setResultCode(ReturnCode.err_nomean_code)
        .setResultCode_Msg(message);
}


public static  PacketHttpRes_V32 makeResponse(Integer returnCode, String returnCodeMessage,
                                          Integer resultCode, String resultCodeMessage, T data) {
    return new PacketHttpRes_V32()
        .setReturnCode(returnCode)
        .setReturnCode_Msg(returnCodeMessage)
        .setResultCode(resultCode)
        .setResultCode_Msg(resultCodeMessage)
        .setData(data);
}

返回例子:

//正确例子
return PacketHttpRes_V32.makeOKResponse(shareTpBaseInfoPage);

//错误例子
PacketHttpRes_V32.setReturnCode(ReturnCode.success_code);
PacketHttpRes_V32.setReturnCode_Msg(ReturnCode.success_message);
PacketHttpRes_V32.setResultCode(ReturnCode.err_nomean_code);
PacketHttpRes_V32.setResultCode_Msg(ReturnCode.err_nomean_message);
PacketHttpRes_V32.setData(shareTpBaseInfoPage);
return PacketHttpRes_V32;

注意:

项目中有:PacketHttpRes 与 PacketHttpRes_V32 两个返回类,PacketHttpRes_V32 为最新的,使用最新的即可

旧版的部分接口使用PacketHttpRes ,所以不能删除PacketHttpRes 类。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/980807.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号