CA1837: Usar Environment.ProcessId en lugar de Process.GetCurrentProcess().Id

Propiedad	Value
Identificador de la regla	CA1837
Título	Usar Environment.ProcessId en lugar de Process.GetCurrentProcess().Id
Categoría	Rendimiento
La corrección es problemática o no problemática	Poco problemático
Habilitado de forma predeterminada en .NET 8	Como sugerencia

Causa

Esta regla busca llamadas a System.Diagnostics.Process.GetCurrentProcess().Id y sugiere usar System.Environment.ProcessId en su lugar porque es más eficaz.

Descripción de la regla

System.Diagnostics.Process.GetCurrentProcess().Id es costoso:

• Asigna una instancia Process, normalmente solo para obtener el Id.
• La instancia Process debe desecharse, lo que tiene un impacto en el rendimiento.
• Es fácil olvidarse de llamar a Dispose() en la instancia Process.
• Si aparte de Id no hay nada más que utilice la instancia Process, el tamaño vinculado crece innecesariamente aumentando el gráfico de tipos a los que se hace referencia.
• Es algo difícil detectar o encontrar esta API.

System.Environment.ProcessId evita todo lo anterior.

Nota

La regla CA1837 está disponible a partir de .NET 5.0.

Cómo corregir infracciones

La infracción se puede corregir manualmente o, en algunos casos, se pueden usar acciones rápidas para corregir el código en Visual Studio.

En los dos fragmentos de código siguientes se muestra una infracción de la regla y cómo corregirla:

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

Sugerencia

Hay disponible una corrección de código para esta regla en Visual Studio. Para usarlo, coloque el cursor sobre la infracción y presione Ctrl+. (punto). Elija Usar "Environment.ProcessId" en lugar de "Process.GetCurrentProcess().Id" de la lista de opciones que se presentan.

Cuándo suprimir las advertencias

Se puede suprimir una infracción de esta regla si no le preocupa el impacto en el rendimiento de la asignación innecesaria y la eliminación eventual de una instancia Process.

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

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

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

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

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Vea también

• Reglas de rendimiento