使用ETag协议实现ASP.NET Core API缓存

2023-11-05 22:32

本文主要是介绍使用ETag协议实现ASP.NET Core API缓存,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

通常,我们在ASP.NET Core API服务端实现缓存,数据直接从缓存中取出,返回给客户端,以便加快响应速度。

但是这样的做法,解决不了数据传输到客户端需要占用带宽带来的性能问题。

这时,可以尝试使用ETag。

ETag协议

ETag是一个字符串;它表示客户端拥有的数据的某个“版本”。

客户端需要在请求头If-None-Match中传入ETag值,服务端检查到此特定请求头,会将此值与从服务端当前的ETag值相匹配。

如果匹配,服务端将只返回状态码304 Not Modified,表示客户端拥有的资源已经是最新的“版本”。否则,服务端将返回状态码200 OK和响应数据以及一个新的ETag。

客户端需要记录这个ETag值和缓存到期时间,缓存到期前可以不用访问服务端,节省服务端和客户端之间的带宽,并帮助客户端更快地执行操作,提高用户体验。

详细说明可以参看:https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/ETag

实现

为了实现ETag功能,我们定义一个ActionFilter来生成ETag并将其附加到响应头。

ETagFilterAttribute实现代码如下:

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false)]
public class ETagFilterAttribute : ActionFilterAttribute
{private readonly int expireMinutes;public ETagFilterAttribute(): this(60){}public ETagFilterAttribute(int expireMinutes){this.expireMinutes = expireMinutes;}public override void OnActionExecuted(ActionExecutedContext context){var request = context.HttpContext.Request;var response = context.HttpContext.Response;if (request.Method == HttpMethod.Get.Method &&response.StatusCode == (int)HttpStatusCode.OK){var res = JsonConvert.SerializeObject(context.Result);// 使用响应内容的MD5哈希作为ETag值var etag = MD5Hash(res);if (request.Headers.Keys.Contains(HeaderNames.IfNoneMatch)){var requestEtag = request.Headers[HeaderNames.IfNoneMatch].ToString();if (requestEtag.Equals(etag)){context.Result = new StatusCodeResult((int)HttpStatusCode.NotModified);}}response.Headers.Add(HeaderNames.ETag, new[] { etag });response.Headers.Add(HeaderNames.Expires, new[] { DateTime.Now.AddMinutes(expireMinutes).ToString() });}base.OnActionExecuted(context);}public static string MD5Hash(string input){using (var md5 = MD5.Create()){var result = md5.ComputeHash(Encoding.UTF8.GetBytes(input));var strResult = BitConverter.ToString(result);return strResult.Replace("-", "");}}
}

仅当GET请求执行成功时,计算响应数据的MD5作为ETag,Etag默认过期时间是60分钟。

测试

服务端实现如下API,测试ETag机制:

[HttpGet]
[ETagFilter(1)]
public string Get()
{return DateTime.Now.Minute.ToString();
}

第一次不带ETag请求头发送请求,返回数据

1分钟内,带ETag请求头发送请求,服务端的ETag还未变化,不返回数据

1分钟后,带ETag请求头发送请求,服务端的ETag已经变化,返回新数据

结论

在本文中,我们实现了一个简单的ETag机制。

但是,有一点需要注意的是,要使ETag能够正常工作,需要客户端配合实现

这篇关于使用ETag协议实现ASP.NET Core API缓存的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

HTML5实现的移动端购物车自动结算功能示例代码

《HTML5实现的移动端购物车自动结算功能示例代码》本文介绍HTML5实现移动端购物车自动结算,通过WebStorage、事件监听、DOM操作等技术,确保实时更新与数据同步,优化性能及无障碍性,提升用... 目录1. 移动端购物车自动结算概述2. 数据存储与状态保存机制2.1 浏览器端的数据存储方式2.1.

基于 HTML5 Canvas 实现图片旋转与下载功能(完整代码展示)

《基于HTML5Canvas实现图片旋转与下载功能(完整代码展示)》本文将深入剖析一段基于HTML5Canvas的代码,该代码实现了图片的旋转(90度和180度)以及旋转后图片的下载... 目录一、引言二、html 结构分析三、css 样式分析四、JavaScript 功能实现一、引言在 Web 开发中,

SpringBoot中使用Flux实现流式返回的方法小结

《SpringBoot中使用Flux实现流式返回的方法小结》文章介绍流式返回(StreamingResponse)在SpringBoot中通过Flux实现,优势包括提升用户体验、降低内存消耗、支持长连... 目录背景流式返回的核心概念与优势1. 提升用户体验2. 降低内存消耗3. 支持长连接与实时通信在Sp

Conda虚拟环境的复制和迁移的四种方法实现

《Conda虚拟环境的复制和迁移的四种方法实现》本文主要介绍了Conda虚拟环境的复制和迁移的四种方法实现,包括requirements.txt,environment.yml,conda-pack,... 目录在本机复制Conda虚拟环境相同操作系统之间复制环境方法一:requirements.txt方法

Spring Boot 实现 IP 限流的原理、实践与利弊解析

《SpringBoot实现IP限流的原理、实践与利弊解析》在SpringBoot中实现IP限流是一种简单而有效的方式来保障系统的稳定性和可用性,本文给大家介绍SpringBoot实现IP限... 目录一、引言二、IP 限流原理2.1 令牌桶算法2.2 漏桶算法三、使用场景3.1 防止恶意攻击3.2 控制资源

springboot下载接口限速功能实现

《springboot下载接口限速功能实现》通过Redis统计并发数动态调整每个用户带宽,核心逻辑为每秒读取并发送限定数据量,防止单用户占用过多资源,确保整体下载均衡且高效,本文给大家介绍spring... 目录 一、整体目标 二、涉及的主要类/方法✅ 三、核心流程图解(简化) 四、关键代码详解1️⃣ 设置

Nginx 配置跨域的实现及常见问题解决

《Nginx配置跨域的实现及常见问题解决》本文主要介绍了Nginx配置跨域的实现及常见问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来... 目录1. 跨域1.1 同源策略1.2 跨域资源共享(CORS)2. Nginx 配置跨域的场景2.1

python使用库爬取m3u8文件的示例

《python使用库爬取m3u8文件的示例》本文主要介绍了python使用库爬取m3u8文件的示例,可以使用requests、m3u8、ffmpeg等库,实现获取、解析、下载视频片段并合并等步骤,具有... 目录一、准备工作二、获取m3u8文件内容三、解析m3u8文件四、下载视频片段五、合并视频片段六、错误

Python中提取文件名扩展名的多种方法实现

《Python中提取文件名扩展名的多种方法实现》在Python编程中,经常会遇到需要从文件名中提取扩展名的场景,Python提供了多种方法来实现这一功能,不同方法适用于不同的场景和需求,包括os.pa... 目录技术背景实现步骤方法一:使用os.path.splitext方法二:使用pathlib模块方法三

javax.net.ssl.SSLHandshakeException:异常原因及解决方案

《javax.net.ssl.SSLHandshakeException:异常原因及解决方案》javax.net.ssl.SSLHandshakeException是一个SSL握手异常,通常在建立SS... 目录报错原因在程序中绕过服务器的安全验证注意点最后多说一句报错原因一般出现这种问题是因为目标服务器