快捷導(dǎo)航

.NET?6開發(fā)TodoList應(yīng)用之請(qǐng)求日志組件HttpLogging介紹

更新時(shí)間：2022年01月01日 11:24:29 作者：CODE4NOTHING

這篇文章介紹了.NET?6開發(fā)TodoList應(yīng)用之請(qǐng)求日志組件HttpLogging，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

背景

因?yàn)樵谏掀菔?code>Action Filter的時(shí)候可能是因?yàn)榕e的例子不夠好，有小伙伴在評(píng)論區(qū)指出.NET 6新增加的特性可以實(shí)現(xiàn)在視圖模型綁定之前允許記錄Http請(qǐng)求日志的組件：HttpLogging。這個(gè)組件我之前試過，而Action Filter與其用來記錄日志，更不如說是為Http請(qǐng)求的接收和響應(yīng)提供了中間可以修改的機(jī)會(huì)。

本著讓更多的人了解新知識(shí)的出發(fā)點(diǎn)，這次我們臨時(shí)把這個(gè)主題加進(jìn)來。

什么是HttpLogging?

HttpLogging 是 .NET 6 新加入的一個(gè)框架內(nèi)置的中間件
它允許記錄HTTP請(qǐng)求和響應(yīng)，可以提供以下信息的日志：
- HTTP請(qǐng)求信息；
- 普通屬性；
- Header信息；
- Body信息；
- HTTP響應(yīng)信息。

什么時(shí)候可以考慮使用HttpLogging?

當(dāng)你需要記錄HTTP請(qǐng)求和響應(yīng)的信息或者部分信息時(shí)。

而當(dāng)你使用它時(shí)，又需要注意什么？

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

怎么用

這個(gè)中間件的用法非常簡(jiǎn)單，兩個(gè)方法，六個(gè)可以配置的選項(xiàng)：

引入中間件

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

Program.cs

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

當(dāng)我們使用默認(rèn)配置的時(shí)候，來隨便找一個(gè)接口看一下效果：

請(qǐng)求日志

響應(yīng)日志

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

配置服務(wù)

Program.cs

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

同樣的請(qǐng)求我們?cè)賮砜纯葱Ч?/p>