在.NET Core 2.1中如何获取调用API的请求方详细信息?
.NET Core 2.1 获取API请求方详细信息方案
基础获取方式
.NET Core 2.1中所有请求相关数据都封装在HttpContext对象中,你可以直接在控制器接口内通过该对象读取请求方各类信息,也可以通过中间件、过滤器全局统一采集。
可采集的请求方信息及代码示例
- 客户端真实IP地址
控制器内直接读取代码:
如果服务部署在Nginx、IIS等反向代理后,需要先配置转发头才能拿到真实IP,在// 无反向代理时可直接读取 var clientIp = HttpContext.Connection.RemoteIpAddress?.ToString();Startup.cs的ConfigureServices方法中添加配置:
之后在services.Configure<ForwardedHeadersOptions>(options => { options.ForwardedHeaders = ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto; // 可添加信任的代理服务器IP,避免IP伪造 options.KnownProxies.Add(IPAddress.Parse("你的代理服务器内网IP")); });Configure方法的最开头注册转发头中间件:app.UseForwardedHeaders(); - 客户端端口号
var clientPort = HttpContext.Connection.RemotePort; - 客户端设备/调用工具标识(User-Agent)
var userAgent = HttpContext.Request.Headers["User-Agent"].FirstOrDefault(); - 请求来源页地址(Referer)
var referer = HttpContext.Request.Headers["Referer"].FirstOrDefault(); - 客户端偏好语言
var acceptLang = HttpContext.Request.Headers["Accept-Language"].FirstOrDefault(); - 认证用户信息(接口开启身份认证时可用)
// 读取用户ID var userId = HttpContext.User.FindFirst(System.Security.Claims.ClaimTypes.NameIdentifier)?.Value; // 读取用户名 var userName = HttpContext.User.Identity?.Name; - 请求基础属性
// 请求方法:GET/POST/PUT等 var method = HttpContext.Request.Method; // 请求路径 var path = HttpContext.Request.Path; // 请求查询参数 var query = HttpContext.Request.QueryString.ToString();
全局统一采集方案
如果需要采集所有接口的请求方信息,不需要逐个接口写代码,可以自定义全局中间件实现:
- 新建中间件类:
public class RequestCollectMiddleware { private readonly RequestDelegate _next; public RequestCollectMiddleware(RequestDelegate next) { _next = next; } public async Task InvokeAsync(HttpContext context) { // 统一采集请求方信息 var requestInfo = new { ClientIp = context.Connection.RemoteIpAddress?.ToString(), ClientPort = context.Connection.RemotePort, UserAgent = context.Request.Headers["User-Agent"].FirstOrDefault(), Referer = context.Request.Headers["Referer"].FirstOrDefault(), RequestTime = DateTime.Now, RequestPath = context.Request.Path, RequestMethod = context.Request.Method }; // 此处可添加你的业务逻辑,比如将信息写入日志、数据库等 // 执行后续请求流程 await _next(context); } }
- 在
Startup.cs的Configure方法中注册中间件,需要放在路由中间件之前:
app.UseMiddleware<RequestCollectMiddleware>(); app.UseRouting(); // 其他中间件如认证、授权等放在后面
内容的提问来源于stack exchange,提问作者Kaishu
相关产品推荐
相关产品推荐

