Rocket是一个Web框架,它提供了一些请求守卫(request guard)的功能,可以用于过滤和验证传入的HTTP请求。请求守卫是在处理请求之前执行的函数,它们可以检查请求是否满足某些特定的条件,如果满足条件,则请求将被传递到处理程序(handler)中进行处理,否则将返回错误响应。
Rocket提供了三种类型的请求守卫:
Guard
: 检查传入的请求是否满足某些特定的条件,如果满足条件,则请求将被传递到处理程序中进行处理。否则,请求将被拒绝,返回错误响应。例如,可以使用Header
守卫检查请求头是否包含指定的标头。
use rocket::http::Status;
use rocket::request::{FromRequest, Outcome};
use rocket::{Request, State};
struct ApiKey(String);
impl<'a, 'r> FromRequest<'a, 'r> for ApiKey {
type Error = ();
fn from_request(request: &'a Request<'r>) -> Outcome<Self, Self::Error> {
let keys: Vec<_> = request.headers().get("X-Api-Key").collect();
if keys.len() != 1 {
return Outcome::Failure((Status::BadRequest, ()));
}
Outcome::Success(ApiKey(keys[0].to_string()))
}
}
#[get("/sensitive")]
fn sensitive(key: ApiKey) -> String {
format!("Sensitive data, api key is: {}", key.0)
}
Catch
: 用于处理某些类型的异常并返回错误响应。例如,可以使用Catch
守卫处理404 Not Found
异常并返回自定义错误响应。
use rocket::{catch, catchers};
#[catch(404)]
fn not_found() -> &'static str {
"Page not found."
}
#[get("/unknown")]
fn unknown() -> &'static str {
"This page does not exist."
}
fn main() {
rocket::ignite()
.register(catchers![not_found])
.mount("/", routes![unknown])
.launch();
}
Fairing
: 用于在应用程序启动时执行一些操作,例如设置全局状态,加载配置文件等。例如,可以使用Fairing
守卫加载环境变量并将其设置为全局状态。
use std::env;
use rocket::{fairing::AdHoc, State};
struct Config {
port: u16,
}
impl Config {
fn new() -> Config {
let port = env::var("PORT")
.unwrap_or_else(|_| "8000".to_string())
.parse()
.unwrap_or(8000);
Config { port }
}
}
#[get("/")]
fn index(config: &State<Config>) -> String {
format!("Server is running on port {}", config.port)
}
fn main() {
let config = Config::new();
rocket::ignite()
.manage(config)
.mount("/", routes![index])
.attach(AdHoc::on_launch("Loading environment variables", |_| {
println!("Loading environment variables...");
}))
.launch();
}