CA1837：使用 Environment.ProcessId 而不是 Process.GetCurrentProcess().Id

属性	值
规则 ID	CA1837
标题	使用 Environment.ProcessId 而不是 Process.GetCurrentProcess().Id
类别	“性能”
修复是中断修复还是非中断修复	非中断
在 .NET 8 中默认启用	作为建议

原因

此规则会查找对 System.Diagnostics.Process.GetCurrentProcess().Id 的调用，并建议改用 System.Environment.ProcessId，因为这样更高效。

规则说明

System.Diagnostics.Process.GetCurrentProcess().Id 成本较高：

• 它分配 Process 实例，通常只为了获取 Id。
• 需要处置 Process 实例，这会影响性能。
• 很容易忘记调用 Process 实例上的 Dispose()。
• 如果除了 Id 之外没有其他内容使用 Process 实例，那么随着引用的类型图增加，链接大小也会不必要的增长。
• 发现或查找此 API 有点困难。

System.Environment.ProcessId 可避免上述所有情况。

注意

从 .NET 5.0 开始可以使用规则 CA1837。

如何解决冲突

可以手动解决冲突，或者在某些情况下，使用快速操作来修复 Visual Studio 中的代码。

以下两个代码片段显示了规则冲突及其解决方法：

using System.Diagnostics;

class MyClass
{
    void MyMethod()
    {
        int pid = Process.GetCurrentProcess().Id;
    }
}

Imports System.Diagnostics

Class MyClass
    Private Sub MyMethod()
        Dim pid As Integer = Process.GetCurrentProcess().Id
    End Function
End Class

using System.Diagnostics;

class MyClass
{
    void MyMethod()
    {
        int pid = System.Environment.ProcessId;
    }
}

Imports System.Diagnostics

Class MyClass
    Private Sub MyMethod()
        Dim pid As Integer = System.Environment.ProcessId
    End Function
End Class

提示

Visual Studio 中为此规则提供了代码修补程序。 若要使用它，请将光标置于冲突上，然后按“Ctrl+.”（句点）。 从显示的选项列表中选择“使用‘Environment.ProcessId’而不是‘Process.GetCurrentProcess().Id’”。

何时禁止显示警告

如果你不关心不必要的分配和最终处置 Process 实例造成的性能影响，可禁止显示此规则的冲突警告。

抑制警告

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

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

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

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

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

另请参阅

• 性能规则