Bagikan melalui

CA1839: Gunakan Environment.ProcessPath, bukan Process.GetCurrentProcess().MainModule.FileName

  • Artikel
Properti Nilai
ID Aturan CA1839
Judul Gunakan Environment.ProcessPath alih-alih Process.GetCurrentProcess(). MainModule.FileName
Golongan Performa
Perbaikan bersifat disruptif atau non-disruptif Non-disruptif
Diaktifkan secara default di .NET 8 Sebagai saran

Penyebab

Menggunakan Process.GetCurrentProcess().MainModule.FileName untuk mendapatkan jalur ke file yang meluncurkan proses selain Environment.ProcessPath.

Deskripsi aturan

System.Diagnostics.Process.GetCurrentProcess().MainModule.FileName memerlukan banyak sumber daya:

  • Hal ini mengalokasikan instans Process dan ProcessModule, biasanya hanya untuk mendapatkan FileName.
  • Instans Process perlu dihapus karena memengaruhi performa.
  • Pemanggilan Dispose() pada instans Process sering kali terlupakan.
  • Jika tidak ada metode lain selain FileName yang menggunakan instans Process, maka ukuran tertaut akan tumbuh secara tidak perlu dengan meningkatkan grafik jenis yang direferensikan.
  • Cukup rumit untuk menemukan atau mendapatkan API ini.

System.Environment.ProcessPath menghindari semua kelemahan ini dan menghasilkan informasi yang sama.

Catatan

System.Environment.ProcessPath ini tersedia mulai dari .NET 6.

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()
    {
        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

Tip

Perbaikan kode tersedia untuk aturan ini di Visual Studio. Untuk menggunakannya, posisikan kursor pada pelanggaran dan tekan Ctrl+. (titik). Pilih Gunakan 'Environment.ProcessPath' dari daftar opsi yang disajikan.

Code fix for CA1839 - Use 'Environment.ProcessPath'

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 dan ProcessModule.

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

Untuk menonaktifkan aturan untuk file, folder, atau proyek, atur tingkat keparahannya ke none dalam file konfigurasi.

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Baca juga