• 瑞金千人雨伞拼图创世界吉尼斯纪录 2019-07-02
  • “熊孩子”与幼儿教育 2019-06-15
  • 港媒称中国手游在韩国吸金美日手游遭韩玩家冷落 2019-06-15
  • 酒与植物 轻酌一樽是花香 2019-05-13
  • 台军为帮农民每餐吃香蕉 台媒改善两岸关系是根本 2019-05-12
  • 原脉——大地肌体上的血脉文章中国国家地理网 2019-05-11
  • 用更加过硬的作风追求改革新突破 2019-05-11
  • 欧版T90暴露法德坦克硬伤 VT4我离最强只差两步 2019-05-10
  • 【专题】河北省无偿献血领导小组会议报道 2019-05-10
  • 科幻推理剧《端脑》北京首映 搜狐匠心“烧脑”之作获赞 2019-05-09
  • 【大家谈】激励实干担当,谱写奋斗“进行曲” 2019-05-08
  • 回复@老老保老张工:连马克思都要重构个人所有制也!你不会自以为比马克思还高明吧? 2019-05-08
  • 学习宣传贯彻习近平新时代中国特色社会主义思想系列研讨会br第三场研讨会发言摘编 2019-05-07
  • 2000年出生的孩子属龙,要风得风,要雨得雨 2019-05-07
  • 美国防部宣布暂停8月美韩联合军演 2019-05-06
  • 中国彩票网生肖时时彩:Java 如何设计 API 接口,实现统一格式返回? [复制链接]

    2019-11-11 10:35
    小小CTO 阅读:375 评论:0 赞:0
    Tag:  Java API

    前言

    香港生肖时时彩 www.eptu.com.cn 在移动互联网,分布式、微服务盛行的今天,现在项目绝大部分都采用的微服务框架,前后端分离方式,

    (题外话:前后端的工作职责越来越明确,现在的前端都称之为大前端,技术栈以及生态圈都已经非常成熟;以前后端人员瞧不起前端人员,那现在后端人员要重新认识一下前端,前端已经很成体系了)

    一般系统的大致整体架构图如下:

    需要说明的是,有些小伙伴会回复说,这个架构太简单了吧,太low了,什么网关啊,缓存啊,消息中间件啊,都没有。

    因为老顾这篇主要介绍的是API接口,所以我们聚焦点,其他的??樾』锇槊亲孕腥ゲ钩?。

    接口交互

    前端和后端进行交互,前端按照约定请求URL路径,并传入相关参数,后端服务器接收请求,进行业务处理,返回数据给前端。

    针对URL路径的restful风格,以及传入参数的公共请求头的要求(如:app_version,api_version,device等),老顾这里就不介绍了,小伙伴们可以自行去了解,也比较简单。

    后端服务器如何实现把数据返回给前端?

    返回格式

    后端返回给前端我们一般用JSON体方式,定义如下:

    CODE状态码

    code返回状态码,一般小伙伴们是在开发的时候需要什么,就添加什么。

    如接口要返回用户权限异常,我们加一个状态码为101吧,下一次又要加一个数据参数异常,就加一个102的状态码。这样虽然能够照常满足业务,但状态码太凌乱了

    我们应该可以参考HTTP请求返回的状态码

    Java 如何设计 API 接口,实现统一格式返回?

    我们可以参考这样的设计,这样的好处就把错误类型归类到某个区间内,如果区间不够,可以设计成4位数。

    这样前端开发人员在得到返回值后,根据状态码就可以知道,大概什么错误,再根据message相关的信息描述,可以快速定位。

    Message

    这个字段相对理解比较简单,就是发生错误时,如何友好的进行提示。一般的设计是和code状态码一起设计,如:

    Java 如何设计 API 接口,实现统一格式返回?

    再在枚举中定义,状态码

    Java 如何设计 API 接口,实现统一格式返回?

    状态码和信息就会一一对应,比较好维护。

    Data

    返回数据体,JSON格式,根据不同的业务又不同的JSON体。

    我们要设计一个返回体类Result

    Java 如何设计 API 接口,实现统一格式返回?

    控制层Controller

    我们会在controller层处理业务请求,并返回给前端,以order订单为例

    Java 如何设计 API 接口,实现统一格式返回?

    我们看到在获得order对象之后,我们是用的Result构造方法进行包装赋值,然后进行返回。小伙伴们有没有发现,构造方法这样的包装是不是很麻烦,我们可以优化一下。

    美观美化

    我们可以在Result类中,加入静态方法,一看就懂

    Java 如何设计 API 接口,实现统一格式返回?

    那我们来改造一下Controller

    Java 如何设计 API 接口,实现统一格式返回?

    代码是不是比较简洁了,也美观了。

    优雅优化

    上面我们看到在Result类中增加了静态方法,使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题:

    每个方法的返回都是Result封装对象,没有业务含义

    在业务代码中,成功的时候我们调用Result.success,异常错误调用Result.failure。是不是很多余

    上面的代码,判断id是否为null,其实我们可以使用hibernate validate做校验,没有必要在方法体中做判断。

    我们最好的方式直接返回真实业务对象,最好不要改变之前的业务方式,如下图:

    Java 如何设计 API 接口,实现统一格式返回?

    这个和我们平时的代码是一样的,非常直观,直接返回order对象,这样是不是很完美。

    那实现方案是什么呢?

    实现方案

    小伙伴们怎么去实现是不是有点思路,在这个过程中,我们需要做几个事情

    定义一个注解@ResponseResult,表示这个接口返回的值需要包装一下

    拦截请求,判断此请求是否需要被@ResponseResult注解

    核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice,判断是否需要包装返回值,如果需要,就把Controller接口的返回值进行重写。

    注解类

    用来标记方法的返回值,是否需要包装

    Java 如何设计 API 接口,实现统一格式返回?

    拦截器

    拦截请求,是否此请求返回的值需要包装,其实就是运行的时候,解析@ResponseResult注解

    Java 如何设计 API 接口,实现统一格式返回?

    此代码核心思想,就是获取此请求,是否需要返回值包装,设置一个属性标记。

    重写返回体

    Java 如何设计 API 接口,实现统一格式返回?

    上面代码就是判断是否需要返回值包装,如果需要就直接包装。

    这里我们只处理了正常成功的包装,如果方法体报异常怎么办?处理异常也比较简单,只要判断body是否为异常类。

    Java 如何设计 API 接口,实现统一格式返回?

    怎么做全局的异常处理,篇幅原因,老顾这里就不做介绍了,只要思路理清楚了,自行改造就行。

    重写Controller

    Java 如何设计 API 接口,实现统一格式返回?

    在控制器类上或者方法体上加上@ResponseResult注解,这样就ok了,简单吧。到此返回的设计思路完成,是不是又简洁,又优雅。

    这个方案还有没有别的优化空间,当然是有的。

    如:每次请求都要反射一下,获取请求的方法是否需要包装,其实可以做个缓存,不需要每次都需要解析。当然整体思路了解,小伙伴们就可以在此基础上面自行扩展。


    我来说两句
    您需要登录后才可以评论 登录 | 立即注册
    facelist
    所有评论(0)
    领先的中文移动开发者社区
    18620764416
    7*24全天服务
    意见反?。[email protected]

    扫一扫关注我们

    Powered by Discuz! X3.2© 2001-2019 Comsenz Inc.( 香港生肖时时彩 )

  • 瑞金千人雨伞拼图创世界吉尼斯纪录 2019-07-02
  • “熊孩子”与幼儿教育 2019-06-15
  • 港媒称中国手游在韩国吸金美日手游遭韩玩家冷落 2019-06-15
  • 酒与植物 轻酌一樽是花香 2019-05-13
  • 台军为帮农民每餐吃香蕉 台媒改善两岸关系是根本 2019-05-12
  • 原脉——大地肌体上的血脉文章中国国家地理网 2019-05-11
  • 用更加过硬的作风追求改革新突破 2019-05-11
  • 欧版T90暴露法德坦克硬伤 VT4我离最强只差两步 2019-05-10
  • 【专题】河北省无偿献血领导小组会议报道 2019-05-10
  • 科幻推理剧《端脑》北京首映 搜狐匠心“烧脑”之作获赞 2019-05-09
  • 【大家谈】激励实干担当,谱写奋斗“进行曲” 2019-05-08
  • 回复@老老保老张工:连马克思都要重构个人所有制也!你不会自以为比马克思还高明吧? 2019-05-08
  • 学习宣传贯彻习近平新时代中国特色社会主义思想系列研讨会br第三场研讨会发言摘编 2019-05-07
  • 2000年出生的孩子属龙,要风得风,要雨得雨 2019-05-07
  • 美国防部宣布暂停8月美韩联合军演 2019-05-06
  • 梦幻西游109级干什么赚钱 银河棋牌赢钱的有吗 广东快乐十分走势图4 福彩3d跨度走势图连线 传奇彩票苹果 美女感受急速赛车漂移 大乐透历史开奖号码 中华彩票安卓 快乐十分必赢技巧 北京pk10直播开奖 金沙棋牌游戏官方下载 国际股票指数期货 3d字谜 微信点赞投票赚钱平台 东方6+1生肖开奖结果 大乐透开奖结果查询