.NET Web API - 添加日志记录

Question

我正在寻找有关处理 API 日志记录的最佳方法的帮助。我想将所有请求和响应记录到 sql 或文本文件（如果这是最好的方法）。目前我已经在 SQL Server 的日志表中插入一行。我使用名为 LogAction 的静态方法来执行此操作，并在 Web API 中每个控制器的末尾附近运行它。我还记录了捕获的异常。有没有办法用 MVC Web API 来做到这一点，或者我走在正确的轨道上？

目前它看起来就像这样：

// Log API Call
System.Xml.Serialization.XmlSerializer x = new System.Xml.Serialization.XmlSerializer(request.GetType());
StringWriter s = new StringWriter();
x.Serialize(s, request);
Utilities.LogAction(Utilities.LogType.MAIN, false, response.ToString(), s.ToString(), "MainController: Successful");

有没有办法让它本地记录所有 API 操作？这对我来说是错误的，因为如果这个静态方法和实际返回响应之间发生了一些事情，那么这个日志就不再有效。记录 API 操作的最有效方法是什么？

Answer 1

为了记录对 API 操作的调用，我使用了如下自定义属性：

public class LogApiRequestAttribute : System.Web.Http.Filters.ActionFilterAttribute
{
    /// <summary>
    /// For Web API controllers
    /// </summary>
    /// <param name="actionExecutedContext"></param>
    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
        base.OnActionExecuted(actionExecutedContext);

        var request = actionExecutedContext.Request;
        var response = actionExecutedContext.Response;
        var actionContext = actionExecutedContext.ActionContext;

        // Log API Call
        ...
    }
}

您可能需要检查 actionExecutedContext 以查看它是否具有您想要的请求和响应信息。您可能想改为或同时重写 OnActionExecuting 方法。

然后使用以下属性装饰您的 Web API 控制器：

[LogApiRequest]
public void Post(SomeThingInputModel thing)
{
    // Controller code
    ...
}