看看人家那后端API接口写得,那叫一个优雅!

小郝不负流年
小郝不负流年   + 关注
2020-11-01 13:02:14   阅读133   评论0

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


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



需要说明的是,有些小伙伴会回复说,这个架构太简单了吧,太low了,什么网关啊,缓存啊,消息中间件啊,都没有。因为这篇主要介绍的是API接口,所以我们聚焦点,其他的模块小伙伴们自行去补充。

 

接口交互


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


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


着重介绍一下后端服务器如何实现把数据返回给前端?


返回格式


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


{
#返回状态码
code:integer,
#返回信息描述
message:string,
#返回值
data:object
}


CODE状态码


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


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


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



:下面是常见的HTTP状态码:

200 - 请求成功

301 - 资源(网页等)被永久转移到其它URL

404 - 请求的资源(网页等)不存在

500 - 内部服务器错误




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



#1000~1999 区间表示参数错误

#2000~2999 区间表示用户错误

#3000~3999 区间表示接口异常



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


Message


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



再在枚举中定义,状态码



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


Data


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

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



控制层Controller


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



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

 

美观优化


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



那我们来改造一下Controller



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


优雅优化


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

1、每个方法的返回都是Result封装对象,没有业务含义
2、在业务代码中,成功的时候我们调用Result.success,异常错误调用Result.failure。是不是很多余
3、上面的代码,判断id是否为null,其实我们可以使用hibernate validate做校验,没有必要在方法体中做判断。

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



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


实现方案


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

1、定义一个注解@ResponseResult,表示这个接口返回的值需要包装一下
2、拦截请求,判断此请求是否需要被@ResponseResult注解
3、核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice,判断是否需要包装返回值,如果需要,就把Controller接口的返回值进行重写。

注解类


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


拦截器


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



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


重写返回体



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



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


重写Controller



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


总结


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


