Bagikan melalui

CA1002: Jangan mengekspos daftar generik

Properti Nilai
ID Aturan CA1002
Judul Jangan mengekspos daftar generik
Golongan Desain
Perbaikan bersifat disruptif atau non-disruptif Merusak
Diaktifkan secara default di .NET 10 No

Penyebab

Jenis berisi anggota yang terlihat secara eksternal yang merupakan System.Collections.Generic.List<T> jenis, mengembalikan List<T> jenis, atau yang tanda tangannya menyertakan List<T> parameter.

Secara default, aturan ini hanya melihat jenis yang terlihat secara eksternal, tetapi ini dapat dikonfigurasi.

Deskripsi aturan

System.Collections.Generic.List<T> adalah koleksi generik yang dirancang untuk performa dan bukan warisan. List<T> tidak berisi anggota virtual yang memudahkan untuk mengubah perilaku kelas yang diwariskan. Koleksi generik berikut dirancang untuk warisan dan harus diekspos alih-alih List<T>.

Cara memperbaiki pelanggaran

Untuk memperbaiki pelanggaran aturan ini, ubah jenis menjadi System.Collections.Generic.List<T> salah satu koleksi generik yang dirancang untuk pewarisan.

Example

// This class violates the rule.
public class MutableItems
{
    // CA1002: Change 'List<string>' in 'MutableItems.Items' to
    // use 'Collection<T>', 'ReadOnlyCollection<T>' or 'KeyedCollection<K,V>'.
    public List<string> Items { get; } = [];

    public void Add(string item)
    {
        Items.Add(item);
    }
}

// This class satisfies the rule.
public class ReadOnlyItems
{
    private readonly List<string> _items = [];

    public IReadOnlyCollection<string> Items => _items.AsReadOnly();

    public void Add(string item)
    {
        _items.Add(item);
    }
}

Kapan harus menekan peringatan

Jangan menekan peringatan dari aturan ini kecuali rakitan yang memunculkan peringatan ini tidak dimaksudkan untuk menjadi pustaka yang dapat digunakan kembali. Misalnya, akan aman untuk menekan peringatan ini dalam aplikasi yang disetel performa di mana manfaat performa diperoleh dari penggunaan daftar generik.

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

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

[*.{cs,vb}]
dotnet_diagnostic.CA1002.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.

Anda dapat mengonfigurasi opsi ini hanya untuk aturan ini, untuk semua aturan yang berlaku untuknya, atau untuk semua aturan dalam kategori ini (Desain) yang berlaku untuk aturan ini. Untuk informasi selengkapnya, lihat Opsi konfigurasi aturan kualitas kode.

Menyertakan permukaan API tertentu

Anda dapat mengonfigurasi bagian basis kode mana yang akan dijalankan aturan ini, berdasarkan aksesibilitasnya, dengan mengatur opsi api_surface. Misalnya, untuk menentukan bahwa aturan hanya boleh dijalankan pada permukaan API non-publik, tambahkan pasangan kunci-nilai berikut ke file .editorconfig di proyek Anda:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Nota

Ganti bagian XXXXCAXXXX dengan ID aturan yang berlaku.

CA1005: Menghindari parameter yang berlebihan pada jenis generik

CA1010: Pengumpulan harus menerapkan antarmuka generik

CA1000: Jangan deklarasikan anggota statis pada jenis generik

CA1003: Menggunakan instans penanganan aktivitas generik

Lihat juga

Generik

  • Last updated on