我如何用记录器包装任何方法？

Question

有一个通过服务实例调用的示例方法。

 _logger.LogDebug("Create runned !");
 await _service.Create();
_logger.LogDebug("Create completed successfully");

我怎样才能在进入之前和被调用的方法之后更有效地写日志？

例如：

using(Log.Wrapper())
{
   await _service.Create()
}

Answer 1

一种可能的方法是使用某种工具重写从您的程序生成的 IL 代码，这样您就可以在编译后注入日志记录。 这篇文章好像是介绍实践的，商业工具我也见过，但不是我用过的。

我倾向于使用的方法是创建一个装饰器，通常使用辅助方法从一个中心位置进行实际的日志记录：

public class MyLoggingDecorator : IMyInterface{

public MyLoggingDecorator(IMyInterface backing, ILogger logger){...}

private T LogBeforeAndAfter(Func<T> method, [CallerMemberName]string caller = null){
    logger.Info("Called: " + caller);
    var result = method();
    logger.Info("Call " + caller + " completed");
    return result;
}
int IMyInterface.MyExampleMethod(int parameter) => LogBeforeAndAfter(() => backing.MyExampleMethod(parameter));

这有一些开销，并且不如直接在每个方法中调用日志那样高效，但它可以帮助使代码更紧凑。 而且任何开销都可能低于首先进行日志记录的成本。

您的“使用”示例可能不是我推荐在公共 API 中使用的示例。但如果您仅在自己的代码中使用它，并且您的同事不抱怨，我真的看不出有任何问题。 只需创建这样的东西 class

public class LogBeforeAndAfter : IDisposable
{
    private readonly ILogger log;
    private readonly string caller;

    public LogBeforeAndAfter(ILogger log, string caller)
    {
        this.log = log;
        this.caller = caller;
        log.Info("Called: " + caller);
    }

    public void Dispose() => log.Info("Call " + caller + " completed");
}
...
public static LogBeforeAndAfter LogBeforeAndAfter(this ILogger log, [CallerMemberName] string caller = "") => new (log, caller);