MagicOnion中实现StreamingHub方法参数与返回值的日志记录
2025-06-16 21:01:29作者:舒璇辛Bertina
前言
在使用MagicOnion开发实时通信应用时,开发者经常需要记录StreamingHub方法的输入参数和返回值,这对于调试和监控系统行为非常重要。本文将详细介绍如何在MagicOnion的StreamingHub中实现方法调用的完整日志记录。
基础日志记录方案
最简单的日志记录方式是通过构造函数注入ILogger,然后在每个方法内部手动记录参数:
public class GamingHub : StreamingHubBase<IGamingHub, IGamingHubReceiver>, IGamingHub
{
private readonly ILogger<GamingHub> _logger;
public GamingHub(ILogger<GamingHub> logger)
{
_logger = logger;
}
public async ValueTask<Player[]> JoinAsync(string roomName, string userName, Vector3 position, Quaternion rotation)
{
_logger.LogInformation("JoinAsync called with roomName:{roomName}, userName:{userName}", roomName, userName);
// 方法实现...
}
}
这种方式虽然直接,但需要在每个方法中重复编写日志代码,维护成本较高。
使用过滤器实现统一日志记录
MagicOnion提供了过滤器(Filter)机制,可以在方法调用前后插入自定义逻辑,这是实现统一日志记录的理想方式。
创建日志记录过滤器
public class LoggingStreamingHubFilter : IStreamingHubFilter
{
private readonly ILogger _logger;
public LoggingStreamingHubFilter(ILogger<LoggingStreamingHubFilter> logger)
{
_logger = logger;
}
public async ValueTask Invoke(StreamingHubContext context, Func<StreamingHubContext, ValueTask> next)
{
// 记录方法调用前日志(参数)
_logger.LogInformation("调用方法 {MethodName} 参数: {Parameters}",
context.Path,
JsonSerializer.Serialize(context.ServiceContext.CallContext.RequestHeaders));
try
{
await next(context);
// 记录方法调用后日志(返回值)
if (context.Result.HasValue)
{
_logger.LogInformation("方法 {MethodName} 返回: {Result}",
context.Path,
JsonSerializer.Serialize(context.Result.Value));
}
}
catch (Exception ex)
{
_logger.LogError(ex, "方法 {MethodName} 执行出错", context.Path);
throw;
}
}
}
注册过滤器
在服务配置中添加过滤器:
var builder = MagicOnionHost.CreateDefaultBuilder()
.UseMagicOnion(
new MagicOnionOptions
{
StreamingHubFilters = new[] { new LoggingStreamingHubFilter(logger) }
}
);
参数序列化注意事项
在记录复杂类型参数时,需要注意:
- 确保类型可序列化,特别是自定义类型
- 对于包含循环引用的对象,需要配置序列化选项
- 敏感信息应考虑脱敏处理
可以自定义序列化选项:
var options = new JsonSerializerOptions
{
WriteIndented = true,
ReferenceHandler = ReferenceHandler.IgnoreCycles
};
JsonSerializer.Serialize(value, options);
性能优化建议
日志记录虽然重要,但也需要考虑性能影响:
- 在高频调用的方法上考虑使用Debug级别日志
- 对大对象记录时只记录关键属性
- 考虑使用条件日志记录
if (_logger.IsEnabled(LogLevel.Debug))
{
_logger.LogDebug("详细日志信息...");
}
总结
通过MagicOnion的过滤器机制,我们可以优雅地实现StreamingHub方法的统一日志记录,无需在每个方法中重复编写日志代码。这种方法不仅提高了开发效率,还保证了日志记录的一致性。在实际应用中,开发者可以根据具体需求调整日志级别和内容,平衡调试需求和系统性能。
登录后查看全文
热门项目推荐
相关项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
1 freeCodeCamp英语课程填空题提示缺失问题分析2 freeCodeCamp全栈开发课程中React实验项目的分类修正3 freeCodeCamp音乐播放器项目中的函数调用问题解析4 freeCodeCamp课程页面空白问题的技术分析与解决方案5 freeCodeCamp全栈开发课程中测验游戏项目的参数顺序问题解析6 freeCodeCamp 课程中关于角色与职责描述的语法优化建议 7 freeCodeCamp全栈开发课程中React组件导出方式的衔接问题分析8 freeCodeCamp英语课程视频测验选项与提示不匹配问题分析9 freeCodeCamp Cafe Menu项目中link元素的void特性解析10 freeCodeCamp课程中屏幕放大器知识点优化分析
最新内容推荐
CVE-2024-38077伪代码修复版EXP资源详解:Windows远程桌面授权服务问题利用指南 TextAnimator for Unity:打造专业级文字动画效果的终极解决方案 开源电子设计自动化利器:KiCad EDA全方位使用指南 Photoshop作业资源文件下载指南:全面提升设计学习效率的必备素材库 RadiAnt DICOM Viewer 2021.2:专业医学影像阅片软件的全面指南 Launch4j中文版:Java应用程序打包成EXE的终极解决方案 CrystalIndex资源文件管理系统:高效索引与文件管理的最佳实践指南 中兴e读zedx.zed文档阅读器V4.11轻量版:专业通信设备文档阅读解决方案 32位ECC纠错Verilog代码:提升FPGA系统可靠性的关键技术方案 WebVideoDownloader:高效网页视频抓取工具全面使用指南
项目优选
收起
deepin linux kernel
C
24
6
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
242
2.38 K
仓颉编译器源码及 cjdb 调试工具。
C++
116
85
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
405
React Native鸿蒙化仓库
JavaScript
216
291
Ascend Extension for PyTorch
Python
79
113
仓颉编程语言运行时与标准库。
Cangjie
123
98
仓颉编程语言测试用例。
Cangjie
34
71
暂无简介
Dart
539
118
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
591
116