Bagikan melalui

CA2227: Properti kumpulan harus berupa baca saja

  • Artikel
Properti Nilai
ID Aturan CA2227
Judul Properti koleksi harus dalam format baca saja
Golongan Penggunaan
Perbaikan bersifat disruptif atau non-disruptif Merusak
Diaktifkan secara default di .NET 8 Tidak

Penyebab

Properti bisa-tulis yang terlihat secara eksternal adalah jenis yang mengimplementasikan System.Collections.ICollection. Aturan ini mengabaikan array, pengindeks (properti dengan nama 'Item'), koleksi yang tidak dapat diubah, koleksi baca-saja, dan kumpulan izin.

Deskripsi aturan

Properti koleksi bisa-tulis memungkinkan pengguna mengganti koleksi dengan koleksi yang sepenuhnya berbeda. Properti baca-saja atau khusus-init menghentikan koleksi agar tidak diganti, tetapi masih memungkinkan masing-masing anggota diatur. Jika mengganti koleksi adalah tujuan, pola desain yang disukai adalah menyertakan metode untuk menghapus semua elemen dari koleksi, dan metode untuk mengisi ulang koleksi. Lihat metode Clear dan AddRange kelas System.Collections.ArrayList untuk mengetahui contoh pola ini.

Serialisasi biner dan XML mendukung properti baca-saja yang merupakan koleksi. Kelas System.Xml.Serialization.XmlSerializer ini memiliki persyaratan khusus untuk jenis yang mengimplementasikan ICollection dan System.Collections.IEnumerable agar dapat diserialisasikan.

Cara memperbaiki pelanggaran

Untuk memperbaiki aturan ini, jadikan properti baca-saja atau init-saja. Jika desain memerlukannya, tambahkan metode untuk menghapus dan mengisi ulang koleksi.

Kapan harus menekan peringatan

Anda dapat menyembunyikan peringatan jika properti adalah bagian dari kelas Objek Transfer Data (DTO).

Jika tidak, jangan menyembunyikan peringatan dari aturan ini.

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

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

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Contoh

Contoh berikut menunjukkan jenis dengan properti koleksi bisa-tulis dan menunjukkan bagaimana koleksi dapat diganti secara langsung. Selain itu, contoh ini menunjukkan cara yang diutamakan untuk mengganti properti koleksi baca-saja menggunakan metode Clear dan AddRange.

public class WritableCollection
{
    public ArrayList SomeStrings
    {
        get;

        // This set accessor violates rule CA2227.
        // To fix the code, remove this set accessor or change it to init.
        set;
    }

    public WritableCollection()
    {
        SomeStrings = new ArrayList(new string[] { "one", "two", "three" });
    }
}

class ReplaceWritableCollection
{
    static void Main2227()
    {
        ArrayList newCollection = new ArrayList(new string[] { "a", "new", "collection" });

        WritableCollection collection = new WritableCollection();

        // This line of code demonstrates how the entire collection
        // can be replaced by a property that's not read only.
        collection.SomeStrings = newCollection;

        // If the intent is to replace an entire collection,
        // implement and/or use the Clear() and AddRange() methods instead.
        collection.SomeStrings.Clear();
        collection.SomeStrings.AddRange(newCollection);
    }
}

Public Class WritableCollection

    ' This property violates rule CA2227.
    ' To fix the code, add the ReadOnly modifier to the property:
    ' ReadOnly Property SomeStrings As ArrayList
    Property SomeStrings As ArrayList

    Sub New()
        SomeStrings = New ArrayList(New String() {"one", "two", "three"})
    End Sub

End Class

Class ViolatingVersusPreferred

    Shared Sub Main2227()
        Dim newCollection As New ArrayList(New String() {"a", "new", "collection"})

        Dim collection As New WritableCollection()

        ' This line of code demonstrates how the entire collection
        ' can be replaced by a property that's not read only.
        collection.SomeStrings = newCollection

        ' If the intent is to replace an entire collection,
        ' implement and/or use the Clear() and AddRange() methods instead.
        collection.SomeStrings.Clear()
        collection.SomeStrings.AddRange(newCollection)
    End Sub

End Class

Baca juga