请求日志组件HttpLogging

背景

因为在上篇演示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介绍的文章就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持。