Java接口统一样式返回模板的实现
前言
一开始，我们在写项目的时候，前端要什么数据，我们就返回什么数据，每个接口也都写得不一样很乱；随着前后端的分离；对于代码规范的要求也越来越严谨；接口都是统一样式的返回模板；
下面，接受一种我之前用过的返回模板；
一、首先来看下我们的Controller接口
/**
*获取用户信息
*@paramtoken微信登入者token
*@paramid商品id
*@return商品详细信息
*/
@PostMapping(value="getUserInfo")
@ResponseBody
publicResultResponsegetUserInfo(
@RequestParam(value="token")Stringtoken){
ResultResponseresult=newResultResponse();
//这里获取用户信息的类就不贴出来了
Useruser=userService.getUserByToken(token);
result.setData(user);
returnresult.setStatus(ResponseCode.SUCCESS);
}
我们可以看出，接口返回的是ResultResponse类；下面来剖析这个类；
二、统一样式返回模板ResultResponse剖析
2.1ResultResponse类：
packagecom.himo.common; importcom.fasterxml.jackson.annotation.JsonIgnore; importcom.fasterxml.jackson.annotation.JsonInclude; importlombok.Data; /** *@Author:laixiansong *@Description:http请求 *@Vesion:1.0.0 *@Date:2017/10/17 */ @Data publicclassResultResponse{ /**错误码*/ privateIntegercode; /**错误信息*/ privateStringmsg; @JsonInclude(JsonInclude.Include.NON_NULL) privateTdata; publicvoidsetData(Tdata){ this.data=data; } publicResultResponsesetStatus(ResponseCoderesponseCode){ this.code=responseCode.getCode(); this.msg=responseCode.getDesc(); returnthis; } publicStringgetMsg(){ returnmsg; } }
ResultResponse类包含了错误码、错误信息、返回的对象json；
2.2枚举类
从ResultResponse类中我们可以看出，错误码和错误信息是一一对应的，我们用一个枚举类ResponseCode来封装；
ResponseCode：
packagecom.himo.common;
/**
*@Author:laixiansong
*@Description:
*@Vesion:1.0.0
*@Date:2017/10/17
*/
publicenumResponseCode{
SUCCESS(0,"SUCCESS"),
ERROR(1,"ERROR"),
REQUEST_PARAMS_ERROR(1003,"请求参数错误"),
NOT_WX_LOGIN(1004,"非微信端登录"),
WX_LOGIN_PARAMS_ERROR(1005,"微信登录code错误"),
NO_LOGIN(1006,"登录状态失效"),
;
privatefinalintcode;
privatefinalStringdesc;
ResponseCode(intcode,Stringdesc){
this.code=code;
this.desc=desc;
}
publicintgetCode(){
returncode;
}
publicStringgetDesc(){
returndesc;
}
}
我们可以在枚举类中加入我们想要增加的错误信息和错误码；
这样就是一个完成的Java接口返回的模板了；
总结
技术在不断更新换代，但是它的基础没有变，要想更好的维护项目，使得代码更加的美观和正规，所有接口统一返回统一类是非常有必要的；
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。