CA1826: Gunakan properti, bukan metode Linq Enumerable
Properti | Nilai |
---|---|
ID Aturan | CA1826 |
Judul | Gunakan properti alih-alih metode Linq Enumerable |
Golongan | Performa |
Perbaikan bersifat disruptif atau non-disruptif | Non-disruptif |
Diaktifkan secara default di .NET 9 | Sebagai saran |
Penyebab
Metode LINQ Enumerable digunakan pada jenis yang mendukung properti yang setara dan lebih efisien.
Deskripsi aturan
Aturan ini menandai Enumerable panggilan metode LINQ pada kumpulan jenis yang memiliki properti yang setara tetapi lebih efisien untuk mengambil data yang sama.
Aturan ini menganalisis jenis koleksi yang mengimplementasikan IReadOnlyList<T> tetapi tidak IList<T>.
Aturan ini menandai panggilan ke metode berikut pada jenis koleksi ini:
- System.Linq.Enumerable.Count
- System.Linq.Enumerable.First
- System.Linq.Enumerable.FirstOrDefault
- System.Linq.Enumerable.Last
- System.Linq.Enumerable.LastOrDefault
Jenis dan metode koleksi yang dianalisis dapat diperluas di masa mendatang untuk mencakup lebih banyak kasus.
Cara memperbaiki pelanggaran
Untuk memperbaiki pelanggaran, ganti Enumerable panggilan metode dengan akses properti. Misalnya, dua cuplikan kode berikut menunjukkan pelanggaran aturan dan cara memperbaikinya:
using System;
using System.Collections.Generic;
using System.Linq;
class C
{
public void M(IReadOnlyList<string> list)
{
Console.Write(list.First());
Console.Write(list.Last());
Console.Write(list.Count());
}
}
using System;
using System.Collections.Generic;
class C
{
public void M(IReadOnlyList<string> list)
{
Console.Write(list[0]);
Console.Write(list[list.Count - 1]);
Console.Write(list.Count);
}
}
Tip
Perbaikan kode tersedia untuk aturan ini di Visual Studio. Untuk menggunakannya, posisikan kursor pada pelanggaran dan tekan Ctrl+. (titik). Pilih Gunakan pengindeks dari daftar opsi yang disajikan.
Kapan harus menekan peringatan
Aman untuk menyembunyikan pelanggaran aturan ini jika Anda tidak khawatir tentang dampak performa dari panggilan metode Enumerable tertentu.
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 CA1826
// The code that's violating the rule is on this line.
#pragma warning restore CA1826
Untuk menonaktifkan aturan untuk file, folder, atau proyek, atur tingkat keparahannya ke none
dalam file konfigurasi.
[*.{cs,vb}]
dotnet_diagnostic.CA1826.severity = none
Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.
Mengonfigurasi kode yang akan dianalisis
Gunakan opsi berikut untuk mengonfigurasi bagian mana dari codebase Anda yang akan menjalankan aturan ini.
Mengecualikan metode FirstOrDefault dan LastOrDefault
Anda dapat mengonfigurasi aturan ini untuk mengecualikan Enumerable.FirstOrDefault metode dan Enumerable.LastOrDefault dari analisis. Anda mungkin mempertimbangkan untuk mengecualikan metode ini jika keterbacaan menjadi perhatian, karena kode yang akan Anda tulis untuk menggantinya tidak mudah dibaca. Untuk mengecualikan metode ini, tambahkan pasangan kunci-nilai berikut ke file .editorconfig di proyek Anda:
dotnet_code_quality.CA1826.exclude_ordefault_methods = true
Aturan terkait
- CA1827: Jangan gunakan Count/LongCount jika Any dapat digunakan
- CA1828: Jangan gunakan CountAsync/LongCountAsync saat AnyAsync dapat digunakan
- CA1829: Gunakan properti Length/Count alih-alih metode Enumerable.Count