如何为.NET二进制类库的特定方法调用生成编译警告

这问题我之前帮人处理过，正好有几个靠谱的方案，给你详细说说：

这是最贴合你需求的方案——直接在编译阶段检测对目标方法的调用，自动抛出警告，完全不需要改动现有代码，也不用碰外部类库的源码。

实现步骤： #

1. 在Visual Studio里创建一个「.NET Standard 类库」，然后安装Microsoft.CodeAnalysis.CSharp和Microsoft.CodeAnalysis.Analyzers NuGet包；
2. 编写分析器核心代码，检测对ExternalAPI.MethodCallNotThreadSafe的调用：

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics;
using System.Collections.Immutable;

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class UnsafeMethodCallAnalyzer : DiagnosticAnalyzer
{
    // 自定义诊断ID，唯一即可
    public const string DiagnosticId = "UnsafeMethodWarning_001";
    private static readonly LocalizableString Title = "调用了非线程安全方法";
    private static readonly LocalizableString MessageFormat = "方法 '{0}' 不具备线程安全性，请确认调用场景是否安全";
    private static readonly LocalizableString Description = "检测到调用外部API中的非线程安全方法，存在并发风险";
    private const string Category = "代码规范";

    // 定义诊断规则：警告级别，默认启用
    private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor(
        DiagnosticId, Title, MessageFormat, Category,
        DiagnosticSeverity.Warning, isEnabledByDefault: true, description: Description);

    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);

    public override void Initialize(AnalysisContext context)
    {
        context.EnableConcurrentExecution();
        context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);

        // 监听所有方法调用的语法节点
        context.RegisterSyntaxNodeAction(AnalyzeMethodInvocation, SyntaxKind.InvocationExpression);
    }

    private void AnalyzeMethodInvocation(SyntaxNodeAnalysisContext context)
    {
        var invocationExpr = (InvocationExpressionSyntax)context.Node;
        var symbolInfo = context.SemanticModel.GetSymbolInfo(invocationExpr.Expression);
        var methodSymbol = symbolInfo.Symbol as IMethodSymbol;

        // 精准匹配目标方法：替换成你实际的命名空间
        if (methodSymbol != null
            && methodSymbol.Name == "MethodCallNotThreadSafe"
            && methodSymbol.ContainingType.Name == "ExternalAPI"
            && methodSymbol.ContainingType.ContainingNamespace.ToString() == "YourExternalLibrary.Namespace")
        {
            // 在调用位置抛出警告
            var diagnostic = Diagnostic.Create(Rule, invocationExpr.GetLocation(), methodSymbol.Name);
            context.ReportDiagnostic(diagnostic);
        }
    }
}

3. 把这个分析器打包成NuGet包（或者直接引用项目），在你的业务项目里添加引用；
4. 编译项目时，只要代码里调用了MethodCallNotThreadSafe()，就会自动弹出你定义的警告。

优点： #

• 完全不用改现有业务代码，侵入性为0；
• 编译阶段强制检测，不会漏过任何调用；
• 警告信息可以自定义，清晰传达风险。

如果不想写分析器，这个方案更简单——给外部类做一层包装，把需要警告的方法标记为[Obsolete]，然后要求项目里统一通过包装类调用外部API。

实现代码： #

public class ExternalAPIWrapper
{
    private readonly ExternalAPI _innerApi;

    public ExternalAPIWrapper()
    {
        _innerApi = new ExternalAPI();
    }

    // 标记为警告级别的Obsolete，false表示只出警告不报错
    [Obsolete("此方法非线程安全，建议优先使用MethodCallThreadSafe", false)]
    public void MethodCallNotThreadSafe()
    {
        _innerApi.MethodCallNotThreadSafe();
    }

    // 安全方法正常暴露
    public void MethodCallThreadSafe()
    {
        _innerApi.MethodCallThreadSafe();
    }
}

使用方式： #

把项目里原来的ExternalAPI实例替换成ExternalAPIWrapper：

// 原来的代码（不会触发警告）
// ExternalAPI api = new ExternalAPI();
// api.MethodCallNotThreadSafe();

// 替换后的代码（会触发Obsolete警告）
var api = new ExternalAPIWrapper();
api.MethodCallNotThreadSafe(); // 这里会弹出编译警告

优点： #

• 代码量极少，5分钟就能搞定；
• 不需要额外学习Roslyn分析器的知识。

缺点： #

• 需要修改现有代码的调用逻辑，依赖团队成员遵守规范；
• 如果有人直接调用原ExternalAPI的方法，警告会失效。

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