文章来源:r6d.cn/tEvn
对我有用,我要     转载  
文章分类: Java  
所属标签: api  
  • 0条评论
  • 只看作者
  • 按时间|按热度
  • 由于本人多次涉及需要打印这个证明,而每次都会忘记入口,在网上各种搜索各种摸索很是浪费时间。故本次将操作流程整理记录下来,以备忘。同时也分享给大家。1、打开湖北政务服务网,地址:http://zwfw.hubei.gov.cn/s/index.html2、切换区域到“武汉市”3、在“特色服务”模块找到“(个人)武汉市社会保险公共服务平台”4、进入“(个人)武汉市社会保险公共服务平台”,登录账号密码<imgsrc="https://cdnstatic.hoscen.cn/blog/article/184053017752895488/img/497065960be44747825acb86a17483c1.png"style=
  • 如何使用postman模拟http发送xml参数报文的POST请求?1、postman工具通过安装软件或使用谷歌插件都可以,这里不再赘述。2、配置postman,选择POST,填写URL;切换到Headers,添加Content-Type:text/xml 3、切换到body,选择raw,XML,下方填写你的请求报文4、点击Send发送请求,如图可以看到响应状态、时间、结果等信息5、讲到这里就结束了,是不是学会了?快去试试吧!
  • 下载地址:https://adoptopenjdk.net/releases.html?variant=openjdk8&jvmVariant=hotspot选择文件类型:或者,你可以通过我的百度网盘分享直接获取:链接:https://pan.baidu.com/s/1UygOdTh6WNZyS5WP_API6w 提取码:phnh 注意:我这里是下载的32的jdk,你们如果要64位请下载64的。使用:使用上和OracleJDK使用上是没有区别的。区别:1.OracleJDK⼤概每6个⽉发⼀次主要版本,⽽OpenJDK版本⼤概每三个⽉发布⼀次。但这不是固定的,我觉得了解这个没啥⽤处。详情参⻅:https://blogs.oracle.com/java-platform-group/update-and-faq-on-the-java-se-release-cadence。 2.OpenJDK是⼀个参考模型并且是完全开源的,⽽OracleJDK是OpenJDK的⼀个实现,并不是完全开源的; 3.OracleJDK⽐OpenJDK更稳定。OpenJDK和OracleJDK的代码⼏乎相同,但OracleJDK有更多的类和⼀些错误修复。因此,如果您
  • 很多时候我们需要Linux服务器定时去运行一个脚本来触发一个操作,比如写缓存数据到硬盘、定时备份、定时重启服务、定期清除日志等。下面就简单讲解一下Linuxcrontab命令如何实现自动循环执行shell脚本。一、准备shell脚本比如我们准备一个hello.shvim/hcn/sh/hello.sh#!/bin/bash  DATETIME=$(date"+%Y%m%d%H%M%S") echo"hello, www.hoscen.cn,时间:${DATETIME}"  通过chmod命令赋予该脚本的执行权限chmod755hello.sh测试正确性二、开启crontab服务 linux应该都有crontab,没有的话可以安装一下:yuminstall vixie-cronyuminstall crontabsvixie-cron软
  • 目录:1、安装node.js环境2、安装cnpm3、安装vue-cli脚手架构建工具4、用vue-cli构建项目5、安装项目所需的依赖6、项目运行7、项目打包1、安装node.js环境下载地址:https://nodejs.org/zh-cn/安装过程没有太多好说的,安装完成后 win+R打开命令行输入node -v , 如图,出现版本号说明安装成功。npm包管理器是集成在node中的 , npm -v可以查看版本2、安装cnpm由于有些npm有些资源被屏蔽或者是国外资源的原因,经常会导致用npm安装依赖包的时
  • 本文讲触发el-dialog前动态修改窗口title的方法。1、el-dialog添加title属性el-dialog :title="titleType+'菜单'" :visible.sync="dialogVisible" width="800px" >el-dialog>  2、初始化变量(titleType,名称自己定义)export&
  • 一般我们在使用CDN时都设置有缓存时间,当源站资源发生变更后,如果缓存时间没到,那么用户访问的依旧是变更前的数据,虽说又拍云控制台提供了缓存刷新功能界面,但是每次都手动去刷新显示不太理想,当然又拍云也想到了这一点,提供给我们有API可以调用。本篇文章就是讲解如何接入又拍云缓存刷新API。网站免费接入又拍云CDN的方法,请查看我另外一篇文章,地址: https://www.hoscen.cn/blog/hao/articles/204022774975430656.html又拍云API文档:https://api.upyun.com/doc#/api/guide/overview看完文档,我们会知道又拍云提供有两个缓存刷新接口,一个支持通配符(但次数有限),一个是完整url刷新。同时注意调用接口时将 Token 放入 HTTP Header 中 。那么我们需要3个接口:1、获取token2、URL刷新3、缓存批量刷新详细请求参数和响应值请查看文档。话不多说,我们直接放上核心代码1、获取token2、URL刷新<img src="https://cdnstatic.hoscen.cn/blog/article/
  • 介绍为了支持异步处理,在Servlet3.0中,在ServletRequest上提供了startAsync()方法配置SpringMVC支持异步配置springmvc-servlet.xml:  mvc:annotation-driven>     mvc:async-support default-timeout="5000"/>   mvc:annotation-driven><
  • 标题里面的三个术语,很容易混淆,专业人员有时也会用错。本文就用图片解释它们有何区别。容错容错(faulttolerance)指的是, 发生故障时,系统还能继续运行。飞机有四个引擎,如果一个引擎坏了,剩下三个引擎,还能继续飞,这就是"容错"。同样的,汽车的一个轮子扎破了,剩下三个轮子,也还是勉强能行驶。容错的目的是,发生故障时,系统的运行水平可能有所下降,但是依然可用,不会完全失败。高可用高可用(highavailability)指的是, 系统能够比正常时间更久地保持一定的运行水平。<imgsrc="https://cdnstatic.ho
  • SQL计算日期相差多少分钟,示例SELECT  ROUND(TO_NUMBER(to_date(rs.t_cap_wf_finReq_start_date,'YYYY/MM/DDhh24:mi:ss')-to_date(rs.t_cap_wf_start_date,'YYYY/MM/DDhh24:mi:ss'))*24*60) FROM table_xxx 更多差值单位写法天:ROUND(TO_NUMBER(END_DATE-START_DATE))小时:ROUND(TO_NUMBER(END_DATE-START_DATE)*24)分钟:ROUND(TO_NUMBER(END_DATE-START_DATE)*24*60)秒:ROUND(TO_NUMBER(END_DATE-START_DATE)*24*60*60)毫秒:ROUND(TO_NUMBER(END_DATE-START_DATE)*24*60*60*1000)