C#怎么实现WebAPI请求日志 C#如何用中间件自动记录API请求和响应的完整日志信息【框架】

梦芳大大_4361

梦芳大大_4361

2026-03-27

538人浏览

原创

ASP.NET Core中间件中读取Request.Body和Response.Body需启用缓冲并重置流位置,日志应采样记录关键字段且避免敏感信息。

c#怎么实现webapi请求日志 c#如何用中间件自动记录api请求和响应的完整日志信息【框架】

中间件里怎么读取 Request.Body 和 Response.Body

ASP.NET Core 的 Request.Body 和 Response.Body 默认是只读/只写流,且只能读一次。直接在中间件里 ReadAsync 会导致后续控制器拿不到原始 body —— 这是最常踩的坑。

必须先启用缓冲(buffering),再用 StreamReader 或 JsonDocument.Parse 解析内容。但注意:启用缓冲会增加内存开销,尤其对大文件上传场景要谨慎。

  • 对 Request.Body:调用 HttpContext.Request.EnableBuffering()(.NET 5+)或手动复制到 MemoryStream
  • 对 Response.Body:需用 Response.Body = new MemoryStream() 替换,并在写入后回拷到原始流,否则客户端收不到响应
  • 务必在 await next(); 前重置 Request.Body.Position = 0,否则 Controller 读不到数据

日志内容里哪些字段真正有用

不是所有请求都值得全量记录。比如 /health、/metrics 或静态资源路径(.js、.css)打满日志只会掩盖问题。重点该记的是:真实业务 API 的完整输入输出 + 关键上下文。

  • 必记:HTTP 方法、路径、状态码、耗时(Stopwatch 计时)、客户端 IP(HttpContext.Connection.RemoteIpAddress)
  • 建议记:请求头中 Authorization(脱敏后)、CorrelationId、User-Agent
  • 避免记:二进制 body(如图片上传)、超长 JSON(可截断前 2KB)、敏感字段(密码、token 字符串,用 Regex.Replace 清洗)

为什么不能直接在 Controller 里记日志

Controller 层日志天然缺失关键信息:比如中间件抛出的异常(400 Bad Request 由模型绑定失败触发)、CORS 拒绝、认证失败(401)、甚至请求根本没进 Controller(路由 404)。这些在中间件外就结束了。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
  • Controller 日志只覆盖“成功抵达并执行完”的请求,覆盖率低于 60%
  • 中间件能统一捕获 try/catch 外的异常,包括 JsonException、InvalidOperationException
  • 如果用 ILogger 在中间件里打日志,确保注入的是 ILoggerFactory 创建的实例,而非单例 logger,否则作用域可能错乱

.NET 6+ 中如何避免性能暴跌

全量序列化 body + 同步写磁盘会让吞吐量掉 3–5 倍。核心矛盾是:日志要完整,但不能拖慢主流程。

  • 用 System.Text.Json 而非 Newtonsoft.Json,前者无反射、零分配解析更轻量
  • 日志写入必须异步:用 ILogger.LogInformation(底层已异步),别自己开线程或用 Task.Run
  • 加采样开关:开发环境全量,生产环境按百分比(如 5%)或仅记录错误响应(context.Response.StatusCode >= 400)
  • 避免在日志里拼接字符串("req: " + body),改用结构化日志占位符:logger.LogInformation("Req {Method} {Path} {StatusCode}", method, path, code)

最易被忽略的是 body 流位置重置时机和采样策略——漏掉前者,API 直接 400;漏掉后者,上线第一天磁盘就写爆。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

1132

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

3331

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

945

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2655

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

352

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

429

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

631

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

329

20

什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

2024.05.11

709

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习