手机版

弹簧靴统一数据格式的接口返回结果的实现

时间:2021-08-19 来源:互联网 编辑:宝哥软件园 浏览:

前后端分离的项目开发前,会提前规定好数据返回格式,本文以数据为例。

第一步,定义好JavaBean。

包裹。com。旋风。我的助手。网络。回应;进口。com。fasterxml。杰克逊。注释。jsonignore导入com。旋风。我的助手。网络。错误。代码。基本枚举错误;导入Java。io。可序列化;导入朗博克岛.数据;/** * 所有服务统一响应数据格式* * @作者ye 17186 * @版本2019/2/15 14:40 */@数据公开类ApiRespT实现Serializable {私有静态最终长串行版本id=9211889136173018364 l;/** * 正常响应码*/private static final int SUCCESS _ CODE=0;/** * 正常响应消息*/私有静态最终字符串SUCCESS _ MSG=' SUCCESS/** *错误码*/private int CODE=SUCCESS _ CODE;/** * 错误信息*/私有字符串msg=SUCCESS _ MSG/** *响应内容,默认为null */私有T数据=null/** *是否的正常响应* * @返回真=正常;false=异常*/@ JsonIgnore公共布尔IsoK(){ 0返回代码==SUCCESS _ CODE} /** *无数据的正常返回*/public static APi resp ReToK(){ return new APi resp();} /** * 有数据的正常返回* * @param数据数据内容* @参数数据类型*/public静态T ApiRespT retOK(T数据){ API respt响应=新API resp();response.setData(数据);返回响应;} /** * 无数据的失败返回* * @param错误错误类型*/public static APi resp ret fail(BaseEnumError错误){ ret ret失败(错误。getcode()、错误。getmsg());} /** * 有数据的失败返回* * @param错误错误类型* @param数据详细错误信息*/public static T apirespot retFail(基础枚举错误错误,T数据){ retFail ret(错误。getcode()、error.getMsg()、data);} /** * 无数据的失败返回* * @param代码错误码* @param消息错误信息*/public static T APi respt retFail(int代码,String msg){ APi respt response=new APi resp();response.setCode(代码);回应。setmsg(msg);返回响应;} /** * 有数据的失败返回* br *失败返回的场景不多,所以没有严格要求T泛型* * @param代码错误码* @param消息错误信息*/公共静态测试API respt retFail(int代码,字符串消息,T数据){ API respt响应=新API resp();response.setCode(代码);回应。setmsg(msg);response.setData(数据);返回响应;}}第二步,在控制器中使用

@ GetMapping('/test 1 ')公共API resp test 1(){ return API resp。ReTok(《你好,世界》);} @ GetMapping('/test 2 ')公共APi resp test 2(){ return APi resp。retfail(基本枚举错误.系统_否_登录);}可以在邮递员查看具体的响应内容如下:

当然,ApiResp中的泛型,也可以使用复杂的数据对象。实际开发中,每种错误响应都有自己的响应码代码,和错误信息味精,示例中统一定义了一个基本错误的枚举类,具体内容可参照我的开源代码库项目https://github.com/ye17186/myhelper-spring-boot-starter

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

版权声明:弹簧靴统一数据格式的接口返回结果的实现是由宝哥软件园云端程序自动收集整理而来。如果本文侵犯了你的权益,请联系本站底部QQ或者邮箱删除。