.NET 中 Logger 常被忽视的方法 BeginScope
💡
原文中文，约3000字，阅读约需8分钟。
📝
内容提要
BeginScope 方法是 .NET ILogger 接口的一部分，用于创建日志记录的作用域，从而提高日志的可读性和调试效率。通过配置 appsettings.json 启用作用域信息，并在代码中使用 BeginScope 方法添加上下文信息。自定义 ILogger 接口可以将作用域信息以 JSON 格式输出。
🎯
关键要点
- BeginScope 方法是 .NET ILogger 接口的一部分，用于创建日志记录的作用域。
- 作用域可以将特定的上下文信息包含在日志中，提高日志的可读性和调试效率。
- 在 appsettings.json 中配置日志以启用作用域信息，IncludeScopes 设置为 true。
- 使用 BeginScope 方法在日志中添加上下文信息，示例代码展示了如何使用该方法。
- 通过实现自定义 ILogger 接口，可以将作用域信息以 JSON 格式输出。
- ScopeLogger 类实现了 ILogger 接口，并在日志中包含作用域信息。
- ScopeLoggerProvider 类用于创建 ScopeLogger 实例并提供给日志系统。
- 代码示例展示了如何清除默认日志提供者并添加自定义的 ScopeLoggerProvider。
❓
延伸问答
BeginScope 方法在 .NET 中的作用是什么？
BeginScope 方法用于创建日志记录的作用域，能够将特定的上下文信息包含在日志中，从而提高日志的可读性和调试效率。
如何在 appsettings.json 中启用日志的作用域信息？
在 appsettings.json 中，将 IncludeScopes 设置为 true，以启用日志的作用域信息。
使用 BeginScope 方法时，如何添加上下文信息？
可以在代码中使用 BeginScope 方法，例如：using (_logger.BeginScope("TenantName {TenantName}", "test")) { ... }，在作用域内的日志将包含该上下文信息。
如何自定义 ILogger 接口以输出 JSON 格式的作用域信息？
通过实现自定义的 ILogger 接口，例如 ScopeLogger 类，可以将作用域信息以 JSON 格式输出。
ScopeLoggerProvider 类的作用是什么？
ScopeLoggerProvider 类用于创建 ScopeLogger 实例并提供给日志系统，以便使用自定义的日志记录功能。
如何在代码中清除默认日志提供者并添加自定义的 ScopeLoggerProvider？
可以使用 builder.Logging.ClearProviders() 清除默认日志提供者，然后使用 builder.Logging.AddProvider(new ScopeLoggerProvider()) 添加自定义的 ScopeLoggerProvider。
➡️
