CA2227: Properti kumpulan harus berupa baca saja

Properti Nilai
ID Aturan CA2227
Judul Properti koleksi harus dalam format baca saja
Kategori Penggunaan
Perbaikan bersifat merusak atau tidak merusak Merusak
Diaktifkan secara default di .NET 10 Tidak
Bahasa yang berlaku C# dan Visual Basic

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 yang dapat ditulis memungkinkan pengguna mengganti koleksi dengan koleksi yang sama sekali berbeda. Properti baca-saja atau init-only mencegah koleksi diganti, tetapi masih memungkinkan anggota individu untuk dikonfigurasi. 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 dapat diserialisasikan.

Cara memperbaiki pelanggaran

Gunakan salah satu pendekatan berikut untuk memperbaiki pelanggaran aturan ini:

  • Setel properti menjadi hanya-baca atau hanya-init. Properti baca-saja atau init-saja mencegah kumpulan diganti sambil tetap memungkinkan pengaturan anggota secara individual. Jika desain memerlukan penggantian konten koleksi, tambahkan metode untuk menghapus dan mengisi ulang koleksi. Untuk contoh pola ini, lihat metode ArrayList.Clear dan ArrayList.AddRange.

  • Ubah tipe properti menjadi tipe koleksi bersifat baca-saja. Jika penelepon tidak perlu mengubah koleksi, ubah jenis properti menjadi koleksi hanya-baca, seperti ReadOnlyCollection<T>. Pendekatan ini membuat intensi baca-saja eksplisit dalam penandatanganan tipe.

  • Ubah jenis properti menjadi jenis koleksi serentak yang aman-thread, sambil menjaga properti tetap bersifat baca-saja. Jika desain memerlukan beberapa utas untuk memodifikasi koleksi secara bersamaan, ekspos properti baca-saja (tanpa setter) yang jenisnya adalah koleksi bersamaan, seperti ConcurrentBag<T>. CA2227 dipicu oleh sifat koleksi yang dapat ditulis, bukan oleh tipe koleksi, sehingga properti tersebut harus tetap bersifat hanya-baca. Pilihan koleksi bersamaan hanya membahas mutasi aman utas dari instans koleksi yang dikembalikan.

Kapan harus menekan peringatan

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

Jika tidak, jangan mengabaikan 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 tipe dengan properti koleksi yang dapat ditulis serta cara langsung mengganti koleksinya. Ini juga menunjukkan cara yang disukai untuk mengganti properti koleksi hanya-baca dengan 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 = ["a", "new", "collection"];

        WritableCollection collection = new()
        {
            // This line of code demonstrates how the entire collection
            // can be replaced by a property that's not read only.
            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

Lihat juga

  • Last updated on