调用枚举接口重写方法提示找不到符号_看看人家那后端API接口写得,那叫一个巴适~...
前言
在目前应用发达的场景下,我们往往需要接入客户端(win)、APP程序、网站程序、以及目前热火朝天的微信应用等,这些数据应该可以由同一个服务或者同事由多个提供, Web API作为整个纽带的核心,在整个核心层需要考虑到统一性、稳定性、以及安全性等方面因素。
一般系统大致架构如下:
需要说明的是,有些小伙伴会回复说,这个架构太简单了吧,太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状态码一起设计,如
再在枚举中定义,状态码
image
状态码和信息就会一一对应,比较好维护。
Data
返回数据体,JSON格式,根据不同的业务又不同的JSON体。
我们要设计一个返回体类Result
控制层Controller
我们会在controller层处理业务请求,并返回给前端,以order订单为例
我们看到在获得order对象之后,我们是用的Result构造方法进行包装赋值,然后进行返回。小伙伴们有没有发现,构造方法这样的包装是不是很麻烦,我们可以优化一下。
美观美化
我们可以在Result类中,加入静态方法,一看就懂
那我们来改造一下Controller
代码是不是比较简洁了,也美观了。
优雅优化
上面我们看到在Result类中增加了静态方法,使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题:
1、每个方法的返回都是Result封装对象,没有业务含义
2、在业务代码中,成功的时候我们调用Result.success,异常错误调用Result.failure。是不是很多余
3、上面的代码,判断id是否为null,其实我们可以使用validate做校验,没有必要在方法体中做判断。
我们最好的方式直接返回真实业务对象,最好不要改变之前的业务方式,如下图
这个和我们平时的代码是一样的,非常直观,直接返回order对象,这样是不是很完美。那实现方案是什么呢?
实现方案
小伙伴们怎么去实现是不是有点思路,在这个过程中,我们需要做几个事情
1、自定义一个注解@ResponseResult,表示这个接口返回的值需要包装一下
2、拦截请求,判断此请求是否需要被@ResponseResult注解
3、核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice,判断是否需要包装返回值,如果需要,就把Controller接口的返回值进行重写。
注解类
用来标记方法的返回值,是否需要包装
拦截器
拦截请求,是否此请求返回的值需要包装,其实就是运行的时候,解析@ResponseResult注解
此代码核心思想,就是获取此请求,是否需要返回值包装,设置一个属性标记。
重写返回体
上面代码就是判断是否需要返回值包装,如果需要就直接包装。这里我们只处理了正常成功的包装,如果方法体报异常怎么办?处理异常也比较简单,只要判断body是否为异常类。
重写Controller
在控制器类上或者方法体上加上自定义注解@ResponseResult,这样就ok了,简单吧。到此返回的设计思路完成,是不是又简洁,又优雅。
这个方案还有没有别的优化空间,当然是有的。如:每次请求都要反射一下,获取请求的方法是否需要包装,其实可以做个缓存,不需要每次都需要解析。当然整体思路了解,小伙伴们就可以在此基础上面再自行扩展。
作者:跟BUG杠上的程序汪
链接:https://www.jianshu.com/p/6c9b806d1f34
来源:简书
调用枚举接口重写方法提示找不到符号_看看人家那后端API接口写得,那叫一个巴适~...相关推荐
- nginx学习笔记002---Nginx代理配置_案例1_实现了对前端代码的方向代理_并且配置了后端api接口的访问地址
做个记录,以后做简单的nginx的时候拿过来就用 这个配置实现了,对前端html的方向代理,并且,配置了对后端api接口的方向代理 E:\nginx-1.14.0\conf\nginx.conf #u ...
- 运行java提示找不到符号_运行java代码时出现找不到符号错误怎么解决
运行java代码时出现找不到符号错误怎么解决 发布时间:2020-06-23 11:37:00 来源:亿速云 阅读:113 作者:Leah 运行java代码时出现找不到符号错误怎么解决?针对这个问题, ...
- python后端接口怎么写_看看人家那后端API接口写得,那叫一个优雅!
程序员的成长之路 互联网/程序员/技术/资料共享 阅读本文大概需要 4 分钟. 来自:今日头条,作者:老顾聊技术 链接:https://www.toutiao.com/i669440464582711 ...
- java写接口给前端_看看人家那后端API接口写得,那叫一个优雅!
来源: r6d.cn/tEvn 在移动互联网,分布式.微服务盛行的今天,现在 项目绝大部分都采用的微服务框架,前后端分离方式 ,(题外话: 前后端的工作职责越来越明确 ,现在的前端都称之为 大前端 , ...
- java 找不到符号 con_我的java程序运行时,提示找不到符号,求解!
我的java程序运行时,提示找不到符号,求解! 关注:163 答案:4 mip版 解决时间 2021-02-07 23:57 提问者人潮拥挤你不在 2021-02-06 23:57 import ...
- 在vscode里java插件无法编译和运行java源代码,提示找不到符号踩坑记录
如果不配置source path 会导致vscode的java插件无法编译和运行java源代码,提示找不到符号. 接下来配置source path 点击这里选择源码最外面的src目录,这样我们的pac ...
- maven打包提示找不到符号
刚入职的小伙伴,在用maven打包部署时会遇到maven提示找不到符号等错误 在用package打包自己模块时会提示找不到符号,我们install之后还是提示该错误 例如下图 这时我们可以选择打包in ...
- 为什么将表格的method改为post后就无法工作_不用再等后端的接口啦!这个开源项目花 2 分钟就能模拟出后端接口...
本文作者:HelloGitHub-嘉文 这里是 HelloGitHub 推出的<讲解开源项目>系列,今天给大家带来一款开源免费的模拟后端 API 的工具:moco 没学过后端开发的也能快速 ...
- 前后端API接口安全问题,防止抓包恶意请求
哈喽,你们好,这是我第一次发帖子,最近遇到了一些关于后端api接口的安全问题,相信很多刚开始接触前后端的人都会遇到这样的问题,如果后端写了一个数据库操作的接口供前端使用,而这些接口无论是GET请求还是 ...
最新文章
- 剑指offer_第13题_调整数组顺序使奇数位于偶数前面
- 自动化早已不是那个自动化
- 《NLTK基础教程——用NLTK和Python库构建机器学习应用》——2.11 小结
- Linux 配置jdk
- 前端python与php_WEB前端、PHP、python这三个学习哪一个比较好?
- 《Algorithms》Comparable 实现希尔排序
- Linux操作系统文件链接问题
- 大数据第一季--Hadoop(day1)-徐培成-专题视频课程
- JAVA单车管理系统计算机毕业设计Mybatis+系统+数据库+调试部署
- 汉洛塔问题(c解决)
- uIP编译时配置选项
- 笔记:Linux系统调用在文件中的分布情况
- 独立站谷歌付费广告关键词选词技巧实操
- 英语学习真的需要思考
- 微信小程序之发送通知消息(通过openid推送消息给用户)
- python版--百度人工智能接口(AIP)的调用方法
- 【科创人独家】知道创宇杨冀龙:技术人的商业思维都是锤出来的,真实需求长在客户的KPI上
- 【大数据开发】FlinkSQL实战
- Docker部署笔记--Redis集群主从容错切换迁移
- CockroachDB简介
热门文章
- jquery获取浏览器版本号_前端为什么弃用jQuery?有这六个原因
- Python中list复制引发的问题
- python strip() 函数探究
- Python小知识: List的赋值方法,不能直接等于
- Python面向对象:isinstance和issubclass
- mysql合并到区间_合并区间
- Android设置布局位置五等分,五等分划分屏幕
- C语言socket accept()函数(提取出所监听套接字的等待连接队列中第一个连接请求,创建一个新的套接字,并返回指向该套接字的文件描述符)
- 如何查看linux内核版本?(发行版本)
- 机器学习中为啥要有验证集?只要训练集和测试集不就可以了吗?