ASP.NET Core 2.0中如何在ILogger的Log方法内获取警告调用栈？

绝对可以！我之前也被EF这种“LINQ表达式无法翻译”的警告搞得头大——满屏警告却找不到哪段业务代码触发的，后来通过在ILogger的实现里捕获调用栈，完美解决了定位问题。

核心思路 #

EF抛出这类警告时，会通过ILogger输出日志。我们可以自定义一个Logger包装类，拦截这些特定警告，在Log方法内部生成调用栈，过滤掉EF框架本身的栈帧，只保留业务代码的调用位置，然后把定位信息追加到日志里。

实现步骤 #

1. 自定义EF警告追踪Logger

创建一个包装原有Logger的类，专门处理EF的LINQ无法翻译警告：

using System.Diagnostics;
using Microsoft.Extensions.Logging;

public class EfWarningTrackingLogger : ILogger
{
    private readonly ILogger _innerLogger;

    public EfWarningTrackingLogger(ILogger innerLogger)
    {
        _innerLogger = innerLogger;
    }

    public IDisposable BeginScope<TState>(TState state) => _innerLogger.BeginScope(state);

    public bool IsEnabled(LogLevel logLevel) => _innerLogger.IsEnabled(logLevel);

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
    {
        var originalMessage = formatter(state, exception);
        
        // 只拦截EF的LINQ无法翻译警告
        if (logLevel == LogLevel.Warning && originalMessage.Contains("The LINQ expression"))
        {
            // 获取完整调用栈，跳过EF框架和当前Logger的栈帧
            var stackTrace = new StackTrace(true);
            var businessFrame = stackTrace.GetFrames()?
                .SkipWhile(frame => 
                    // 跳过EF内部的代码栈帧
                    frame.GetMethod()?.DeclaringType?.Namespace?.StartsWith("Microsoft.EntityFrameworkCore") == true ||
                    // 跳过当前Logger自己的方法
                    frame.GetMethod()?.DeclaringType == typeof(EfWarningTrackingLogger))
                // 取第一个业务代码的栈帧
                .FirstOrDefault();

            if (businessFrame != null)
            {
                var method = businessFrame.GetMethod();
                var location = $"触发位置：文件={businessFrame.GetFileName()}，行号={businessFrame.GetFileLineNumber()}，方法={method?.DeclaringType?.FullName}.{method?.Name}";
                // 将定位信息追加到原日志消息
                var enhancedMessage = $"{originalMessage}\n{location}";
                _innerLogger.Log(logLevel, eventId, state, exception, (s, ex) => enhancedMessage);
            }
            else
            {
                // 找不到业务栈帧时，输出原日志
                _innerLogger.Log(logLevel, eventId, state, exception, formatter);
            }
        }
        else
        {
            // 非目标警告，直接转发给原有Logger
            _innerLogger.Log(logLevel, eventId, state, exception, formatter);
        }
    }
}

2. 注册自定义Logger

在项目的启动配置（比如Program.cs）中，替换或添加这个自定义Logger：

var builder = WebApplication.CreateBuilder(args);

// 方式1：作为LoggerProvider注册，全局生效
builder.Logging.AddProvider(new EfWarningTrackingLoggerProvider(builder.Services.BuildServiceProvider().GetRequiredService<ILoggerFactory>()));

// 方式2：直接包装DbContext对应的Logger，更精准
builder.Logging.Services.Replace(ServiceDescriptor.Singleton<ILogger<YourDbContext>>(sp => 
    new EfWarningTrackingLogger(sp.GetRequiredService<ILogger<YourDbContext>>())));

// 其他配置...
var app = builder.Build();

如果用方式1，需要额外实现一个EfWarningTrackingLoggerProvider：

public class EfWarningTrackingLoggerProvider : ILoggerProvider
{
    private readonly ILoggerFactory _loggerFactory;

    public EfWarningTrackingLoggerProvider(ILoggerFactory loggerFactory)
    {
        _loggerFactory = loggerFactory;
    }

    public ILogger CreateLogger(string categoryName)
    {
        return new EfWarningTrackingLogger(_loggerFactory.CreateLogger(categoryName));
    }

    public void Dispose() { }
}

注意事项 #

• 性能考量：StackTrace的生成有一定性能开销，建议在生产环境中只在排查问题时开启，或者通过配置开关控制是否启用该功能。
• 栈帧过滤调整：如果你的业务代码有特定的命名空间，可以在SkipWhile中加入额外的过滤条件，确保只保留你关心的代码位置。
• 日志格式兼容：如果你的项目用了结构化日志（比如Serilog），可以把定位信息作为额外字段添加，而不是直接追加到消息里，方便后续分析。

这样一来，下次EF再抛出LINQ无法翻译的警告时，日志里就会直接显示触发警告的业务代码文件、行号和方法名，定位问题再也不用瞎找了！

内容的提问来源于stack exchange，提问作者Makla