前后端数据传输约定探讨

京东云开发者
• 阅读 33

1 目的

稳定可靠,降本增效



前后端数据传输约定探讨



前后端数据传输约定旨在提升系统稳定性、可靠性,降低线上线下bug率;并提升研发效率、降低沟通成本、降低延期率。是确保项目前端和后端开发顺利进行的重要规约之一,定义了前端与后端交互的规则和标准。



2 数据传输约定

2.1 数据向后端传递,及在前端流转



前后端数据传输约定探讨



1.前端URL传参:原则上只允许传id参数,尽量不要在URL中传入中文参数及有关状态判断参数。

2.数据提交:明确表单数据类型,包括是否必填校验、multipart数据以及其他复杂类型数据。

3.参数规范:详细描述接口所需的参数,包括参数名称、类型、是否必填、默认值、示例等。



2.2 数据从后端返回到前端



前后端数据传输约定探讨



1.正常数据格式:需定义单个数据、复杂数据、可能有的数据、无数据、分页数据、校验数据、特殊数据以及认证加密数据的格式。

2.异常数据格式:需包含异常状态码、异常名称、数据格式、错误类型码、异常发生位置以及异常描述,以便于前端正确处理和显示错误信息。

3.性能要求:接口的响应时间、并发处理能力、健壮性、稳定性、故障恢复、安全性等性能指标。

【措施】

•脚手架统一,建项目等。

•错误码标准:与http code对应建立统一标准的code码表示,标识错误码内容(规则,位数默认规则)和格式。



3 文档沟通规范

前后端服务接口应文档化,确保接口与文档先于前端开发,以便开发人员能够准确理解和使用接口。文档应包含接口地址、请求方式、请求参数、返回结果等详细信息;其中请求方式和返回结果需依据产品逻辑确定。



前后端数据传输约定探讨



1.RESTful API设计风格:这是一种基于HTTP协议的API设计风格,通过使用HTTP动词、URI和HTTP状态码来表示对资源的操作和请求结果,使接口设计更加简洁明了。

2.URL规范:接口的URL结构,包括基础路径、接口名以及参数传递方式(如查询参数、表单数据、JSON格式的请求体等)。

3.接口版本控制:为了保证接口的兼容性和可维护性,必要时可对接口进行版本控制。可以在URI中加入版本号或使用请求参数来区分版本信息。

4.参数传递方式:明确参数的传递方式,包括GET、POST、PUT、DELETE等方式以及参数的格式(如JSON、表单等)。

5.返回结果格式:接口返回结果应使用统一的格式,包括状态码、错误信息、数据等。建议使用JSON格式,以方便表示复杂的数据结构。

【措施】

•接口文档工具统一和推广:可确定选用Japi或藏经阁

4 架构设计和数据结构

4.1 前端规则



前后端数据传输约定探讨



1.体验优先:尽可能优化用户体验操作步骤,满足产品要求,并及时提出交互建议。

2.SDK版本维护:多个系统调用前端地址或sdk时,需做好版本维护,特殊场景最好固定特殊版本,严格控制通用版本的升级。

3.防抖节流:前端请求防抖策略,函数节流策略。

4.代码合并:代码合并至main分支时,务必保证自己的代码是基于main分支的最新提交拉取的代码(可以先从main再拉出个hotfix分支,先和并至hotfix分支后,再合并至main分支)。

【措施】

•行云代码合并检测。

•加版本号,严格版本管理。

4.2 架构方案设计

1.架构设计和代码实现解耦:架构设计根据产品逻辑设计系统功能的架构方案、数据传输交互、技术选型、逻辑方案;代码实现则主要侧重于具体程序编码、规范、具体数据处理。



前后端数据传输约定探讨



1.前端逻辑扩展性:前端设计依据产品交互逻辑,需考虑交互逻辑扩展性;数据处理中需注意深拷贝问题。



前后端数据传输约定探讨



