CA1839: Verwenden von Environment.ProcessPath anstelle von Process.GetCurrentProcess().MainModule.FileName

Artikel
09/07/2023

Eigenschaft	Wert
Regel-ID	CA1839
Titel	Verwenden von „Environment.ProcessPath“ anstelle von „Process.GetCurrentProcess().MainModule.FileName“
Kategorie	Leistung
Fix führt oder führt nicht zur Unterbrechung	Nicht unterbrechend
Standardmäßig in .NET 9 aktiviert	Als Vorschlag

Ursache

Verwenden von Process.GetCurrentProcess().MainModule.FileName zum Abrufen des Pfads zu der Datei, die den Prozess gestartet hat, anstelle von Environment.ProcessPath.

Regelbeschreibung

System.Diagnostics.Process.GetCurrentProcess().MainModule.FileName ist aufwendig:

Die Regel ordnet eine Process- und ProcessModule-Instanz zu, in der Regel nur, um FileName abzurufen.
Die Process-Instanz muss verworfen werden, was sich auf die Leistung auswirkt.
Es ist leicht zu vergessen, Dispose() auf der Process-Instanz aufzurufen.
Wenn nichts anderes als FileName die Process-Instanz verwendet, vergrößert sich die verknüpfte Größe unnötig, indem der Graph der Typen vergrößert wird, auf die verwiesen wird.
Es ist etwas schwierig, diese API zu ermitteln oder zu finden.

System.Environment.ProcessPath vermeidet alle diese Nachteile und generiert die gleichen Informationen.

Hinweis

System.Environment.ProcessPath ist ab .NET 6 verfügbar.

Behandeln von Verstößen

Der Verstoß kann entweder manuell behoben werden oder in einigen Fällen schnelle Aktionen zum Beheben von Code in Visual Studio verwenden.

Die folgenden beiden Codeausschnitte zeigen z. B. einen Verstoß gegen die Regel und wie dieser korrigiert werden kann:

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

Tipp

Für diese Regel ist ein Codefix in Visual Studio verfügbar. Um ihn zu nutzen, muss der Cursor auf dem Verstoß platziert und STRG+. (Punkt) gedrückt werden. Wählen Sie in der Liste der angezeigten Optionen Environment.ProcessPath verwenden aus.

Codekorrektur für CA1839: Verwenden von „Environment.ProcessPath“

Wann sollten Warnungen unterdrückt werden?

Es ist sicher, einen Verstoß gegen diese Regel zu unterdrücken, wenn Sie sich keine Gedanken über die Auswirkungen auf die Leistung der unnötigen Zuteilung und Entsorgung der Process- und ProcessModule-Instanzen machen.

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

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

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.

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

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Freigeben über