HTTP 协定提供了一些缓存机制,最基本的就是 Cache-Control。Cache-Control 可以用来控制 HTTP 连接要如何被缓存,例如最常见的用法就是透过 max-age 参数来设置缓存时间,搭配 public 或是 private 参数来控制缓存的可见程度。不过 Rocket 框架本身并没有对 Cache-Control 提供直接的支持,所以使用起来不是很方便。

Cache Response for Rocket Framework

「Cache Response for Rocket Framework」是笔者开发的套件,可以快速地替 Rocket 的 HTTP 回应加上 Cache-Control 机制。

Crates.io

Cargo.toml

rocket-cache-response = "*"

使用方法

rocket_cache_response 这个 crate 提供了 CacheResponse 枚举,可以用来包裹任意的 HTTP 回应的类型,在 HTTP 回应中加上 Cache-Control 字段来进行缓存的控制。CacheResponse 枚举提供的变体有以下几种:

  • Public:可以使所有(包括代理服务器和 CDN)的客户端缓存 HTTP 回应一段时间,在缓存的有效时间中,客户端不需要再向服务器端重新发送 HTTP 请求。must_revalidate 参数可以用来控制过期的缓存是否一定要再向服务器端重新发送 HTTP 请求来验证缓存的有效性(验证的方式可以是在 HTTP 标头中夹带其它的字段信息,让服务器可以去检查),当服务器回传的 HTTP 状态码为 304 (Not Modified),表示同意客户端继续使用缓存,缓存时间会重新计算。(一般的网页浏览器不论有无 must_revalidate 参数都会当作是有 must_revalidate 参数来处理,但是代理服务器和 CDN 就不一定了。)
  • Private:可以使最终客户端(如网页浏览器)缓存 HTTP 回应一段时间,在缓存的有效时间中,客户端不需要再向服务器端重新发送 HTTP 请求。
  • NoCache:允许所有客户端缓存 HTTP 回应,但每次使用缓存时,客户端都要向服务器验证缓存的有效性,当服务器回传的 HTTP 状态码为 304 (Not Modified),表示同意客户端继续使用缓存。如果 HTTP 回应中没有 Cache-Control 字段,通常就会被当作是 NoCache (no-cache)。
  • NoStore:不允许所有客户端缓存 HTTP 回应。
  • NoCacheControl:不设置(改变)Cache-Control 字段。

以下是一个使用范例:

#[macro_use]
extern crate rocket;

use rocket_cache_response::CacheResponse;

use chrono::prelude::*;

#[get("/")]
fn index() -> CacheResponse<String> {
    CacheResponse::Public {
        responder: format!("Current Time: {}\n\nTry to re-open this page repeatedly without pressing the refresh(F5) or forced-refresh(Ctrl+F5) buttons.", Utc::now().to_rfc3339()),
        max_age: 10, // cached for seconds
        must_revalidate: false,
    }
}

#[launch]
fn rocket() -> _ {
    rocket::build().mount("/", routes![index])
}

另外,CacheResponse 枚举还提供 public_only_release 和 private_only_release 这两个关联函数,可以用来设置只在使用 release 模式来编译程序时才使用 Public 或是 Private 变体,否则就不设置 Cache-Control 字段(NoCacheControl)。避免在程序开发阶段,因为有用缓存机制而导致一些麻烦的产生。