在需要实时更新数据的接口中使用 304 状态码

2024-03-10 18:18

本文主要是介绍在需要实时更新数据的接口中使用 304 状态码,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一、前言

Http 状态码是接口设计中不可或缺的一部分,它简洁却蕴含着丰富的含义,这里就简单介绍一下 304 状态码的使用示例吧。

二、场景

比如最近的一个需求是:在 Web 页面中查看任务详情时,要求能够不刷新页面便自动的更新它的状态与日志等信息(任务的执行会花费一定的时间,同时后台在处理任务的过程中会同步它的状态与日志的更新)。

三、分析与方案

使用Ajax不定时的获取数据是肯定的(不采用WebSocket方式),问题在于如何获取与传输数据。

因为任务的状态更新可接受短暂的延时,所以不必采用长连接的方式,客户端只需要定时往服务器发送获取数据的请求即可,但是任务的数据量较大,如果任务并未发生改变,就查询它全部的相关信息并返回到客户端对性能而言必然不是最优的选择,所以我们需要在它发生改变后才查询并返回数据,那么这里就可以引入 304 状态码来解决任务无变化时的返回结果。

304 Not Modified,只读/无变化

由于任务在更新状态或日志时,都会同时更新最后修改时间字段(modified),所以只需要客户端在请求时传入上一次的最后更新时间,服务端以此作为比较,便可知数据是否有发生改变,Api 请求示例如下:

/api/task/{id}/details?modified=1507716647

服务端:
1) 如果判断数据发生变化,则获取最新的数据并返回
2) 如果判断数据未发生改变,则返回空的数据,并返回304状态码

客户端:
1) 客户端收到返回的结果后,只需要根据状态码便可作出对应的操作

以上的请求是使用短连接轮询的方式,然而在实际中即使使用长连接也可使用此种方式。

四、附录

Http 状态码的作用远不止于,根据业务的实际情况可灵活的选择使用,当然每一个状态码的使用都应该尽量满足它的本意,下面就贴一下常用状态码的大概含义吧:

1xx 消息
100:继续 Contine
101:转换协议 Switching Protocols

2xx 成功
200:OK
201:创建 Created
202:接受 Accepted
203:非权威信息 Non-Authoritative Information
204:无内容 No Content
205:重置内容 Reset Content
206:局部内容 Partial Content

3xx 重定向
300:多样选择 Multiple Choices
301:永久移动 Moved Permanently
302:创建 Move temporarily
303:观察别的部分 See Other
304:只读/无变化 Not Modified
305:用户代理 Use Proxy
307:临时重发 Temporary Redirect

4xx 请求错误
400:坏请求 Bad Request
401:未授权的 Unauthorized
402:必要的文件 Payment Required
403:禁用 Forbidden
404:没找到 Not Found
405:不允许的方式 Method Not Allowed
406:不接受 Not Acceptable
407:需要代理验证 Proxy Authentication Required
408:请求超时 Request Timeout
409:冲突 Conflict
410:停止 Gone
411:需要的长度 Length Required
412:预处理失败 Precondition Failed
413:请求实体太长 Request Entity Too Large
414:请求URI太长 Request-URL Too Long
415:不支持的媒体类型 Unsupported Media Type
416:请求的范围不满足 Requested Range Not Satisfiable
417:期望失败 Expectation Failed

5xx 服务器错误
500:服务器内部错误 Internal Server Error
501:不能实现 Not Implemented
502:坏网关 Bad Gateway
503:服务不能实现 Service Unavailable
504:网关超时 Gateway Timeout
505:HTTP版本不支持 HTTP Version Not Supported

更多详细内容可参见RFC 2616文档

这篇关于在需要实时更新数据的接口中使用 304 状态码的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/795097

相关文章

SQL Server修改数据库名及物理数据文件名操作步骤

《SQLServer修改数据库名及物理数据文件名操作步骤》在SQLServer中重命名数据库是一个常见的操作,但需要确保用户具有足够的权限来执行此操作,:本文主要介绍SQLServer修改数据... 目录一、背景介绍二、操作步骤2.1 设置为单用户模式(断开连接)2.2 修改数据库名称2.3 查找逻辑文件名

Python常用命令提示符使用方法详解

《Python常用命令提示符使用方法详解》在学习python的过程中,我们需要用到命令提示符(CMD)进行环境的配置,:本文主要介绍Python常用命令提示符使用方法的相关资料,文中通过代码介绍的... 目录一、python环境基础命令【Windows】1、检查Python是否安装2、 查看Python的安

OpenCV实现实时颜色检测的示例

《OpenCV实现实时颜色检测的示例》本文主要介绍了OpenCV实现实时颜色检测的示例,通过HSV色彩空间转换和色调范围判断实现红黄绿蓝颜色检测,包含视频捕捉、区域标记、颜色分析等功能,具有一定的参考... 目录一、引言二、系统概述三、代码解析1. 导入库2. 颜色识别函数3. 主程序循环四、HSV色彩空间

Python并行处理实战之如何使用ProcessPoolExecutor加速计算

《Python并行处理实战之如何使用ProcessPoolExecutor加速计算》Python提供了多种并行处理的方式,其中concurrent.futures模块的ProcessPoolExecu... 目录简介完整代码示例代码解释1. 导入必要的模块2. 定义处理函数3. 主函数4. 生成数字列表5.

Python中help()和dir()函数的使用

《Python中help()和dir()函数的使用》我们经常需要查看某个对象(如模块、类、函数等)的属性和方法,Python提供了两个内置函数help()和dir(),它们可以帮助我们快速了解代... 目录1. 引言2. help() 函数2.1 作用2.2 使用方法2.3 示例(1) 查看内置函数的帮助(

Linux脚本(shell)的使用方式

《Linux脚本(shell)的使用方式》:本文主要介绍Linux脚本(shell)的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录概述语法详解数学运算表达式Shell变量变量分类环境变量Shell内部变量自定义变量:定义、赋值自定义变量:引用、修改、删

Java使用HttpClient实现图片下载与本地保存功能

《Java使用HttpClient实现图片下载与本地保存功能》在当今数字化时代,网络资源的获取与处理已成为软件开发中的常见需求,其中,图片作为网络上最常见的资源之一,其下载与保存功能在许多应用场景中都... 目录引言一、Apache HttpClient简介二、技术栈与环境准备三、实现图片下载与保存功能1.

Python中使用uv创建环境及原理举例详解

《Python中使用uv创建环境及原理举例详解》uv是Astral团队开发的高性能Python工具,整合包管理、虚拟环境、Python版本控制等功能,:本文主要介绍Python中使用uv创建环境及... 目录一、uv工具简介核心特点:二、安装uv1. 通过pip安装2. 通过脚本安装验证安装:配置镜像源(可

LiteFlow轻量级工作流引擎使用示例详解

《LiteFlow轻量级工作流引擎使用示例详解》:本文主要介绍LiteFlow是一个灵活、简洁且轻量的工作流引擎,适合用于中小型项目和微服务架构中的流程编排,本文给大家介绍LiteFlow轻量级工... 目录1. LiteFlow 主要特点2. 工作流定义方式3. LiteFlow 流程示例4. LiteF

使用Python开发一个现代化屏幕取色器

《使用Python开发一个现代化屏幕取色器》在UI设计、网页开发等场景中,颜色拾取是高频需求,:本文主要介绍如何使用Python开发一个现代化屏幕取色器,有需要的小伙伴可以参考一下... 目录一、项目概述二、核心功能解析2.1 实时颜色追踪2.2 智能颜色显示三、效果展示四、实现步骤详解4.1 环境配置4.