web前-JAVA后端 数据API接口交互协议

简介: 目前热门的主流web前端和Java后端数据技术架构:设备端和后台服务端,两者之间主要有两类的数据流和一类的控制流进行数据的交互。

前言

目前热门的主流web前端和Java后端数据技术架构:设备端和后台服务端,两者之间主要有两类的数据流和一类的控制流进行数据的交互。其图示可以根据下图的流程图表示:

2345_image_file_copy_180.jpg

这里的WebSocket就不进行详述,可以参考本人的另一篇关于WebSocket的介绍和使用的博客:VUE+websocket编写实现PC web端控制摄像头_丘比特惩罚陆的博客-CSDN博客

  上图的解析是,数据流1是某一功能的数据进行流动上报等操作,这一类饿交互关系采用的是http协议中的post请求,经过这一个请求报文可以将数据发送到平台上。数据流2是实时流的媒体数据,是由设备端将数据进行推流,推流到的地址可以是自己买的、拥有公网IP的媒体流转发服务器;第三个我们的控制流WebSocket意思是命令交互一类的数据,这一类的控制流数据采用的法式WebSocket长连接进行双向的交互模式,这个操作是由设备端发起进行连接的。

2345_image_file_copy_182.jpg

 WebSocket运行流程图

数据流1由设备端向平台web端主动发起数据请求,web平台在进行数据响应数据流1的数据后将状态上报接口时告知数据流2是否已经进行了数据连接,如果需要进行数据请求的话,那设备就会发起WebSocket数据长连接请求,进行如上的WebSocket运行流程过程。如果需要的话,那么设备端就可以发起请求,创建一个WebSocket的控制流通道,所以作为命令交互相互使用。数据流2可以由平台通过控制流通道线设备发送命令创建。

数据格式

http数据格式要求

http请求报文中通常包含请求行(requestline)、请求头(header)、空行、和请求数据(请求实体)这是个部分组成的,响应报文包含状态行、消息报头、空行、响应正文四样。

2345_image_file_copy_183.jpg

http协议对http交互中的请求行(接口地址)和请求数据/响应正文进行定义,约定请求数据和响应正文需要严格的json数据格式。

请求数据格式:

{
"id":"你写的东西",
"sessionId":"你要写的授权token",
"command":"你要请求命令(需要执行的动作)",
"params":{具体接口参数定义}
}

说明:

以上http所涉及到的所有请求接口都要必须遵循的格式定义,即所有http接口传输的请求数据都必须包含以上定义内容;

以上定义的请求数据统称“参数头”,具体赋值根据具体接口的要求进行组织;

“参数头”内params的值统称“参数体”,内容根据不同的接口具体定义不同,如“参数头”内需传输二进制内容,则需要先转为base64。

调用要求

1、http头必须设置Content-Type并取值application/json;

2、http必须post形式提交;

3、接口请求/响应实体放入http-body提交;

4、接口请求/响应实体使用标准json数据格式;

5、接口请求/响应实体必须按约定格式组织;

6、接口请求实体中参数体params赋值必须按接口约定赋值;

7、接口请求/响应实体统一使用UTF-8字符集。

响应代码定义表

响应代码定义表

image.png

image.png

WebSocket数据格式

Websocket是为了实现设备或浏览器(客户端)和平台(服务器)之间的高效双向全双工通信,连接建立后主要用于服务器主动向客户端推送命令进行实时远程控制(包括升级)。

WebSocket协议中最小的通信单位是帧,一帧中包含标识、操作代码、掩码、数据、数据长度和数据组成,数据部分可以由操作代码表明是文本还是二进制。

2345_image_file_copy_184.jpg

二进制帧请求格式

2345_image_file_copy_185.jpg

2345_image_file_copy_186.jpg

说明:

  1. 每一次数据发送,都采用固定12字节的头信息+消息体+数据体进行发送;
  2. 接收亦同,先接收12个字节头信息,根据头信息获取接下来的消息体和数据体;
  3. 其中消息体一般为JSON,协议格式同样的文本数据帧格式,数据体一般为二进制数据(图或文件);
  4. 发送和接收异步进行。

数据流http接口定义

接口参数(这里以控制流WebSocket的接口为例)

请求头

image.png

实例

{
"id":"0803502895724DBD9C49CA58C7D7DCC2",
"command":"GetParam",
"params":{}
}


