如何让自定义日志包装方法触发CA2254警告？

这个问题我之前在封装日志扩展方法时也碰到过——明明原生的LogInformation会在传插值字符串时弹出CA2254警告，自己写的Info扩展方法却毫无提示，很容易不小心写出非结构化的日志。这里有两个靠谱的解决办法，你可以根据场景选择：

方法一：用[LoggerMessage]属性标记（推荐） #

这是微软官方推荐的方式，既能触发CA2254警告，还能让编译器生成更高效的日志代码，一举两得。

你只需要把自定义的Info方法改成部分方法，并加上[LoggerMessage]属性，指定日志级别和模板参数即可。编译器会自动帮你实现方法体，不用手动调用LogInformation：

using Microsoft.Extensions.Logging;

public static class LoggerExtensions
{
    // 用LoggerMessage标记，指定日志级别为Information
    [LoggerMessage(Level = LogLevel.Information, Message = "{Message}")]
    public static partial void Info(this ILogger logger, string message, params object[] args);
}

这样一来，当有人用插值字符串调用_logger.Info($"Logged User Id: {userId}")时，编译器就会像对待原生LogInformation一样，弹出CA2254警告：“模板应该是静态表达式”。

方法二：配置代码分析器识别你的自定义方法 #

如果你不想修改现有方法的实现，也可以通过.editorconfig文件告诉CA2254分析器：“我的这个自定义方法也是日志模板方法，要检查它的调用”。

在项目的.editorconfig文件中添加以下配置（替换成你自己的命名空间和方法签名）：

# 指定需要CA2254检查的自定义日志方法
dotnet_code_quality.CA2254.log_methods = YourNamespace.LoggerExtensions.Info(ILogger,string,object[])

保存后，分析器就会自动扫描这个方法的所有调用，一旦发现传入动态生成的字符串（比如插值字符串），就会触发警告。

补充说明 #

CA2254警告的核心目的是确保日志模板是静态字符串，这样日志框架才能正确解析占位符，生成结构化日志（比如把{UserId}作为独立字段存储，而不是直接拼接成字符串）。不管用哪种方法，最终都是让代码分析器把你的自定义方法识别为符合日志模板规范的方法，从而触发对应的检查。

内容来源于stack exchange