.NET Web API - 添加日志記錄

Question

我正在尋找有關處理API日志記錄的最佳方法的一些幫助。 我想將所有請求和響應記錄到sql或文本文件中，如果這是最好的方法。 目前我一直在SQL Server的日志表中插入一行。 我使用名為LogAction的靜態方法執行此操作，並在Web API中的每個Controller的末尾附近運行它。 我還記錄了捕獲的異常。 有沒有辦法在本機上使用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 Controller：

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