相关文章
|
21天前
|
人工智能 自然语言处理 API
Multimodal Live API:谷歌推出新的 AI 接口,支持多模态交互和低延迟实时互动
谷歌推出的Multimodal Live API是一个支持多模态交互、低延迟实时互动的AI接口,能够处理文本、音频和视频输入,提供自然流畅的对话体验,适用于多种应用场景。
67 3
Multimodal Live API:谷歌推出新的 AI 接口,支持多模态交互和低延迟实时互动
|
2月前
|
JSON 缓存 测试技术
构建高效RESTful API的后端实践指南####
本文将深入探讨如何设计并实现一个高效、可扩展且易于维护的RESTful API。不同于传统的摘要概述,本节将直接以行动指南的形式,列出构建RESTful API时必须遵循的核心原则与最佳实践,旨在为开发者提供一套直接可行的实施框架,快速提升API设计与开发能力。 ####
|
2月前
|
JSON API 数据格式
探索后端开发:从零构建简易RESTful API
在数字时代的浪潮中,后端开发如同搭建一座桥梁,连接着用户界面与数据世界。本文将引导读者步入后端开发的殿堂,通过构建一个简易的RESTful API,揭示其背后的逻辑与魅力。我们将从基础概念出发,逐步深入到实际操作,不仅分享代码示例,更探讨如何思考和解决问题,让每一位读者都能在后端开发的道路上迈出坚实的一步。
|
2月前
|
缓存 前端开发 API
深入浅出:后端开发中的RESTful API设计原则
【10月更文挑战第43天】在数字化浪潮中,后端开发如同搭建梦想的脚手架,而RESTful API则是连接梦想与现实的桥梁。本文将带你领略API设计的哲学之美,探索如何通过简洁明了的设计,提升开发效率与用户体验。从资源定位到接口约束,从状态转换到性能优化,我们将一步步构建高效、易用、可维护的后端服务。无论你是初涉后端的新手,还是寻求进阶的开发者,这篇文章都将为你的开发之路提供指引。让我们一起走进RESTful API的世界,解锁后端开发的新篇章。
|
2月前
|
缓存 API 开发者
构建高效后端服务:RESTful API设计原则与实践
【10月更文挑战第43天】在数字化时代的浪潮中,后端服务的稳定性和效率成为企业竞争力的关键。本文将深入探讨如何构建高效的后端服务,重点介绍RESTful API的设计原则和实践技巧,帮助开发者提升服务的可用性、可扩展性和安全性。通过实际代码示例,我们将展示如何将这些原则应用到日常开发工作中,以确保后端服务能够支撑起现代Web和移动应用的需求。
|
2月前
|
存储 JSON 测试技术
构建高效后端API:实践和原则
【10月更文挑战第43天】本文深入探讨了如何设计和实现高效、可维护的后端API,强调了设计哲学、最佳实践和常见陷阱。通过具体示例,我们展示了如何运用这些原则来提高API的性能和可用性。
|
2月前
|
JSON API 开发者
构建高效API:后端开发中的RESTful最佳实践####
在数字化时代,API作为不同系统间通信的桥梁,其重要性日益凸显。本文将深入探讨RESTful API的设计原则与最佳实践,通过实际案例分析,揭示如何构建高效、可维护且易于使用的API接口,助力后端开发者提升项目质量与用户体验。 ####
|
2月前
|
安全 测试技术 API
构建高效RESTful API:后端开发的艺术与实践####
在现代软件开发的浩瀚星空中,RESTful API如同一座桥梁,连接着前端世界的绚丽多彩与后端逻辑的深邃复杂。本文旨在探讨如何精心打造一款既高效又易于维护的RESTful API,通过深入浅出的方式,剖析其设计原则、实现技巧及最佳实践,为后端开发者提供一份实用的指南。我们不深入晦涩的理论,只聚焦于那些能够即刻提升API品质与开发效率的关键点,让你的API在众多服务中脱颖而出。 ####
35 0
|
25天前
|
存储 缓存 负载均衡
后端开发中的性能优化策略
本文将探讨几种常见的后端性能优化策略,包括代码层面的优化、数据库查询优化、缓存机制的应用以及负载均衡的实现。通过这些方法,开发者可以显著提升系统的响应速度和处理能力,从而提供更好的用户体验。
51 4
|
4天前
|
开发框架 小程序 前端开发
圈子社交app前端+后端源码,uniapp社交兴趣圈子开发,框架php圈子小程序安装搭建
本文介绍了圈子社交APP的源码获取、分析与定制,PHP实现的圈子框架设计及代码编写,以及圈子小程序的安装搭建。涵盖环境配置、数据库设计、前后端开发与接口对接等内容,确保平台的安全性、性能和功能完整性。通过详细指导,帮助开发者快速搭建稳定可靠的圈子社交平台。