1.后端接口易用性:后端设计可根据自身要求定制,但给到前端接口的数据结构需要依据产品业务逻辑。

2.前后端分离:提前约定数据结构,并按数据结构进行开发。

3.前端直接暴露公网的,要做好安全防范,防止XSS,CSRF等攻击,涉及数据隐私、传输、攻击的续作加密解密处理。后端接口则需做SSRF攻击防范。

【措施】

•前后端耦合系统做分离(开发分离,发布分离)

•重点类型规则:金额、时间等重点核心数据枚举类型。

4.3数据结构设计



前后端数据传输约定探讨



1.数据结构恒定性:前后端约定好的字段和类型不应轻易改动,若有改动需及时提前告知对方。

2.鲁棒边缘性设计:接口需考虑极端情况下的限定,定义必须清楚(如不同类型字段为空时,为null时,为无穷大时,为负时等)。

3.数据结构简洁:数据接口字段应遵循尽明确,尽简单,尽少量,尽少层,尽可能都用,可扩展。

4.数据类型一致性:前后端数据类型一致性。

5.【特别约定】:后端不能用int类型接受前端传值(int默认值为0);若用Int类型接收,则务必进行包装处理异常。

4.4 安全与健壮



前后端数据传输约定探讨



1.前后端接口数据校验:重要数据传输(如费用资金等),后端须做接口兜底校验,同时前端需要做逻辑校验(甚至加解密机制);还包括三方接口使用的兜底处理和预警。

2.请求头约定:前后端应约定请求头,而不是只用系统默认(jdk不同版本接受数据的默认请求头可能不一样)。

3.接口一致性:同一功能的增加和修改等应尽量为同一接口;若否,则需说明理由。

4.日志记录:接口逻辑需要清晰必要的日志进行记录,方便查询。

5.接口防抖,幂等:必要时后端服务也需做防抖(如用户点错某一逻辑,又快速点击另一逻辑等)。。

6.混沌实验:必要时,需要做混沌工程实验,演练最小化“爆炸半径”。

4.5 DSL规约

根据对DSL(Domain Specific Language)的使用情况,选择sdl规约的分级策略;即根据具体业务逻辑的复杂度来考虑遵循规约的量级。



前后端数据传输约定探讨



•对于只展示不修改类场景,前端可直接做好dsl存给服务端即可。如cdp的图状逻辑展示。

•对于前后端都需要使用的dsl数据,尽可能把数据分成实体数据和展示数据两部分,前后端需共同维护实体数据;尤其单线流程场景。如领航者的流程编排。

•对于前后端都需要用到的更复杂流程逻辑判断类的产品,则需要维护dsl的不同版本。如摹略的画布逻辑。



前后端数据传输约定探讨



1.一套:前后端共同维护并解析使用同一套数据。两部分:数据最好能区分前端自用字段和前后端公用字段。

2.约定好前端自用字段增加的规则和限制(长度等)。

3.共同约定公用字段的增减规则(类型和层级等)。

4.更复杂场景里,可用不同版本,或协议版本;也可以只存1部分数据,前后端分别解析,维护不同版本。



{
    code:'',或数字约定
    data:{},
    msg:''
}

思路

5 实践方式

新项目迭代

对于新项目可直接根据具体需求依照本规范执行即可。执行过程中可根据需求的实际情况得到具体产品线的细则。

老项目升级

1.对于老项目,前后端需经过阶段性自查,尤其针对这些可能直接影响系统稳定性的核心条款,必须严格自查。

2.自查后,记录系统存在的相应隐患问题,再做出更新计划,最好在接下来的迭代中就能完成;必要时,也可按Q或H维度计划完成。

3.其他规约条款,尽可能的形成本系统的实际规范约定,前后端共同遵守,提高沟通效率,降低bug率。

6 总结

前后端数据传输约定是确保互联网产品顺畅运行的关键环节,它涉及到数据的格式、传输方式、安全性等多个方面。本文主要探讨交互的具体环节。

