Wie kann verhindert werden, dass ein Methodenaufrufer eine zurückgegebene Sammlung ändert?

Question

Ich habe Methoden, die private Auflistungen an den Aufrufer zurückgeben, und ich möchte verhindern, dass der Aufrufer die zurückgegebenen Auflistungen ändert.

private readonly Foo[] foos; 

public IEnumerable<Foo> GetFoos() 
{ 
    return this.foos; 
} 

Im Moment ist die Privatsammlung ist eine feste Anordnung, aber in der Zukunft die Sammlung könnte eine Liste werden, wenn die Notwendigkeit für das Hinzufügen neue Elemente zur Laufzeit entsteht.

Es gibt mehrere Lösungen, die verhindern, dass der Aufrufer die Sammlung ändert. Die Rückkehr IEnumerable<T> ist die einfachste Lösung, aber der Aufrufer kann immer noch den Rückgabewert auf IList<T> herauf-Cast und die Auflistung ändern.

((IList<Foo>)GetFoos())[0] = otherFoo; 

die Sammlungen Klonen hat den offensichtlichen Nachteil, dass es zwei Sammlungen, die unabhängig voneinander entwickeln können. Bisher habe ich die folgenden Optionen in Betracht gezogen.

1. Verpackung der Sammlung in ReadOnlyCollection<T>.
2. Zurückgeben eines der von der Klasse Enumerable definierten LINQ-Iteratoren durch Ausführen einer Dummy-Projektion wie list.Select(item => item). Eigentlich denke ich über Where(item => true), weil der zurückgegebene Iterator leichter scheint.
3. Schreiben eines benutzerdefinierten Wrappers.

Was Ich mag nicht über ReadOnlyCollection<T> ist, dass es implementiert IList<T> und ruft Add() oder den Zugriff auf die Indexer Ausnahmen verursachen. Während dies in der Theorie absolut korrekt ist, prüft fast kein echter Code IList<T>.IsReadOnly oder IList<T>.IsFixedSize.

Verwendung der LINQ-Iteratoren - Ich habe den Code in eine Erweiterungsmethode MakeReadOnly() eingewickelt - verhindert dieses Szenario, aber es hat den Geschmack eines Hacks.

Schreiben eines benutzerdefinierten Wrappers? Das Rad neu erfinden?

Irgendwelche Gedanken, Überlegungen oder andere Lösungen?

---

Während diese Frage Tagging, entdeckte ich this Stack Overflow question ich vor nicht bemerkt. Jon Skeet schlägt vor, den "LINQ-Hack" auch zu verwenden, aber noch effizienter unter Verwendung von Skip(0).

Answer 1

Leider gibt es keine Möglichkeit genau zu erreichen, was Sie in der aktuellen Version des Frameworks suchen. Es hat einfach kein Konzept einer indexierbaren unveränderlichen/schreibgeschützten Sammlung sowohl für den konkreten Typ als auch für den Schnittstellenstil.

Wie Sie hingewiesen haben, funktioniert ReadOnlyCollection<T> OK auf der Betontyp Seite. Es gibt jedoch keine entsprechende Schnittstelle, die auch statisch nur lesbar ist.

Du bist nur eine echte Wahl ist ...

• Ihre eigene Sammlung Klasse definieren
• Entweder nur IEnumerable<T> implementieren oder eine Notwendigkeit schreibgeschützte Schnittstelle, die Ihre Sammlung Geräte definieren.

Answer 2

Wie wäre es mit einer tiefen Kopie des zurückgegebenen Objekts? [So wird es keine Auswirkungen auf die ursprüngliche Sammlung sein, auch wenn der Anrufer Änderungen an der Kopie zu machen entscheidet zurückgegeben]

Answer 3

Liste und Array haben eine AsReadOnly Methode:

public IEnumerable<Foo> GetFoos() 
{ 
    return Array.AsReadOnly(this.foos); 
    // or if it is a List<T> 
    // return this.foos.AsReadOnly(); 
} 

Answer 4

In solchen Fällen i ein Verfahren erstellen Die Klasse kann auf einzelne Elemente der privaten Sammlung zugreifen. Sie können auch Indexer (http://msdn.microsoft.com/en-us/library/6x16t2tx.aspx) für die Klasse, die private Sammlung enthält, realisieren.