.NET Web API如何从请求头(Header)中获取数据

答案:.NET Web API 可通过 HttpContext.Request.Headers 读取请求头,支持 TryGetValue 安全获取 Authorization、X-Device-Id 等值;也可用索引访问 User-Agent;中间件中可预处理如 X-Api-Key 验证;频繁字段可用 ActionFilter 如 TenantFilter 自动提取 X-Tenant-Id。

.net web api如何从请求头(header)中获取数据

.NET Web API 可以通过多种方式从 HTTP 请求头中读取数据,适用于获取自定义参数、身份令牌、设备信息等场景。以下是常用且实用的方法。

1. 使用 HttpContext.Request.Headers

在控制器中,可以通过 HttpContext.Request.Headers 直接访问所有请求头字段。它返回一个键值集合,支持按名称获取对应值。

示例代码:

[HttpGet("info")]public IActionResult GetInfo(){    if (HttpContext.Request.Headers.TryGetValue("Authorization", out var authValue))    {        // 获取 Authorization 头        var token = authValue.ToString();        // 处理 token    }    if (HttpContext.Request.Headers.ContainsKey("X-Device-Id"))    {        var deviceId = HttpContext.Request.Headers["X-Device-Id"];        // 使用设备 ID    }    return Ok(new { Success = true });}

注意:Header 名称不区分大小写,但建议使用标准命名方式。TryGetValue 更安全,避免因键不存在而抛出异常。

2. 通过 IHeaderDictionary 的便捷访问

Request.Headers 实现了 IHeaderDictionary 接口,可以直接用字符串索引访问。

示例:

var userAgent = HttpContext.Request.Headers["User-Agent"].ToString();var customParam = HttpContext.Request.Headers["X-Custom-Header"].ToString();

如果头不存在,返回的是空的 StringValues,调用 ToString() 会得到空字符串,不会报错。

3. 在中间件中读取请求头

若需在请求进入控制器前处理头信息(如认证、日志),可在自定义中间件中读取。

示例中间件:

public async Task InvokeAsync(HttpContext context, RequestDelegate next){    if (context.Request.Headers.TryGetValue("X-Api-Key", out var apiKey))    {        if (!IsValidApiKey(apiKey))        {            context.Response.StatusCode = 401;            await context.Response.WriteAsync("Invalid API Key");            return;        }    }    await next(context);}

注册中间件到 Program.cs 中即可生效。

4. 模型绑定或 Action 过滤器自动提取

对于频繁使用的头字段(如租户 ID、语言设置),可封装成过滤器自动注入。

示例:ActionFilter 提取 X-Tenant-Id

public class TenantFilter : ActionFilterAttribute{    public override void OnActionExecuting(ActionExecutingContext context)    {        if (context.HttpContext.Request.Headers.TryGetValue("X-Tenant-Id", out var tenantId))        {            // 存入 ViewBag 或依赖注入服务            context.ActionArguments["tenantId"] = tenantId.ToString();        }        base.OnActionExecuting(context);    }}

然后在控制器方法上应用该过滤器。

基本上就这些。根据实际需求选择合适的方式,多数情况下直接使用 HttpContext.Request.Headers 就足够了,简单明了。注意别忘了做空值判断和安全性校验。

以上就是.NET Web API如何从请求头(Header)中获取数据的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1441781.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月17日 18:26:11
下一篇 2025年12月17日 18:26:26

相关推荐

发表回复

登录后才能评论
关注微信