使用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

相关文章

React 记忆缓存的三种方法实现

《React记忆缓存的三种方法实现》本文主要介绍了React记忆缓存的三种方法实现,包含React.memo、useMemo、useCallback,用于避免不必要的组件重渲染和计算,感兴趣的可以... 目录1. React.memo2. useMemo3. useCallback使用场景与注意事项在 Re

Nginx实现端口映射的示例代码

《Nginx实现端口映射的示例代码》本文主要介绍了Nginx实现端口映射的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录1. 找到nginx的部署路径2. 备份原来的配置文件3. 编辑nginx.conf文件4. 在

Java StringBuilder 实现原理全攻略

《JavaStringBuilder实现原理全攻略》StringBuilder是Java提供的可变字符序列类,位于java.lang包中,专门用于高效处理字符串的拼接和修改操作,本文给大家介绍Ja... 目录一、StringBuilder 基本概述核心特性二、StringBuilder 核心实现2.1 内部

Docker多阶段镜像构建与缓存利用性能优化实践指南

《Docker多阶段镜像构建与缓存利用性能优化实践指南》这篇文章将从原理层面深入解析Docker多阶段构建与缓存机制,结合实际项目示例,说明如何有效利用构建缓存,组织镜像层次,最大化提升构建速度并减少... 目录一、技术背景与应用场景二、核心原理深入分析三、关键 dockerfile 解读3.1 Docke

Android实现图片浏览功能的示例详解(附带源码)

《Android实现图片浏览功能的示例详解(附带源码)》在许多应用中,都需要展示图片并支持用户进行浏览,本文主要为大家介绍了如何通过Android实现图片浏览功能,感兴趣的小伙伴可以跟随小编一起学习一... 目录一、项目背景详细介绍二、项目需求详细介绍三、相关技术详细介绍四、实现思路详细介绍五、完整实现代码

SpringBoot AspectJ切面配合自定义注解实现权限校验的示例详解

《SpringBootAspectJ切面配合自定义注解实现权限校验的示例详解》本文章介绍了如何通过创建自定义的权限校验注解,配合AspectJ切面拦截注解实现权限校验,本文结合实例代码给大家介绍的非... 目录1. 创建权限校验注解2. 创建ASPectJ切面拦截注解校验权限3. 用法示例A. 参考文章本文

在Android中使用WebView在线查看PDF文件的方法示例

《在Android中使用WebView在线查看PDF文件的方法示例》在Android应用开发中,有时我们需要在客户端展示PDF文件,以便用户可以阅读或交互,:本文主要介绍在Android中使用We... 目录简介:1. WebView组件介绍2. 在androidManifest.XML中添加Interne

Java Stream流与使用操作指南

《JavaStream流与使用操作指南》Stream不是数据结构,而是一种高级的数据处理工具,允许你以声明式的方式处理数据集合,类似于SQL语句操作数据库,本文给大家介绍JavaStream流与使用... 目录一、什么是stream流二、创建stream流1.单列集合创建stream流2.双列集合创建str

SpringBoot集成redisson实现延时队列教程

《SpringBoot集成redisson实现延时队列教程》文章介绍了使用Redisson实现延迟队列的完整步骤,包括依赖导入、Redis配置、工具类封装、业务枚举定义、执行器实现、Bean创建、消费... 目录1、先给项目导入Redisson依赖2、配置redis3、创建 RedissonConfig 配

Python的Darts库实现时间序列预测

《Python的Darts库实现时间序列预测》Darts一个集统计、机器学习与深度学习模型于一体的Python时间序列预测库,本文主要介绍了Python的Darts库实现时间序列预测,感兴趣的可以了解... 目录目录一、什么是 Darts?二、安装与基本配置安装 Darts导入基础模块三、时间序列数据结构与