MagicOnion中实现StreamingHub方法参数与返回值的日志记录

前言

在使用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) }
        }
    );

参数序列化注意事项

在记录复杂类型参数时，需要注意：

1. 确保类型可序列化，特别是自定义类型
2. 对于包含循环引用的对象，需要配置序列化选项
3. 敏感信息应考虑脱敏处理

可以自定义序列化选项：

var options = new JsonSerializerOptions
{
    WriteIndented = true,
    ReferenceHandler = ReferenceHandler.IgnoreCycles
};
JsonSerializer.Serialize(value, options);

性能优化建议

日志记录虽然重要，但也需要考虑性能影响：

1. 在高频调用的方法上考虑使用Debug级别日志
2. 对大对象记录时只记录关键属性
3. 考虑使用条件日志记录

if (_logger.IsEnabled(LogLevel.Debug))
{
    _logger.LogDebug("详细日志信息...");
}

总结

通过MagicOnion的过滤器机制，我们可以优雅地实现StreamingHub方法的统一日志记录，无需在每个方法中重复编写日志代码。这种方法不仅提高了开发效率，还保证了日志记录的一致性。在实际应用中，开发者可以根据具体需求调整日志级别和内容，平衡调试需求和系统性能。