.NET 6開發TodoList應用之請求日志組件HttpLogging介紹

Posted on by

背景

因為在上篇演示Action Filter的時候可能是因為舉的例子不夠好，有小夥伴在評論區指出.NET 6新增加的特性可以實現在視圖模型綁定之前允許記錄Http請求日志的組件：HttpLogging。這個組件我之前試過，而Action Filter與其用來記錄日志，更不如說是為Http請求的接收和響應提供瞭中間可以修改的機會。

本著讓更多的人瞭解新知識的出發點，這次我們臨時把這個主題加進來。

什麼是HttpLogging?

  1. HttpLogging 是 .NET 6 新加入的一個框架內置的中間件
  2. 它允許記錄HTTP請求和響應，可以提供以下信息的日志：
    • HTTP請求信息；
    • 普通屬性；
    • Header信息；
    • Body信息；
    • HTTP響應信息。

什麼時候可以考慮使用HttpLogging?

當你需要記錄HTTP請求和響應的信息或者部分信息時。

而當你使用它時，又需要註意什麼？

  1. 性能
    當你決定使用 HttpLogging 來記錄請求信息尤其是Body信息時，需要仔細考慮僅記錄必要的字段。當你不確定它會不會對你的程序有性能影響時，你需要進行性能測試。
  2. 隱私
    相比於性能，更容易被我們開發忽略掉的一點（而且是更加重要的一點）是：我們有沒有在日志中泄露一些個人隱私數據(Personally Identifiable Information, PII)? 敏感數據不應該直接被記錄到日志中，至少是需要經過加密或者混淆的。

怎麼用

這個中間件的用法非常簡單，兩個方法，六個可以配置的選項：

引入中間件

在Program.cs 的 app.MapControllers();之前添加中間件：

  • Program.cs
// 省略其他
app.UseHttpLogging();
app.MapControllers();

當我們使用默認配置的時候，來隨便找一個接口看一下效果：

  • 請求日志

  • 響應日志

所有默認配置下不記錄日志的字段都以[Redacted]代替，下面我們可以更改默認配置以顯示更多內容：

配置服務

Program.cs

// 省略其他...
builder.Services.AddControllers();
builder.Services.AddHttpLogging(options =>
{
    // 日志記錄的字段配置，可以以 | 連接
    options.LoggingFields = HttpLoggingFields.All;
    // 增加請求頭字段記錄
    options.RequestHeaders.Add("Sec-Fetch-Site");
    options.RequestHeaders.Add("Sec-Fetch-Mode");
    options.RequestHeaders.Add("Sec-Fetch-Dest");
    // 增加響應頭字段記錄
    options.ResponseHeaders.Add("Server");
    // 增加請求的媒體類型
    options.MediaTypeOptions.AddText("application/javascript");
    // 配置請求體日志最大長度
    options.RequestBodyLogLimit = 4096;
    // 配置響應體日志最大長度
    options.ResponseBodyLogLimit = 4096;
});

同樣的請求我們再來看看效果：

  • 請求日志，註意紅框標記的信息現在已經顯示瞭

  • 響應日志

總結

可以看到，這個中間件使用起來是比較簡單的。

參考資料

HTTP Logging in ASP.NET Core

.NET 6 中的 Http Logging 中間件

到此這篇關於.NET 6開發TodoList應用之請求日志組件HttpLogging介紹的文章就介紹到這瞭。希望對大傢的學習有所幫助，也希望大傢多多支持WalkonNet。

推薦閱讀：