如何为自定义方法实现结构化日志消息模板的Visual Studio高亮？

一、是否可以实现？ #

可以，Visual Studio支持通过代码分析特性，为自定义日志方法启用和原生ILogger<T>一致的消息模板参数高亮效果。

二、具体操作方法 #

有两种常用方式，可根据需求选择：

方式1：使用[MessageTemplateFormatMethod]特性（快速适配原有方法） #

该特性来自System.Diagnostics.CodeAnalysis命名空间，作用是明确告知IDE哪个参数是消息模板、对应的params数组是模板参数。直接给现有扩展方法添加特性即可：

using System.Diagnostics.CodeAnalysis;
using Microsoft.Extensions.Logging;

public static class LoggerExtensions
{
    [MessageTemplateFormatMethod(nameof(message))]
    public static bool LogExceptionNoCatch<T>(this ILogger<T> logger, Exception exception, string? message, params object?[] args)
    {
        logger.LogError(exception, message, args);
        return false;
    }
}

添加后，Visual Studio会自动识别message参数中的{XXX}占位符并高亮。

方式2：使用[LoggerMessage]特性（结合源生成器，性能更优） #

该特性来自Microsoft.Extensions.Logging，不仅能让IDE识别消息模板，还会触发源生成器生成高性能的日志代码，需要将方法改为partial：

using Microsoft.Extensions.Logging;

public static class LoggerExtensions
{
    [LoggerMessage(Level = LogLevel.Error)]
    public static partial bool LogExceptionNoCatch<T>(this ILogger<T> logger, Exception exception, string message, params object?[] args);
}

如果需要保留自定义逻辑，可拆分partial方法：

// 带特性的partial方法，由源生成器自动实现核心日志逻辑
public static partial class LoggerExtensions
{
    [LoggerMessage(Level = LogLevel.Error)]
    public static partial void LogExceptionCore<T>(ILogger<T> logger, Exception exception, string message, params object?[] args);
}

// 自定义扩展方法，调用生成的核心方法
public static class LoggerExtensions
{
    public static bool LogExceptionNoCatch<T>(this ILogger<T> logger, Exception exception, string? message, params object?[] args)
    {
        LogExceptionCore(logger, exception, message ?? string.Empty, args);
        return false;
    }
}

三、高亮效果背后的机制 #

Visual Studio的消息模板高亮依赖代码分析特性与IDE内置的模板解析逻辑：

• 原生ILogger<T>的LogXxx方法是IDE内置识别的，会自动解析参数中的消息模板字符串，匹配{参数名}格式的占位符并高亮。
• 自定义方法需要通过[MessageTemplateFormatMethod]或[LoggerMessage]特性向IDE传递元信息：指定哪个参数是消息模板、哪个是对应的模板参数数组。
• IDE获取这些特性信息后，套用和原生日志方法相同的解析规则，识别并高亮模板中的占位符，同时还能提供参数匹配验证等辅助功能。
• [LoggerMessage]还会触发.NET源生成器，在编译阶段生成优化的日志代码，提升性能的同时让IDE的识别更精准。

内容的提问来源于stack exchange，提问作者Ulf Åkerstedt