Megosztás a következőn keresztül:

CA2227: A gyűjtemény tulajdonságainak csak olvashatónak kell lenniük

  • Cikk
Tulajdonság Érték
Szabályazonosító CA2227
Cím A gyűjtemény tulajdonságainak csak olvashatónak kell lenniük
Kategória Használat
A javítás kompatibilitástörő vagy nem törik Törés
Alapértelmezés szerint engedélyezve a .NET 8-ban Nem

Ok

A külsőleg látható írható tulajdonság olyan típusú, amely implementálható System.Collections.ICollection. Ez a szabály figyelmen kívül hagyja a tömböket, az indexelőket (az "Elem" nevű tulajdonságokat), a nem módosítható gyűjteményeket, az olvasható gyűjteményeket és az engedélykészleteket.

Szabály leírása

A írható gyűjteménytulajdonságok lehetővé teszik a felhasználó számára, hogy a gyűjteményt teljesen más gyűjteményre cserélje. Egy írásvédett vagy init-only tulajdonság megakadályozza a gyűjtemény cseréjét, de továbbra is lehetővé teszi az egyes tagok beállítását. Ha a gyűjtemény cseréje egy cél, akkor az előnyben részesített tervezési minta egy olyan metódust tartalmaz, amely eltávolítja az összes elemet a gyűjteményből, és egy metódust a gyűjtemény újratöltésére. Ennek a Clear mintának egy példáját az osztály és AddRange a System.Collections.ArrayList metódusok szemléltetik.

A bináris és az XML-szerializálás egyaránt támogatja a gyűjtemények írásvédett tulajdonságait. Az System.Xml.Serialization.XmlSerializer osztály speciális követelményekkel rendelkezik a implementálandó ICollection és System.Collections.IEnumerable szerializálható típusokkal kapcsolatban.

Szabálysértések kijavítása

A szabály megsértésének kijavításához tegye a tulajdonságot írásvédetté vagy init-onlyvá. Ha a terv megköveteli, adjon hozzá metódusokat a gyűjtemény törléséhez és újratöltéséhez.

Mikor kell letiltani a figyelmeztetéseket?

Letilthatja a figyelmeztetést, ha a tulajdonság egy adatátviteli objektum (DTO) osztály része.

Ellenkező esetben ne tiltsa le a szabály figyelmeztetéseit.

Figyelmeztetés mellőzése

Ha csak egyetlen szabálysértést szeretne letiltani, adjon hozzá előfeldolgozási irányelveket a forrásfájlhoz a szabály letiltásához és újbóli engedélyezéséhez.

#pragma warning disable CA2227
// The code that's violating the rule is on this line.
#pragma warning restore CA2227

Ha le szeretné tiltani egy fájl, mappa vagy projekt szabályát, állítsa annak súlyosságát none a konfigurációs fájlban.

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

További információ: Kódelemzési figyelmeztetések letiltása.

Példa

Az alábbi példa egy írható gyűjteménytulajdonságú típust mutat be, és bemutatja, hogyan lehet közvetlenül lecserélni a gyűjteményt. Emellett az írásvédett gyűjteménytulajdonságok ClearAddRange és metódusok helyettesítésének előnyben részesített módját is megjeleníti.

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

Kapcsolódó információk