通过


CA1822: 将成员标记为“static”

属性
规则 ID CA1822
标题 将成员标记为 static(静态)
类别 “性能”
修复会引起中断还是不会引起中断 不破坏性质 - 如果成员在程序集外部不可见,那么无论进行了什么更改,都属于不破坏性质的修改。

无中断 - 仅当使用 this 关键字将成员更改为实例成员时,视为无中断修改。

中断变更 - 如果将成员从实例成员更改为静态成员,并且该成员在程序集外部可见,则可能会导致中断。
在 .NET 10 中默认启用 作为一种建议
适用的语言 C# 和 Visual Basic

原因

不访问实例数据的成员没有被标记为静态(在 Visual Basic 中为 Shared)。

规则说明

如果成员不访问实例数据或不调用实例方法,可以将其标记为静态(在 Visual Basic 中称为共享)。 在将这些方法标记为 static 之后,编译器将向这些成员发出非虚拟调用站点。 生成非虚调用点将防止在运行时检查每个调用,以确认当前对象指针不为 null。 这会使性能敏感的代码的性能得到显著提高。 在某些情况下,访问当前对象实例失败表示存在正确性问题。

如何解决违规

将成员标记为静态(在 Visual Basic 中为共享),或在方法主体中使用“this”/“Me”(如果适用)。

Example

public class Printer
{
    private readonly List<char> _items = [
        'H', 'e', 'l', 'l', 'o',
    ];

    public void PrintHello()
    {
        BadPrintHelloInternal();
        GoodPrintHelloInternal();
        GoodPrintHelloStaticInternal();
    }

    // This method violates the rule.
    private void BadPrintHelloInternal()
    {
        Console.WriteLine("Hello");
    }

    // This methods satisfies the rule.
    private void GoodPrintHelloInternal()
    {
        Console.WriteLine(string.Join(string.Empty, this._items));
    }

    private static void GoodPrintHelloStaticInternal()
    {
        Console.WriteLine("Hello");
    }
}

何时禁止显示警告

在以下情况下,可以安全地禁止显示此规则的警告:

  • 对于已发布的代码,修补程序会对其造成重大更改。
  • 对于继承自 MarshalByRefObject. 的类中的方法。 这些类中的方法不应标记为静态,因为 .NET 远程处理基础结构使用实例调度跨 AppDomain 边界转发调用。 使此类方法保持静态可能会破坏跨 AppDomain 边界的远程处理。

抑制警告

如果只想抑制单个冲突,请将预处理器指令添加到源文件以禁用该规则,然后重新启用该规则。

#pragma warning disable CA1822
// The code that's violating the rule is on this line.
#pragma warning restore CA1822

若要对文件、文件夹或项目禁用该规则,请在none中将其严重性设置为

[*.{cs,vb}]
dotnet_diagnostic.CA1822.severity = none

有关详细信息,请参阅如何禁止显示代码分析警告

配置代码以进行分析

使用下面的选项来配置代码库的哪些部分要运行此规则。

可以仅为此规则、为适用的所有规则或为适用的此类别(性能)中的所有规则配置此选项。 有关详细信息,请参阅代码质量规则配置选项

包含特定的 API 图面

你可以通过设置 api_surface 选项来配置要基于可访问性对代码库的哪些部分运行此规则。 例如,若要指定规则应仅针对非公共 API 图面运行,请将以下键值对添加到项目中的 .editorconfig 文件:

dotnet_code_quality.CAXXXX.api_surface = private, internal

注意

XXXXCAXXXX 部分替换为适用规则的 ID。