总之,根据具体业务的不同,以及技术的不断发展完善,我们还需要不断在实践中完善和改进这些规约,以适应新的需求和挑战。

欢迎兄弟们共同交流探讨👏🏻

点赞
收藏
评论区
推荐文章
Symbol卢 Symbol卢
2年前
聊聊前后端接口对接的那些事
前言在现在的前后端分离的项目开发中,为了不影响项目的进度,都是前后端同时进行开发。为了不影响咱们前端开发的进度,通常都是由后端同学,先提供接口文档,然后前端同学对照这接口文档来进行数据的模拟来完成前后端对接的工作。这里的数据模拟其实也就是大家平时所说的mock数据,那么前端当中有哪些方式来实现mock数据呢???…(⊙_⊙;)…咱们接着往下聊!(●^o^●)
kenx kenx
3年前
Spring Boot 无侵入式 实现RESTful API接口统一JSON格式返回
前言现在我们做项目基本上中大型项目都是选择前后端分离,前后端分离已经成了一个趋势了,所以总这样·我们就要和前端约定统一的api接口返回json格式,这样我们需要封装一个统一通用全局模版api返回格式,下次再写项目时候直接拿来用就可以了约定JSON格式一般我们和前端约定json格式是这样的json"code":200,"message
Wesley13 Wesley13
2年前
java将前端的json数组字符串转换为列表
记录下在前端通过ajax提交了一个json数组的字符串,在后端如何转换为列表。前端数据转化与请求varcontracts{id:'1',name:'yanggb合同1'},{id:'2',name:'yanggb合同2'},{id:'3',name:'yang
Chase620 Chase620
3年前
前端异常监控解决方案研究 – 腾讯CDC
前端监控包括行为监控、异常监控、性能监控等,本文主要讨论异常监控。对于前端而言,和后端处于同一个监控系统中,前端有自己的监控方案,后端也有自己等监控方案,但两者并不分离,因为一个用户在操作应用过程中如果出现异常,有可能是前端引起,也有可能是后端引起,需要有一个机制,将前后端串联起来,使监控本身统一于监控系统。因此,即使只讨论前端异常监控,其实也不能严格区分前
Easter79 Easter79
2年前
springboot2之优雅处理返回值
前言最近项目组有个老项目要进行前后端分离改造,应前端同学的要求,其后端提供的返回值格式需形如{"status":0,"message":"success","data":{}}方便前端数据处理。要实现前端同学这个需求,其实也挺简单的,
Stella981 Stella981
2年前
AJAX学习笔记(五、AJAX+JSON与Servlet前后端交互)
前后端分离实现前后端分离的好处就不用多说了,前后端那么JavaWeb项目前后端分离是怎么实现的呢?1.浏览器发送请求2.直接到达html页面(前端控制路由与渲染页面,整个项目开发的权重前移)3.html页面负责调用服务端接口产生数据(通过ajax等等,后台返回json格式数据,json数据格式因为简洁高效而取代xml)
Stella981 Stella981
2年前
DevOps 视角的前后端分离与实战
本文作者:CODING廖红坤前言随着微前端、微服务等技术理念和架构的蓬勃发展,我们已经没必要去讨论为什么要前后端分离这种话题,前后端分离已成为互联网项目开发的标准模式。前后端在各自的领域发展越来越纵深。!1(https://static.oschina.net/uploads/img/202011/03155102_VGNk.
Wesley13 Wesley13
2年前
Java面向对象之多态(来源于身边的案例)
2019年1月3日 星期四Java面向对象之多态(来源于身边的案例)1\.为什么要用多态?1.1 多态是面向对象的三大特性之一1.2 多态是基于接口设计的模型1.3 多态具有横向扩展特性1.4 可以非常标准匹配“依赖倒置原则”,降低前端与后端间的耦合2.不一样的多态案例2.1 UML静态模型图!