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":{}
}


相关文章
|
23天前
|
监控 Java 应用服务中间件
高级java面试---spring.factories文件的解析源码API机制
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置、起步依赖和内嵌服务器等特性,极大地简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是spring.factories文件的解析源码API机制。
61 2
|
2月前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
52 4
|
1月前
|
缓存 监控 Java
如何运用JAVA开发API接口?
本文详细介绍了如何使用Java开发API接口,涵盖创建、实现、测试和部署接口的关键步骤。同时,讨论了接口的安全性设计和设计原则,帮助开发者构建高效、安全、易于维护的API接口。
81 4
|
1月前
|
前端开发 API 开发者
Python Web开发者必看!AJAX、Fetch API实战技巧,让前后端交互如丝般顺滑!
在Web开发中,前后端的高效交互是提升用户体验的关键。本文通过一个基于Flask框架的博客系统实战案例,详细介绍了如何使用AJAX和Fetch API实现不刷新页面查看评论的功能。从后端路由设置到前端请求处理,全面展示了这两种技术的应用技巧,帮助Python Web开发者提升项目质量和开发效率。
43 1
|
1月前
|
JSON API 数据格式
如何使用Python和Flask构建一个简单的RESTful API。Flask是一个轻量级的Web框架
本文介绍了如何使用Python和Flask构建一个简单的RESTful API。Flask是一个轻量级的Web框架,适合小型项目和微服务。文章从环境准备、创建基本Flask应用、定义资源和路由、请求和响应处理、错误处理等方面进行了详细说明,并提供了示例代码。通过这些步骤,读者可以快速上手构建自己的RESTful API。
38 2
|
1月前
|
JavaScript API 开发工具
<大厂实战场景> ~ Flutter&鸿蒙next 解析后端返回的 HTML 数据详解
本文介绍了如何在 Flutter 中解析后端返回的 HTML 数据。首先解释了 HTML 解析的概念,然后详细介绍了使用 `http` 和 `html` 库的步骤,包括添加依赖、获取 HTML 数据、解析 HTML 内容和在 Flutter UI 中显示解析结果。通过具体的代码示例,展示了如何从 URL 获取 HTML 并提取特定信息,如链接列表。希望本文能帮助你在 Flutter 应用中更好地处理 HTML 数据。
109 1
|
1月前
|
Java API 数据处理
探索Java中的Lambda表达式与Stream API
【10月更文挑战第22天】 在Java编程中,Lambda表达式和Stream API是两个强大的功能,它们极大地简化了代码的编写和提高了开发效率。本文将深入探讨这两个概念的基本用法、优势以及在实际项目中的应用案例,帮助读者更好地理解和运用这些现代Java特性。
|
2月前
|
Java 大数据 API
别死脑筋,赶紧学起来!Java之Steam() API 常用方法使用,让开发简单起来!
分享Java Stream API的常用方法,让开发更简单。涵盖filter、map、sorted等操作,提高代码效率与可读性。关注公众号,了解更多技术内容。
|
2月前
|
监控 负载均衡 API
Web、RESTful API 在微服务中有哪些作用?
在微服务架构中,Web 和 RESTful API 扮演着至关重要的角色。它们帮助实现服务之间的通信、数据交换和系统的可扩展性。
51 2
|
2月前
|
存储 安全 数据库
后端技术在现代Web开发中的实践与创新
【10月更文挑战第13天】 本文将深入探讨后端技术在现代Web开发中的重要性,通过实际案例分析展示如何利用先进的后端技术提升用户体验和系统性能。我们将从基础架构设计、数据库优化、安全性保障等方面展开讨论,为读者提供清晰的指导和实用的技巧。无论是新手开发者还是经验丰富的技术人员,都能从中获得启发和帮助。
42 2