过时的控制器日志记录

Question

我有一堆控制器，它们也提供不同版本的 API。

例如

/api/v1/controllerA/method
/api/v2/controllerA/method
/api/v1/controllerB/method

现在，我想使用提供的 .NET 属性将 /v1/controllerA/method 标记为 obsolete。

但是，我还想记录对过时控制器的每次使用。澄清一下 - 这些控制器方法不会产生编译警告/错误，因为没有人直接在解决方案中引用它们。它们由 http 客户端在运行时调用。所以警告对我没有任何作用。

我知道如何进行日志记录，但我不确定拦截obsolete 控制器方法的调用的最佳方法是什么。

Answer 1

遵循Passive Attributes by Mark Seemann的模式

他有一个完整的例子来说明如何做到这一点

这是一个可以做到这一点的类的简单实现

public class ObsoleteLoggingFilter : IActionFilter
{
    private readonly ILogger _logger;
    public ObsoleteLoggingFilter(ILogger logger)
    {
        _logger = logger;
    }
    public bool AllowMultiple { get { return true; } }

    public Task<HttpResponseMessage> ExecuteActionFilterAsync(HttpActionContext actionContext, CancellationToken cancellationToken, Func<Task<HttpResponseMessage>> continuation)
    {
        //check the action for obsolete, if null check the controller
        var obsoleteAttribute = actionContext
            .ActionDescriptor
            .GetCustomAttributes<ObsoleteAttribute>()
            .SingleOrDefault() ?? actionContext
                .ControllerContext
                .ControllerDescriptor
                .GetCustomAttributes<ObsoleteAttribute>()
                .SingleOrDefault();

        if (obsoleteAttribute == null)
            return continuation();

        var controller = actionContext.ActionDescriptor.ControllerDescriptor.ControllerName;
        var user = actionContext.RequestContext.Principal.Identity.Name;

        return continuation().ContinueWith(t =>
        {
            _logger.WarnFormat("{0} is calling obsolete controller {1}", user, controller);
            return t.Result;
        });
    }
}