ReSharper Structured Logging 使用指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00781/article/details/142040642

ReSharper Structured Logging 使用指南

resharper-structured-loggingAn extension for ReSharper and Rider that highlights structured logging templates and contains some useful analyzers项目地址:https://gitcode.com/gh_mirrors/re/resharper-structured-logging

项目介绍

ReSharper Structured Logging 是一款专为 ReSharper 和 Rider IDE 设计的扩展插件。该插件致力于提升 .NET 开发中的日志记录体验，通过高亮显示结构化日志模板，并提供一系列实用的分析器。自从 ReSharper/Rider 2021.2 版本开始，高亮显示已成为内置特性，但此扩展仍包含一些 JetBrain 团队尚未实现的有用分析功能。它全面支持 Serilog、NLog 及 Microsoft.Extensions.Logging 这些主流的日志框架。

项目快速启动

安装步骤

对于 ReSharper 用户：

打开 ReSharper 的扩展管理器。
搜索 Structured Logging。
点击安装并重启Visual Studio以使更改生效。

对于 Rider 用户：

进入设置或首选项中找到 Plugins。
选择 “Browse repositories” 并搜索 Structured Logging。
安装插件并重新启动 Rider。

快速使用示例

假设我们正在使用 Microsoft.Extensions.Logging，一个基本的结构化日志记录例子如下：

using Microsoft.Extensions.Logging;

public class Service
{
    private readonly ILogger<Service> _logger;
    
    public Service(ILogger<Service> logger)
    {
        _logger = logger;
    }

    public void DoWork()
    {
        var data = new { Name = "Example", Value = 42 };
        
        // 结构化日志消息
        _logger.LogInformation("{Name} has a value of {Value}", data.Name, data.Value);
    }
}

安装插件后，上述代码中使用 {} 包裹的占位符将会被高亮显示，帮助你更清晰地识别日志模式。

应用案例和最佳实践

在复杂的应用场景中，利用匿名对象来传递多个参数进行结构化日志记录可以显著提高可读性和灵活性：

// 优化的日志记录
var logData = new { UserId = userId, Action = "Login", Success = authenticationResult };
_logger.LogInformation("User login attempt: {@LogData}", logData);

此处，推荐的做法是使用 @ 符号前缀来“分解”（destructure）整个对象，使得日志接收端能够很好地解析到每个属性值。

典型生态项目

虽然 ReSharper Structured Logging 主要增强对三大日志库的支持，但在 .NET 生态系统中，与其他如 Serilog 的 enrichers 或 sink 配合使用，可以极大丰富你的日志处理能力。例如，结合 Serilog 的 Seq sink，你可以将结构化日志发送至 Seq 这样的高级日志平台，以便于进行高级查询和分析。

以上就是基于 ReSharper Structured Logging 开源项目的基本使用教程。正确配置和运用此插件，将极大地改善你的日志管理和追踪效率。