ETag 是 HTTP 提供的缓存机制,可以让服务器利用简单的字符串比对,来验证客户端先前缓存到的 HTTP 回应是否依然有效。它的流程主要是这样:服务器在回应数据的同时,于 HTTP 回应标头中夹带 ETag 字段,这个字段的值就相当于这个数据的 ID,而客户端在将 HTTP 回应缓存下来之后,若需重新发送请求时,就会在 HTTP 请求中夹带 If-None-Match 字段,将原先缓存到的 ETag 值再回传给服务器,让服务器来判断客户端的缓存是否需要更新。如果不需要,服务器就会回传 304 (Not Modified)这个 HTTP 状态码,让客户端继续使用缓存的数据;如果需要让客户端更新缓存的话,就要再发送一次完整的 HTTP 回应,并在 HTTP 标头中夹带新的 ETag 字段值。
Etag If-None-Match Request Guard for Rocket Framework
「Etag If-None-Match Request Guard for Rocket Framework」是笔者开发的套件,提供了一个请求守卫,可以用来读取 HTTP 请求中的 If-None-Match 字段。
Crates.io
Cargo.toml
使用方法
rocket_etag_if_none_match 这个 crate 提供的 EtagIfNoneMatch 结构体可以当作请求守卫,可以用来读取 HTTP 请求中的 If-None-Match 字段。EtagIfNoneMatch 结构实体提供了 weak_eq 和 strong_eq 方法,可以用来验证从参数传入的 rocket_etag_if_none_match::entity_tag::EntityTag 是否在逻辑上相等于 If-None-Match 字段的 ETag 值。
一个弱的(weak) ETag 值长得像以下这样:
一个强的(strong) ETag 值长得像以下这样:
weak_eq 是用来判断两笔带有 ETag 值的数据是否为逻辑上的相等(例如 JSON 格式的字符串,有笔是 {"a": 1, "b": 2},另一笔是 {"b": 2, "a": 1},这两笔数据可以说在逻辑上是相等的),而 strong_eq 是用来判断数据是否完全一致,不去管数据的格式是什么。如果 A 数据的 ETag 值 strong_eq 于 B 数据的 ETag 值,则它们也必定能 weak_eq。被用来做 strong_eq 判断的 ETag 值只能是强的(strong) ETag 值。
以下是一个 ETag 机制的实作范例:
#[macro_use]
extern crate rocket;
use std::borrow::Cow;
use std::io::Cursor;
use rocket_etag_if_none_match::{entity_tag::EntityTag, EtagIfNoneMatch};
use rocket::http::Status;
use rocket::request::Request;
use rocket::response::{Responder, Response, Result};
use chrono::prelude::*;
static MY_ETAG: EntityTag = unsafe { EntityTag::new_unchecked(true, Cow::Borrowed("MAGIC")) };
struct MyResponse<'r>(Response<'r>);
impl<'r, 'o: 'r> Responder<'r, 'o> for MyResponse<'o> {
#[inline]
fn respond_to(self, _: &'r Request<'_>) -> Result<'o> {
Ok(self.0)
}
}
impl<'r> From<Response<'r>> for MyResponse<'r> {
#[inline]
fn from(res: Response<'r>) -> Self {
MyResponse(res)
}
}
#[get("/")]
fn index(etag_if_none_match: EtagIfNoneMatch) -> MyResponse<'static> {
if etag_if_none_match.weak_eq(&MY_ETAG) {
println!("Cached!");
Response::build().status(Status::NotModified).finalize().into()
} else {
let body = format!("Current Time: {}\n\nTry to re-open this page repeatedly without pressing the forced-refresh(Ctrl+F5) button.", Utc::now().to_rfc3339());
let size = body.len();
Response::build()
.raw_header("Etag", MY_ETAG.to_string())
.raw_header("Content-Type", "text/plain; charset=utf-8")
.sized_body(size, Cursor::new(body))
.finalize()
.into()
}
}
#[launch]
fn rocket() -> _ {
rocket::build().mount("/", routes![index])
}
MY_ETAG 是我们写死在程序中的 ETag,它是一个弱的(weak) ETag 值,以完整的字符串来表示的话为 W/"MAGIC"。当路由处理程序 index 被调用时,会去检查 HTTP 请求中的 If-None-Match 字段是否 weak_eq 于 W/"MAGIC",如果可以的话就直接回传 304 (Not Modified)这个 HTTP 状态码;如果不行的话就回传完整的 HTTP 回应。
善用 HTTP 的 ETag 机制和先前介绍过的 Cache-Control 机制,除了可以大幅度地减少服务器的负担外,还可以减短用户浏览网页时的等待时间。
