CA1837: Gunakan Environment.ProcessId, bukan Process.GetCurrentProcess().Id
Properti | Nilai |
---|---|
ID Aturan | CA1837 |
Judul | Gunakan Environment.ProcessId alih-alih Process.GetCurrentProcess(). Id |
Golongan | Performa |
Perbaikan bersifat disruptif atau non-disruptif | Non-disruptif |
Diaktifkan secara default di .NET 9 | Sebagai saran |
Penyebab
Aturan ini menemukan panggilan ke System.Diagnostics.Process.GetCurrentProcess().Id
dan menyarankan penggunaan System.Environment.ProcessId
sebagai gantinya, karena lebih efisien.
Deskripsi aturan
System.Diagnostics.Process.GetCurrentProcess().Id
memerlukan banyak sumber daya:
- Hal ini mengalokasikan instans Process, biasanya hanya untuk mendapatkan
Id
. - Instans Process perlu dihapus karena memengaruhi performa.
- Pemanggilan Dispose() pada instans Process sering kali terlupakan.
- Jika tidak ada metode lain selain
Id
yang menggunakan instansProcess
, maka ukuran tertaut akan tumbuh secara tidak perlu dengan meningkatkan grafik jenis yang direferensikan. - Cukup rumit untuk menemukan atau mendapatkan API ini.
System.Environment.ProcessId
hindari semua hal di atas.
Catatan
Aturan CA1837 tersedia sejak .NET 5.0.
Cara memperbaiki pelanggaran
Pelanggaran dapat diperbaiki secara manual, atau, dalam beberapa kasus, menggunakan Tindakan Cepat untuk memperbaiki kode di Visual Studio.
Dua cuplikan kode berikut menunjukkan pelanggaran aturan dan cara memperbaikinya:
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
Tip
Perbaikan kode tersedia untuk aturan ini di Visual Studio. Untuk menggunakannya, posisikan kursor pada pelanggaran dan tekan Ctrl+. (titik). Pilih Gunakan 'Environment.ProcessId', bukan 'Process.GetCurrentProcess().Id' dari daftar opsi yang ditampilkan.
Kapan harus menekan peringatan
Anda dapat menyembunyikan pelanggaran aturan ini jika tidak khawatir tentang dampak performa dari alokasi yang tidak perlu dan pada akhirnya pembuangan instans Process.
Menyembunyikan peringatan
Jika Anda hanya ingin menyembunyikan satu pelanggaran, tambahkan arahan praprosedur ke file sumber Anda untuk dinonaktifkan lalu aktifkan kembali aturannya.
#pragma warning disable CA1837
// The code that's violating the rule is on this line.
#pragma warning restore CA1837
Untuk menonaktifkan aturan untuk file, folder, atau proyek, atur tingkat keparahannya ke none
dalam file konfigurasi.
[*.{cs,vb}]
dotnet_diagnostic.CA1837.severity = none
Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.