IDE如何匹配ILogger.LogInformation模板与参数？自定义方法可行吗？

IDE识别参数不匹配的原理 #

Visual Studio对ILogger.LogInformation这类方法的参数校验，是通过Roslyn代码分析器实现的，具体是.NET SDK自带的Microsoft.CodeAnalysis.NetAnalyzers包中的CA2017规则：

• 分析器会解析日志方法的第二个参数（消息模板字符串），提取其中的命名占位符（如{a}）的数量和名称
• 同时统计传入的params object?[] args参数的数量，若存在命名参数还会校验名称匹配性
• 当占位符数量与参数数量不匹配时，分别触发两种提示：多余参数置灰提示“参数未在消息模板中使用”，缺失参数的占位符下方标波浪线提示“消息模板中存在未定义的参数”，最终统一触发CA2017警告

这个校验逻辑是分析器针对ILogger扩展方法的特定实现，不需要方法签名上的属性关联——分析器直接识别方法的签名模式（ILogger扩展、消息模板参数+params参数）并执行校验。

给自定义ILogger扩展方法实现类似校验 #

有两种可行方案：

方案1：利用.NET内置的LoggerMessageAttribute生成规范日志方法 #

如果你的自定义日志逻辑可以通过LoggerMessageAttribute来实现，直接标记方法即可被现有CA2017分析器识别：

public static class CustomLoggerExtensions
{
    [LoggerMessage(EventId = 100, Level = LogLevel.Information, Message = "User {UserId} performed action {Action}")]
    public static void LogUserAction(this ILogger logger, string userId, string action)
    {
        // 方法体可由源代码生成器自动实现，无需手动写模板与参数关联
    }
}

这种方式下，源代码生成器会自动生成符合规范的日志代码，同时现有分析器会自动校验参数与模板的匹配性。

方案2：编写自定义Roslyn分析器 #

如果必须用自定义的扩展方法签名（比如保留params object[] args的形式），需要编写自定义分析器：

• 定义分析器规则，识别你的自定义扩展方法的签名（如：第一个参数是ILogger，第二个是string类型的消息模板，第三个是params object[]）
• 复用CA2017的核心逻辑：解析消息模板中的占位符，对比args参数的数量/名称
• 将分析器打包为NuGet包，在项目中引用后即可实现类似的实时校验和警告

注意：自定义分析器需要熟悉Roslyn的代码分析API，实现起来有一定复杂度，但能完全自定义校验逻辑。

内容的提问来源于stack exchange，提问作者Josh Brunton