axum::Router
结构体
pub struct Router<S = ()> { /* private fields */}
用于组合处理程序和服务的路由器类型。
实现
impl<S> Router<S>
where
S: Clone + Send + Sync + 'static,
新建路由器
pub fn new() -> Self
创建一个新的路由器,除非您添加额外的路由,否则将对所有请求响应404未找到。
添加另一个路由到路由器
pub fn route(self, path: &str, method_router: MethodRouter<S>) -> Self
path
: 是由/
分割的路径段字符串。每个段可能是 静态的、捕获的或者是通配符。method_router
: 是一个MethodRouter
,它将请求方法映射到处理程序。method_router
通常会是类似于get
的方法路由器中的处理程序。
静态路径
例如:
/
/foo
/foo/bar
如果传入的请求路径完全匹配,则将调用相应的服务。
捕获
例如:
/:key
/foo/:key
/users/:id/tweets
路径可以包含类似于/:key
的段,它匹配任何单个段,并将存储在key
处捕获的值。
捕获的值可以是零长度,除了无效路径//
捕获可以使用Path
进行提取。
MatchedPath
可以用于提取匹配路径,而不是实际路径。
通配符
路径可以以/*key
结尾,匹配所有段并捕获的段存储在key
中。
例如:
/*key
/users/*path
/:id/:repo/*tree
请注意,/*key
不匹配空段。因此:
/*key
不匹配/
,但匹配/a
,/a/
等。/x/*key
不匹配/x
或/x/
,但匹配/x/a
,/x/a/
等。
还可以使用 Path
来提取通配符捕获。
请注意,不包括前导斜杠,即对于路由 /foo/*rest
和路径 /foo/bar/baz
,
rest
的值将是 bar/baz
。
接受多种方法
要接受同一路由的多个方法,您可以同时添加所有处理程序。
use axum::{Router, routing::{get, delete}, extract::Path};
let app = Router::new().route(
"/",
get(get_root).post(post_root).delete(delete_root),
);
async fn get_root() {}
async fn post_root() {}
async fn delete_root() {}
或者你也可以一一添加:
let app = Router::new()
.route("/", get(get_root))
.route("/", post(post_root))
.route("/", delete(delete_root));
更多例子
use axum::{Router, routing::{get, delete}, extract::Path};
let app = Router::new()
.route("/", get(root))
.route("/users", get(list_users).post(create_user))
.route("/users/:id", get(show_user))
.route("/api/:version/users/:id/action", delete(do_users_action))
.route("/assets/*path", get(serve_asset));
async fn root() {}
async fn list_users() {}
async fn create_user() {}
async fn show_user(Path(id): Path<u64>) {}
async fn do_users_action(Path((version, id)): Path<(String, u64)>) {}
async fn serve_asset(Path(path): Path<String>) {}
Panics
如果路径与另一个路由重叠,则会发生panic
use axum::{routing::get, Router};
let app = Router::new()
.route("/", get(|| async {}))
.route("/", get(|| async {}));
静态路由 /foo
和动态路由 /:key
不被视为重叠,并且 /foo
将优先。
如果路径为空,也会引发 panic。