在需要实时更新数据的接口中使用 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

相关文章

Flutter监听当前页面可见与隐藏状态的代码详解

《Flutter监听当前页面可见与隐藏状态的代码详解》文章介绍了如何在Flutter中使用路由观察者来监听应用进入前台或后台状态以及页面的显示和隐藏,并通过代码示例讲解的非常详细,需要的朋友可以参考下... flutter 可以监听 app 进入前台还是后台状态,也可以监听当http://www.cppcn

Python使用PIL库将PNG图片转换为ICO图标的示例代码

《Python使用PIL库将PNG图片转换为ICO图标的示例代码》在软件开发和网站设计中,ICO图标是一种常用的图像格式,特别适用于应用程序图标、网页收藏夹图标等场景,本文将介绍如何使用Python的... 目录引言准备工作代码解析实践操作结果展示结语引言在软件开发和网站设计中,ICO图标是一种常用的图像

使用Java发送邮件到QQ邮箱的完整指南

《使用Java发送邮件到QQ邮箱的完整指南》在现代软件开发中,邮件发送功能是一个常见的需求,无论是用户注册验证、密码重置,还是系统通知,邮件都是一种重要的通信方式,本文将详细介绍如何使用Java编写程... 目录引言1. 准备工作1.1 获取QQ邮箱的SMTP授权码1.2 添加JavaMail依赖2. 实现

MyBatis与其使用方法示例详解

《MyBatis与其使用方法示例详解》MyBatis是一个支持自定义SQL的持久层框架,通过XML文件实现SQL配置和数据映射,简化了JDBC代码的编写,本文给大家介绍MyBatis与其使用方法讲解,... 目录ORM缺优分析MyBATisMyBatis的工作流程MyBatis的基本使用环境准备MyBati

使用Python开发一个图像标注与OCR识别工具

《使用Python开发一个图像标注与OCR识别工具》:本文主要介绍一个使用Python开发的工具,允许用户在图像上进行矩形标注,使用OCR对标注区域进行文本识别,并将结果保存为Excel文件,感兴... 目录项目简介1. 图像加载与显示2. 矩形标注3. OCR识别4. 标注的保存与加载5. 裁剪与重置图像

使用Python实现表格字段智能去重

《使用Python实现表格字段智能去重》在数据分析和处理过程中,数据清洗是一个至关重要的步骤,其中字段去重是一个常见且关键的任务,下面我们看看如何使用Python进行表格字段智能去重吧... 目录一、引言二、数据重复问题的常见场景与影响三、python在数据清洗中的优势四、基于Python的表格字段智能去重

使用Apache POI在Java中实现Excel单元格的合并

《使用ApachePOI在Java中实现Excel单元格的合并》在日常工作中,Excel是一个不可或缺的工具,尤其是在处理大量数据时,本文将介绍如何使用ApachePOI库在Java中实现Excel... 目录工具类介绍工具类代码调用示例依赖配置总结在日常工作中,Excel 是一个不可或缺的工http://

Java8需要知道的4个函数式接口简单教程

《Java8需要知道的4个函数式接口简单教程》:本文主要介绍Java8中引入的函数式接口,包括Consumer、Supplier、Predicate和Function,以及它们的用法和特点,文中... 目录什么是函数是接口?Consumer接口定义核心特点注意事项常见用法1.基本用法2.结合andThen链

Java之并行流(Parallel Stream)使用详解

《Java之并行流(ParallelStream)使用详解》Java并行流(ParallelStream)通过多线程并行处理集合数据,利用Fork/Join框架加速计算,适用于大规模数据集和计算密集... 目录Java并行流(Parallel Stream)1. 核心概念与原理2. 创建并行流的方式3. 适

如何使用Docker部署FTP和Nginx并通过HTTP访问FTP里的文件

《如何使用Docker部署FTP和Nginx并通过HTTP访问FTP里的文件》本文介绍了如何使用Docker部署FTP服务器和Nginx,并通过HTTP访问FTP中的文件,通过将FTP数据目录挂载到N... 目录docker部署FTP和Nginx并通过HTTP访问FTP里的文件1. 部署 FTP 服务器 (