使第三方库中的扩展方法过时

Question

这个问题与我用[System.Obsolete]标记的方法无关.我想忽略的方法是在一个我无法控制的DLL中.

我使用第三方库,其中包含对象的扩展方法.这会导致混淆,并可能在将来引起问题.有没有办法将此扩展方法(或来自某个dll的所有扩展方法)标记为外部过时或阻止此扩展方法出现在intellisense中.有问题的方法是:

    public static class ExtensionMethods
    {
      public static bool IsNumeric(this object obj)
      {
        if (obj == null)
          return false;
        return obj.GetType().IsPrimitive || obj is double || (obj is Decimal || obj is DateTime) || obj is TimeSpan;
      }
    }

Answer 1

您可以使用 Roslyn 代码分析器执行此操作。以下代码将创建一个DiagnosticAnalyzer，如果String.EndsWith()使用，将给出编译器警告。

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class ForbiddenMethodsAnalyzer : DiagnosticAnalyzer
{
    private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor("Forbidden",
                                                                                 "Don't use this method!",
                                                                                 "Use of the '{0}' method is not allowed",
                                                                                 "Forbidden.Stuff",
                                                                                 DiagnosticSeverity.Warning,
                                                                                 isEnabledByDefault: true,
                                                                                 description: "This method is forbidden");
    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get { return ImmutableArray.Create(Rule); } }

    public override void Initialize(AnalysisContext context)
    {
        context.RegisterSyntaxNodeAction(AnalyzeSyntaxNode, SyntaxKind.InvocationExpression);
    }

    private static void AnalyzeSyntaxNode(SyntaxNodeAnalysisContext context)
    {
        var invocationExpression = (InvocationExpressionSyntax)context.Node;
        var memberAccessExpression = invocationExpression.Expression as MemberAccessExpressionSyntax;
        if (memberAccessExpression?.Name.ToString() == "EndsWith")
        {
            var memberSymbol = context.SemanticModel.GetSymbolInfo(memberAccessExpression).Symbol as IMethodSymbol;
            var containingType = memberSymbol.ContainingType;
            if (containingType.ContainingNamespace.Name == "System" && containingType.Name == "String")
            {
                var diagnostic = Diagnostic.Create(Rule, invocationExpression.GetLocation(), memberAccessExpression.ToString());
                context.ReportDiagnostic(diagnostic);
            }
        }
    }
}

有 3 个选项可以使用这样的分析器：

• 将DiagnosticAnalyzer代码直接添加到您的项目中。它仅适用于该解决方案。
• 创建一个包含其中的类库DiagnosticAnalyzer，并将其作为 Nuget 包分发。它仅适用于使用该软件包的解决方案。
• 编译包含该类的完整 VSIX 扩展。分析器将处理您加载的任何解决方案。

这是我完成的第一个使用 Roslyn 代码分析功能的项目，所以不幸的是我不了解这里发生的一切。我从默认的分析器模板开始，尝试了各种方法，逐步执行代码，并使用监视窗口查看变量，直到找到此功能所需的信息。

基本过程是注册一个 SyntaxNode 分析函数，过滤到调用方法的表达式。在这个方法我检查，看看是否Name在的MemberAccessExpressionSyntax被检验为“的endsWith”。如果是，我会ContainingType知道该方法已打开，并检查它是否在命名空间中的String类上System。如果是，我Diagnostic从 a创建一个实例DiagnosticDescriptor来告诉 IDE 问题出在哪里，以及它代表多少问题（在这种情况下是警告，如果需要，我可以将其设为完整错误，这将阻止代码从编译）。也可以向用户提供不同的选项来自动修复错误，但我还没有探索过。

许多信息来自本教程，以及大量的反复试验。

Answer 2

处理此问题的最佳方法是使用 Roslyn 并创建您自己的代码分析器，或使用 FxCop 等现有工具。

然而，我找到了一个非常不优雅的解决方法。

在您的项目中，您可以使用完全相同的方法创建一个与引用的类同名的类，该类位于相同的命名空间中。现在将您的方法标记为已过时。

下面的代码示例引用了一个库，ExtensionMethods该库包含一个在命名空间中定义的类External。在标有注释的行中(*)，使用静态方法调用语法调用该方法时，编译器会警告您该类型ExtensionMethods与导入的类型冲突。它还告诉您该方法已过时（因为您已经隐藏了导入的类型，所以它会看到您的定义）。因此，当您调用该方法时，您的代码就会运行。在标有注释的行中(**)，使用扩展方法调用语法调用该方法，编译器表示该调用不明确，并且代码无法编译。我知道的唯一解决方法是将此调用转换为 line (*)，这将产生过时的警告。

通过此解决方案，如果您使用扩展方法语法，那么您将能够从引用的类型调用其他扩展方法，前提是您的类中没有定义相同的方法。

using System;
using External;

namespace Internal
{
    class Program
    {
        static void Main(string[] args)
        {
            ExtensionMethods.IsNumeric(new object()); // (*)
            new object().IsNumeric(); // (**)
        }
    }
}

namespace External
{
    public static class ExtensionMethods
    {
        [Obsolete]
        public static bool IsNumeric(this object o)
        {
            if (obj == null)
              return false;
            return obj.GetType().IsPrimitive || obj is double || (obj is Decimal || obj is DateTime) || obj is TimeSpan;
        }
    }
}