在先前的文章中有提到用 Rocket 框架回应任意数据的方式,在另一篇文章中也有介绍用 Rocket 框架来实现 HTTP 的 ETag 缓存机制,要怎么样把这两个东西结合在一起使用呢?

Etagged Raw Response for Rocket Framework

「Etagged Raw Response for Rocket Framework」是笔者开发的套件,可以使 Rocket 框架依据 HTTP 请求的 If-None-Match 标头字段来判断是否要直接回应一个 Vec<u8> 实体、一个 Reader 或是一个文件,并且快速地替其加入 Content-Type 标头和 ETag 字段。

Crates.io

Cargo.toml

rocket-etagged-raw-response = "*"

使用方法

rocket_etagged_raw_response 这个 crate 提供的 EtaggedRawResponse 结构体可以当作要回应的数据类型。EtaggedRawResponse 结构体提供了 from_static 关联函数和 from_vec 关联函数,可以从参数中传入要拿来回应的 &'static [u8] 参考或 Vec<u8> 实体、文件类型和打开时预设的文件名称(如果不设置文件名称的话,网页浏览器会用网址路径的文件名称来当作文件名称)。它也提供了 from_reader 关联函数,可以从参数中传入任意有实作 Read 特性的实体、文件类型和打开时预设的文件名称。

如果数据源为文件的话,那就更方便了,可以直接使用 EtaggedRawResponse 结构体提供的 from_file 关联函数,可以从参数中传入文件路径、文件类型和打开时预设的文件名称。如果不提供文件类型的话,预设会由文件路径中的扩展名来判断;如果不提供文件名称的话,预设会由文件路径中的文件名称来判断;如果想要直接使用网址路径的文件名称作为预设的文件名称的话,那就把文件名称设置为空字符串。

举个例子,假设工作目录中有 examples/images/image(猫).jpg 这张 JPEG 图档。若想要让 Rocket 框架提供这个图档,并且让网页浏览器直接浏览这个图档,而不是将其下载到文件系统,然后又要支持 ETag 机制的话,程序可以这样写:

#[macro_use]
extern crate rocket;

use std::io::ErrorKind;
use std::path::Path;

use rocket::http::Status;

use rocket_etagged_raw_response::{EtagIfNoneMatch, EtaggedRawResponse};

#[get("/")]
async fn view(etag_if_none_match: EtagIfNoneMatch<'_>) -> Result<EtaggedRawResponse<'_>, Status> {
    let path = Path::join(Path::new("examples"), Path::join(Path::new("images"), "image(猫).jpg"));

    EtaggedRawResponse::from_file(&etag_if_none_match, path, None::<String>, None).await.map_err(
        |err| {
            if err.kind() == ErrorKind::NotFound {
                Status::NotFound
            } else {
                Status::InternalServerError
            }
        },
    )
}

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