首页
/ 在YARP反向代理中实现响应体大小日志记录的技术方案

在YARP反向代理中实现响应体大小日志记录的技术方案

2025-05-26 20:47:35作者:胡易黎Nicole

背景与需求分析

在现代微服务架构中,反向代理作为流量入口承担着关键作用。YARP(Yet Another Reverse Proxy)作为微软开源的灵活反向代理解决方案,开发者经常需要扩展其功能以满足特定业务需求。一个常见的需求是记录完整的请求/响应日志,特别是响应体大小这一关键指标。

技术挑战

传统基于Content-Length头部的方案存在明显局限性:

  1. 当服务端采用分块传输编码(Transfer-Encoding: chunked)时,响应头中不会包含Content-Length
  2. 直接读取响应流会带来性能问题,特别是在高并发场景下
  3. 需要确保日志记录不影响正常的请求处理流程

核心解决方案

流装饰器模式

通过创建自定义的Stream实现类来包装原始响应流,在数据写入时进行字节计数:

public class CountingStreamDecorator : Stream
{
    private readonly Stream _innerStream;
    public long BytesWritten { get; private set; }

    public override ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, 
        CancellationToken cancellationToken = default)
    {
        BytesWritten += buffer.Length;
        return _innerStream.WriteAsync(buffer, cancellationToken);
    }
    
    // 其他必要方法实现...
}

中间件实现要点

  1. 执行顺序:必须确保中间件在YARP之前执行
  2. 流管理:正确处理流生命周期
  3. 性能优化:使用ValueTask减少异步开销
public async Task Invoke(HttpContext context)
{
    var originalStream = context.Response.Body;
    using var countingStream = new CountingStreamDecorator(originalStream);
    
    context.Response.Body = countingStream;
    await _next(context);
    
    // 记录日志
    LogResponseSize(countingStream.BytesWritten);
    
    // 恢复原始流
    context.Response.Body = originalStream;
}

关键技术细节

  1. 数据完整性保证:当中间件的next调用完成时,所有响应数据都已写入计数流
  2. 分块传输处理:字节计数反映的是实际应用数据,不包含分块编码的开销
  3. 资源管理:只释放自定义装饰器,原始流由框架管理

性能优化建议

  1. 优先实现ValueTask版本的方法
  2. 避免不必要的await操作
  3. 考虑使用内存池技术减少分配
  4. 对于高频场景,可使用结构体替代类

扩展思考

该方案不仅适用于日志记录,还可应用于:

  • 流量监控
  • 请求限流
  • 数据校验等场景

通过这种非侵入式的流装饰器模式,开发者可以在不修改核心代理逻辑的情况下,灵活扩展YARP的功能,同时保持系统的高性能和稳定性。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
260
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
854
505
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
254
295
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
331
1.08 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
397
370
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
kernelkernel
deepin linux kernel
C
21
5