0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

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

算法与数据结构 来源:老顾聊技术 作者:老顾聊技术 2021-04-12 10:39 次阅读

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

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

d09d5484-9aae-11eb-8b86-12bb97331649.png

需要说明的是,有些小伙伴会回复说,这个架构太简单了吧,太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 - 内部服务器错误

d10d1b98-9aae-11eb-8b86-12bb97331649.png

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

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

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

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

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

Message

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

d120af8c-9aae-11eb-8b86-12bb97331649.png

再在枚举中定义,状态码

d14f432e-9aae-11eb-8b86-12bb97331649.png

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

Data

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

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

d29b9cb4-9aae-11eb-8b86-12bb97331649.png

控制层Controller

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

d2a88f5a-9aae-11eb-8b86-12bb97331649.png

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

美观优化

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

d3c3b874-9aae-11eb-8b86-12bb97331649.png

那我们来改造一下Controller

d3d66578-9aae-11eb-8b86-12bb97331649.png

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

优雅优化

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

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

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

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

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

d3e67ac6-9aae-11eb-8b86-12bb97331649.png

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

实现方案

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

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

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

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

注解类

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

d3f04e16-9aae-11eb-8b86-12bb97331649.png

拦截器

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

d40324dc-9aae-11eb-8b86-12bb97331649.png

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

重写返回体

d414f14e-9aae-11eb-8b86-12bb97331649.png

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

d42f5c32-9aae-11eb-8b86-12bb97331649.png

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

重写Controller

d43a6cda-9aae-11eb-8b86-12bb97331649.jpg

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

总结

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

原文标题:看看人家那后端API接口写得,那叫一个优雅!

文章出处:【微信公众号:算法与数据结构】欢迎添加关注!文章转载请注明出处。

责任编辑:haq

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 服务器
    +关注

    关注

    12

    文章

    9165

    浏览量

    85432
  • API
    API
    +关注

    关注

    2

    文章

    1501

    浏览量

    62032
  • 后端设计
    +关注

    关注

    0

    文章

    13

    浏览量

    8611

原文标题:看看人家那后端API接口写得,那叫一个优雅!

文章出处:【微信号:TheAlgorithm,微信公众号:算法与数据结构】欢迎添加关注!文章转载请注明出处。

收藏 人收藏

    相关推荐

    Python中代理服务器的配置与应用

    在网络通信中,代理服务器作为一种重要的网络中间件,充当着客户端和目标服务器之间的中间人角色。它能够接收来自客户端的请求,并将这些请求转发给目标服务器,然后将服务器的响应
    的头像 发表于 11-12 07:13 176次阅读

    服务器数据恢复—Linux网站服务器硬盘出现坏扇区的数据恢复案例

    服务器数据恢复环境: 一台linux操作系统网站服务器,该服务器上部署了几十个网站,使用一块SATA硬盘。 服务器故障&原因:
    的头像 发表于 10-09 16:26 214次阅读

    不只是前端后端、产品和测试也需要了解的浏览知识(二)

    过程中不断创新,推动产品性能、用户体验的提升,来实现业务的增长,创造可持续的价值 。 一、 业务系统呈现用户的节点 当用户访问我们的业务系统时,浏览服务器之间会进行一系列复杂的交
    的头像 发表于 08-12 14:32 350次阅读
    不只是<b class='flag-5'>前端</b>,<b class='flag-5'>后端</b>、产品和测试也需要了解的浏览<b class='flag-5'>器</b>知识(二)

    什么是模拟前端和模拟后端 模拟前端与模拟后端的区别

    模拟前端和模拟后端是电子系统设计中的两个关键部分,它们在信号处理过程中扮演着不同的角色,各自具有独特的功能和重要性。
    的头像 发表于 03-16 15:21 2688次阅读

    模拟前端后端的区别

    模拟前端和模拟后端在电子系统设计中各自扮演着重要的角色,它们之间有着明显的区别。
    的头像 发表于 03-15 15:59 1066次阅读

    服务器数据恢复—服务器硬盘灯显示红色,服务器崩溃的数据恢复案例

    一台服务器中有一组由多块硬盘组建的raid阵列,在运行过程中服务器突然崩溃,管理员检查服务器发现该服务器raid阵列中有两块硬盘的指示灯显示红色。于是,管理员重启
    的头像 发表于 03-15 11:17 514次阅读
    <b class='flag-5'>服务器</b><b class='flag-5'>数据</b>恢复—<b class='flag-5'>服务器</b>硬盘灯显示红色,<b class='flag-5'>服务器</b>崩溃的<b class='flag-5'>数据</b>恢复案例

    服务器数据恢复—分享几个服务器数据恢复的案例

    服务器数据恢复案例之服务器raid6中3个磁盘离线导致阵列崩溃的数据恢复案例;服务器数据恢复案例
    的头像 发表于 03-04 13:21 1162次阅读

    服务器数据恢复-异常断电导致服务器故障的数据恢复案例

    服务器数据恢复环境: dell某型号服务器中有一组通过raid卡组建的raid10,该raid阵列中一共有4块磁盘。上层部署XenServer虚拟化平台,作为网站服务器使用。
    的头像 发表于 02-28 15:15 849次阅读
    <b class='flag-5'>服务器</b><b class='flag-5'>数据</b>恢复-异常断电导致<b class='flag-5'>服务器</b>故障的<b class='flag-5'>数据</b>恢复案例

    服务器远程不上服务器怎么办?服务器无法远程的原因是什么?

    产生问题的原因,检查硬盘和服务器系统。通过日志和检查数据来确认问题出 现的原因以及如何解决。 三、端口问题 1.端口错误 找回正确的端口或更换远程端口 2.端口被扫爆 更改端口,并在防火墙禁止扫爆的IP
    发表于 02-27 16:21

    服务器数据恢复】硬盘坏道掉线导致服务器崩溃的数据恢复案例

    服务器数据恢复环境: 一台IBM某型号服务器上有16块FC硬盘组建RAID阵列。上层linux操作系统,ext3文件系统,部署有oracle数据库。
    的头像 发表于 02-26 11:36 847次阅读

    服务器数据恢复】断电导致服务器RAID信息丢失的数据恢复案例

    服务器数据恢复环境&故障: 某品牌服务器中有一组由数块SAS硬盘组建的RAID5磁盘阵列,服务器操作系统是WINDOWS SERVER,服务器
    的头像 发表于 02-18 13:53 667次阅读

    服务器数据恢复—非正常关机导致服务器文件丢失的数据恢复案例

    服务器数据恢复环境: 某品牌PowerEdge R730服务器+PowerVault MD3200存储,划分若干lun,操作系统版本是centos7,EXT4文件系统。 服务器
    的头像 发表于 01-19 13:42 526次阅读

    服务器数据恢复】服务器迁移数据数据损坏的数据恢复案例

    服务器数据恢复环境&服务器故障: 一台安装Windows操作系统的服务器。工作人员在迁移该服务器数据
    的头像 发表于 01-16 13:19 958次阅读

    服务器数据恢复】服务器raid5离线硬盘上线失败的数据恢复案例

    服务器数据恢复环境: 北京某教育机构一台服务器中有一组由3块磁盘组建的raid5阵列,服务器安装的windows server操作系统。
    的头像 发表于 01-05 13:46 535次阅读

    什么是web服务器?如何选择服务器配置?

    Web服务器是一种软件或硬件设备,用于托管和提供网页内容。它接收客户端(如浏览)发送的HTTP请求,并返回相应的网页内容或其他资源,以实现更高的性能和可靠性。它是网站和应用程序在互联
    的头像 发表于 01-03 15:25 1105次阅读