CA1839: "Usar Environment.ProcessPath" en lugar de "Process.GetCurrentProcess().MainModule.FileName"

Article
11/15/2023

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

Causa

El uso de Process.GetCurrentProcess().MainModule.FileName para obtener la ruta de acceso al archivo que inició el proceso en lugar de Environment.ProcessPath.

Descripción de la regla

System.Diagnostics.Process.GetCurrentProcess().MainModule.FileName es costoso:

Asigna una instancia de Process y ProcessModule, normalmente solo para obtener FileName.
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 FileName 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.ProcessPath evita todos estos inconvenientes y genera la misma información.

Nota

System.Environment.ProcessPath está disponible a partir de .NET 6.

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()
    {
        string path = Process.GetCurrentProcess().MainModule.FileName; // Violation occurs
    }
}

Imports System.Diagnostics

Class MyClass
    Private Sub MyMethod()
        Dim path As String = Process.GetCurrentProcess().MainModule.FileName ' Violation occurs.
    End Function
End Class

using System.Diagnostics;

class MyClass
{
    void MyMethod()
    {
        string path = System.Environment.ProcessPath; // Violation fixed
    }
}

Imports System.Diagnostics

Class MyClass
    Private Sub MyMethod()
        Dim path As String = System.Environment.ProcessPath ' Violation fixed.
    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.ProcessPath" en la lista de opciones que se presenta.

Corrección de código para CA1839: Usar

Cuándo suprimir las advertencias

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

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 CA1839
// The code that's violating the rule is on this line.
#pragma warning restore CA1839

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.CA1839.severity = none

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

Comparteix a través de