请求
2026/2/15大约 2 分钟hyperlanewebrustusage-introductionrequest
提示
hyperlane 框架对 ctx 额外封装了子字段的方法,可以直接调用大部分子字段的 get 和 set 方法名称。 例如:调用 request 上的 get_method 方法, 一般需要从 ctx 解出 request,再调用request.get_method(), 可以简化成直接调用 ctx.get_request().get_method()。
调用规律
request仅支持get,不支持set,框架保证请求信息不会被意外修改。- 原
request的get方法的get名称后加request名称,中间使用_拼接。
获取请求信息
获取 request
let request: &Request = ctx.get_request();获取 method
let method: &RequestMethod = ctx.get_request().get_method();获取 host
let host: &RequestHost = ctx.get_request().get_host();获取 path
let path: &RequestPath = ctx.get_request().get_path();获取 version
let version: &RequestVersion = ctx.get_request().get_version();获取 querys
let querys: &RequestQuerys = ctx.get_request().get_querys();获取特定查询参数
// 尝试获取查询参数
let query_value: OptionRequestQuerysValue = ctx.try_get_request().get_query("key");
// 获取查询参数(获取不到则panic)
let query_value: RequestQuerysValue = ctx.get_request().get_query("key");获取 header
提示
hyperlane 框架请求头的 key 是经过全小写处理,建议使用框架定义的常量。
// 尝试获取请求头
let header: OptionRequestHeadersValue = ctx.try_get_request().get_header(CONTENT_TYPE);
// 获取请求头(获取不到则panic)
let header: RequestHeadersValue = ctx.get_request().get_header(CONTENT_TYPE);获取 headers
let headers: &RequestHeaders = ctx.get_request().get_headers();获取请求头的第一个值
// 尝试获取请求头的第一个值
let header_value: OptionRequestHeadersValueItem = ctx.try_get_request().get_header_front(CONTENT_TYPE);
// 获取请求头的第一个值(获取不到则panic)
let header_value: RequestHeadersValueItem = ctx.get_request().get_header_front(CONTENT_TYPE);获取请求头的最后一个值
// 尝试获取请求头的最后一个值
let header_value: OptionRequestHeadersValueItem = ctx.try_get_request().get_header_back(ACCEPT);
// 获取请求头的最后一个值(获取不到则panic)
let header_value: RequestHeadersValueItem = ctx.get_request().get_header_back(ACCEPT);获取请求头值的数量
// 尝试获取请求头值的数量
let header_count: OptionUsize = ctx.try_get_request().get_header_len(ACCEPT_ENCODING);
// 获取请求头值的数量(获取不到则panic)
let header_count: usize = ctx.get_request().get_header_len(ACCEPT_ENCODING);获取所有请求头值的总数量
let total_values: usize = ctx.get_request().get_headers_values_length();获取请求头的数量
let headers_count: usize = ctx.get_request().get_headers_length();检查是否存在特定请求头
let has_header: bool = ctx.get_request().get_has_header(CONTENT_TYPE);检查请求头是否包含特定值
let has_value: bool = ctx.get_request().get_has_header_value(CONTENT_TYPE, APPLICATION_JSON);获取请求体
let body: &RequestBody = ctx.get_request().get_body();获取 string 格式的请求体
let body: String = ctx.get_request().get_body_string();获取 json 格式的请求体
// 反序列化请求体
let body: ResultJsonError<T> = ctx.try_get_request().get_body_json::<T>();
// 反序列化请求体(反序列化失败则panic)
let body: T = ctx.get_request().get_body_json::<T>();获取请求升级类型
let upgrade_type: UpgradeType = ctx.get_request().get_upgrade_type();转字符串
通过 to_string
提示
将获得完整的原始结构体字符串结构。
ctx.get_request().to_string();