CA1837: Verwenden Sie "Environment.ProcessId" anstelle von "Process.GetCurrentProcess().Id"

Eigenschaft	Wert
Regel-ID	CA1837
Titel	Verwenden Sie "Environment.ProcessId" anstelle von "Process.GetCurrentProcess().Id"
Kategorie	Leistung
Fix führt oder führt nicht zur Unterbrechung	Nicht unterbrechend
Standardmäßig in .NET 8 aktiviert	Als Vorschlag

Ursache

Diese Regel sucht nach Aufrufen von System.Diagnostics.Process.GetCurrentProcess().Id und empfiehlt stattdessen die Verwendung von System.Environment.ProcessId, da sie effizienter ist.

Regelbeschreibung

System.Diagnostics.Process.GetCurrentProcess().Id ist aufwendig:

• Sie ordnet eine Process-Instanz zu, in der Regel nur, um Id zu erhalten.
• 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 Id 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.ProcessId vermeidet alle oben genannten.

Hinweis

Regel CA1837 ist ab .NET 5.0 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()
    {
        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

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 „Environment. ProcessId“ anstelle von „Process. GetCurrentProcess ().Id“ aus der Liste der angezeigten Optionen aus.

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

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

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

Siehe auch

• Leistungsregeln