MagicOnion中如何记录StreamingHub方法的输入参数和返回值

在MagicOnion框架中，StreamingHub是构建实时通信应用的核心组件。开发者经常需要记录方法的输入参数和返回值，用于调试、监控或审计目的。本文将详细介绍如何在MagicOnion的StreamingHub中实现这一功能。

日志记录的基本方法

MagicOnion的StreamingHub继承自StreamingHubBase类，我们可以通过依赖注入获取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}, position={Position}, rotation={Rotation}", 
            roomName, userName, position, rotation);
        
        // 业务逻辑
        
        return players;
    }
}

使用过滤器实现统一日志记录

为了更系统化地记录所有方法的输入输出，可以使用MagicOnion的过滤器机制：

public class LoggingStreamingHubFilter : StreamingHubFilterAttribute
{
    public override async ValueTask Invoke(StreamingHubContext context, Func<StreamingHubContext, ValueTask> next)
    {
        var logger = context.ServiceProvider.GetRequiredService<ILogger<LoggingStreamingHubFilter>>();
        
        // 记录方法调用和参数
        logger.LogInformation("调用方法 {MethodName} 参数: {Parameters}", 
            context.MethodInfo.Name, 
            JsonSerializer.Serialize(context.Arguments));
        
        await next(context);
        
        // 记录返回值
        if(context.HasResult)
        {
            logger.LogInformation("方法 {MethodName} 返回: {Result}", 
                context.MethodInfo.Name, 
                JsonSerializer.Serialize(context.Result));
        }
    }
}

然后在Hub类上应用这个过滤器：

[LoggingStreamingHubFilter]
public class GamingHub : StreamingHubBase<IGamingHub, IGamingHubReceiver>, IGamingHub
{
    // Hub实现
}

处理复杂类型和性能考虑

当记录复杂类型如Vector3和Quaternion时，需要注意：

1. 考虑实现自定义的序列化逻辑，避免记录不必要的信息
2. 敏感信息应该进行脱敏处理
3. 在高频调用的方法中，考虑使用条件日志记录或采样记录

_logger.LogDebug("详细位置信息 - X:{X}, Y:{Y}, Z:{Z}", position.x, position.y, position.z);

最佳实践建议

1. 区分日志级别：使用Debug级别记录详细参数，Info级别记录关键方法调用
2. 结构化日志：使用命名占位符而非字符串拼接，便于日志系统解析
3. 异步方法：确保日志记录不会阻塞主流程
4. 性能监控：可以结合日志记录实现简单的性能监控

通过以上方法，开发者可以全面掌握MagicOnion StreamingHub的运行情况，快速定位问题，同时为系统监控提供有价值的数据。