欣赏一下人家写的后端API接口,那叫一个优雅!

bigdata 2020-12-04 11:26:51 ⋅ 432 阅读

作者:码不动
链接:https://www.jianshu.com/p/fa75acba5b07

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

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

 

需要说明的是,有些小伙伴会回复说,这个架构太简单了吧,太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了,简单吧。到此返回的设计思路完成,是不是又简洁,又优雅。

总结

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


全部评论: 0

    我有话说:

    码云推荐:一个优秀分布式spring boot/Spring Cloud API限流框架,特别适合微服务架构

    一个优秀分布式spring boot/Spring Cloud API限流框架,特别适合微服务架构.

    谷歌AI创造了AI,比人类编写更加强大

    AI也能自行繁衍了。根据外媒报道。谷歌AI系统AutoML创造了一个AI——NASNet,测试发现,NASNet表现已经比人类工程师撰写AI更为强大。ML是机器学习(machine

    Mocker API 2.7.0 为 REST API 创建模拟 API

    mocker-api 为 REST API 创建模拟 API。 当您尝试在没有实际 REST API 服务器情况下测试应用程序时,它会很有用。 特征: 🔥内置支持热 Mocker

    阿里一面:如何保证API接口数据安全?

    TPS:本文转载自头条号:老顾聊技术 原文:https://www.toutiao.com/i6869353034188030471 前言 前后分离开发方式,我们以接口为标准来进行推动,定义好

    MySql实战篇:一个简单存储过程,完成订单定时任务

    前言之前我们分享了MySql性能优化、索引详解等内容,本篇文章主要是针对想要入门MySql存储过程读者,主要实现业务是订单库里面超过30分钟没有支付订单全部置为失效订单......

    架构实战篇(二)-Spring Boot整合Swagger,让你API可视化

    你还在跟前上花费很多时间而没有效果吗?你还在为接口文档而烦恼吗?今天就教大家一个接口对接神器...

    Redisson 3.13.6 发布,官方推荐 Redis 客户

    Redisson 3.13.6 已发布,这是一个 Java 编写 Redis 客户,具备驻内存数据网格(In-Memory Data Grid)功能,并获得了 Redis 官方推荐

    「小米技术」Soar一键优化工具--SQL优化和改自动化工具

    SOAR(SQL Optimizer And Rewriter)是一个对SQL进行优化和改自动化工具。由小米人工智能与云平台数据库团队开发与维护。

    精品推荐:如何实现一个TCC分布式事务框架一点思考

    本文将以Spring容器为例,试图分析一下,实现一个通用TCC分布式事务框架需要注意一些问题。

    【开源资讯】WinSCP 5.17.8 发布,Windows 图形化 SFTP 客户

    WinSCP 是一个 Windows 环境下使用 SSH 开源图形化 SFTP 客户,同时支持 SCP 协议,它主要功能是在本地与

    老板要我开发一个简单工作流引擎

    第1关 一天,老板找到我,说要做个简单工作流引擎。 我查了一天啥是工作流,然后做出了如下版本: 按顺序添加任意个审批人组成一个链表,最后加一个结束节点 记录当前审批人,当审批完,审批人向

    一个有效学习者

    万物相通,借互联网日新月异,献给努力生活所有人。

    为什么很多大公司选择使用 Node.js 做 Web

      大佬们问一下,为什么大公司要用Node.js 做web?并且Node 还要调用Java做数据落地?在网上看了一些帖子,发现很多大厂都是这样做,我们公司项目也是这样,但是在开发

    有趣404页面设计鉴赏

    经过设计,这个提示页面会更友好些,下面来欣赏一波404页面设计。

    Cookie 和Session不难,一个是Mapkey,一个是Mapvalue

    本文分别对Cookie与Session做一个介绍和总结,并分别对两个知识点进行对比分析,让大家对Cookie和Session有一个更深入了解,并对自己开发工作中灵活运用带来启示。

    「开源-前端」vue全家桶制作一个精致仿美团项目

    一款集点菜、用户评价和商家信息为一体移动端点餐APP

    跳槽5个误区,冷静一下

    最近看到一篇发布在《哈佛商业评论》上一篇文章,作者是鲍里斯·格罗伊斯伯格(Boris Groysberg)

    简单解析一下扫码登陆原理

    作者:代码木公

    程序员注意啦!2018已过完一半

    凡事得有个顺序与标杆,作为开发人员更不例外 可能你正处在其中一个阶段 宏观审视自身技能树,更是查漏补