ETag 是 HTTP 提供的缓存机制,可以让服务器利用简单的字符串比对,来验证客户端先前缓存到的 HTTP 回应是否依然有效。它的流程主要是这样:服务器在回应数据的同时,于 HTTP 回应标头中夹带 ETag 字段,这个字段的值就相当于这个数据的 ID,而客户端在将 HTTP 回应缓存下来之后,若需重新发送请求时,就会在 HTTP 请求中夹带 If-None-Match 字段,将原先缓存到的 ETag 值再回传给服务器,让服务器来判断客户端的缓存是否需要更新。如果不需要,服务器就会回传 304 (Not Modified)这个 HTTP 状态码,让客户端继续使用缓存的数据;如果需要让客户端更新缓存的话,就要再发送一次完整的 HTTP 回应,并在 HTTP 标头中夹带新的 ETag 字段值。

一个弱的(weak) ETag 值长得像以下这样:

W/"123456789"

一个强的(strong) ETag 值长得像以下这样:

"123456789"

强的 ETag 相比弱的 ETag 更可以保证两个相同的 ETag 所对应到的是同一笔数据,以及两个不同的 ETag 所对应到的是不同的数据。程序员应该自行判断要用哪种比较合适。

Entity Tag

「Entity Tag」是笔者开发的套件,提供 EntityTag 结构体来解析 ETag 字符串,在内存中表示 ETag 值,并提供相关的运算函数。

Crates.io

Cargo.toml

entity-tag = "*"

使用方法

entity_tag 这个 crate 底下有 EntityTag 结构体。EntityTag 结构体提供了 with_str、with_string、from_str、from_string 关联函数,可以解析 ETag 字符串,创建 EntityTag 实体。

EntityTag 结构体也有 from_data 和 from_data_strong 关联函数,可以直接传入 u8 切片,分别借由 XXH3-128 和 BLAKE3-256 哈希函数来计算出哈希值,以创建出「弱的」和「强的」EntityTag 实体。from_file_meta 和 from_file_meta_strong 则是可以传入 std::fs::Metadata,借由文件的元数据(metadata)来快速创建出「弱的」和「强的」EntityTag 实体。

这些用来产生 ETag 的关联函数需要激活 weak-hasher(弱的)或 strong-hasher(强的)特色才能使用。Cargo.toml 的写法如下:

[dependencies.entity-tag]
version = "*"
features = ["weak-hasher", "strong-hasher"]

EntityTag 实体可以使用 strong_eq、weak_eq、strong_ne 和 weak_ne 方法来判断是否和另一个 EntityTag 实体相等。

可参考以下代码:

use entity_tag::EntityTag;

let etag1 = EntityTag::with_str(true, "foo").unwrap();
let etag2 = EntityTag::from_str("\"foo\"").unwrap();

assert_eq!(true, etag1.weak);
assert_eq!(false, etag2.weak);

assert!(etag1.weak_eq(&etag2));
assert!(etag1.strong_ne(&etag2));

let etag3 = EntityTag::from_data(&[102, 111, 111]);
assert_eq!("W/\"ea75LoNFQSGrbl9kB359ig\"", etag3.to_string());

let etag4 = EntityTag::from_data_strong(&[102, 111, 111]);
assert_eq!("\"BOC7OfMLGj/rifU2yTvhUFVILfdIZ0sA0m5adXd3Auk\"", etag4.to_string());

let metadata = std::fs::File::open("tests/data/P1060382.JPG").unwrap().metadata().unwrap();
let etag5 = EntityTag::from_file_meta(&metadata); // weak
let etag6 = EntityTag::from_file_meta_strong(&metadata); // strong