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

技术分享  / 只看大图  / 倒序浏览   ©

#楼主# 2019-11-6

跳转到指定楼层

马上注册,分享更多源码,享用更多功能,让你轻松玩转云大陆。

您需要 登录 才可以下载或查看,没有帐号?立即注册

x
前言

在移动互联网,分布式、微服务盛行的今天,现在项目绝大部分都采用的微服务框架,前后端分离方式,
(题外话:前后端的工作职责越来越明确,现在的前端都称之为大前端,技术栈以及生态圈都已经非常成熟;以前后端人员瞧不起前端人员,那现在后端人员要重新认识一下前端,前端已经很成体系了)
一般系统的大致整体架构图如下:
161539zlx5666k5l36gl77.jpg


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


因为老顾这篇主要介绍的是API接口,所以我们聚焦点,其他的板块小伙伴们自行去补充。
接口交互

前端和后端进行交互,前端按照约定请求URL路径,并传入相关参数,后端服务器接收请求,进行业务处理,返回数据给前端。
针对URL路径的restful风格,以及传入参数的公共请求头的要求(如:app_version,api_version,device等),老顾这里就不介绍了,小伙伴们可以自行去了解,也比较简单。
后端服务器如何实现把数据返回给前端?
返回格式

后端返回给前端我们一般用JSON体方式,定义如下:
CODE状态码
code返回状态码,一般小伙伴们是在开发的时候需要什么,就添加什么。
如接口要返回用户权限异常,我们加一个状态码为101吧,下一次又要加一个数据参数异常,就加一个102的状态码。这样虽然能够照常满足业务,但状态码太凌乱了
我们应该可以参考HTTP请求返回的状态码
161539nicc1civ3sgcsf46.jpg


我们可以参考这样的设计,这样的好处就把错误类型归类到某个区间内,假如区间不够,可以设计成4位数。
这样前端开发人员在得到返回值后,根据状态码就可以知道,大概什么错误,再根据message相关的信息描述,可以快速定位。
Message
这个字段相对理解比较简单,就是发生错误时,如何友好的进行提示。一般的设计是和code状态码一起设计,如:
161539t9wel9iac24zce3d.jpg


再在枚举中定义,状态码
161539acynzqeaeylex4rc.jpg


状态码和信息就会逐一对应,比较好维护。
Data
返回数据体,JSON格式,根据不同的业务又不同的JSON体。
我们要设计一个返回体类Result
161539qefiib4ue44wb0yp.jpg


控制层Controller

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


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

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


那我们来改造一下Controller
161540iwc39ctptbtazl3z.jpg


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

上面我们看到在Result类中添加了静态方法,使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题:
每个方法的返回都是Result封装对象,没有业务含义
在业务代码中,成功的时候我们调用Result.success,异常错误调用Result.failure。是不是很多余
上面的代码,判断id是否为null,其实我们可以使用hibernate validate做校验,没有必要在方法体中做判断。
我们最好的方式直接返回真实业务对象,最好不要改变之前的业务方式,如下图:
161540nxh88ysg33ldsssh.jpg


这个和我们平时的代码是一样的,非常直观,直接返回order对象,这样是不是很完美。
那实现方案是什么呢?

161540pvvsyvlvlweflvfs.jpg


实现方案

小伙伴们怎样去实现是不是有点思路,在这个过程中,我们需要做几个事情
定义一个注解@ResponseResult,表示这个接口返回的值需要包装一下
阻拦请求,判断此请求是否需要被@ResponseResult注解
核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice,判断是否需要包装返回值,假如需要,就把Controller接口的返回值进行重写。
注解类
用来标记方法的返回值,是否需要包装
161540u5vo4vgxpv4npoo4.jpg


阻拦器
阻拦请求,是否此请求返回的值需要包装,其实就是运行的时候,解析@ResponseResult注解
161540y4ku5zqtuh9yjytj.jpg


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


上面代码就是判断是否需要返回值包装,假如需要就直接包装。
这里我们只处理了正常成功的包装,假如方法体报异常怎样办?处理异常也比较简单,只要判断body是否为异常类。
161540l3zavx8abktqtk3t.jpg


怎样做全局的异常处理,篇幅原因,老顾这里就不做介绍了,只要思路理清楚了,自行改造就行。
重写Controller
161541gkskjk6ykiwrpy6h.jpg


在控制器类上或者方法体上加上@ResponseResult注解,这样就ok了,简单吧。到此返回的设计思路完成,是不是又简洁,又优雅。
这个方案还有没有别的优化空间,当然是有的。
如:每次请求都要反射一下,获取请求的方法是否需要包装,其实可以做个缓存,不需要每次都需要解析。当然整体思路了解,小伙伴们就可以在此基础上面自行扩展。
分享淘帖
回复

使用道具

您的回复是对作者最大的奖励

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

关于作者

花花_9158

新手猿

  • 主题

    4

  • 帖子

    4

  • 关注者

    0

Archiver|手机版|小黑屋|云大陆 | 赣ICP备18008958号-4|网站地图
Powered by vrarz.com!  © 2019-2020版权所有云大陆