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

反骨仔

2023-05-13 2023-05-13 约 801 字预计阅读 2 分钟 - 次阅读

通常，我们在 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 并将其附加到响应头。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53


[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 机制：

1
2
3
4
5
6


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

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

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

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

结论

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

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

ETag 协议

实现

测试

结论

相关链接