Comment empêcher un appelant de méthode de modifier une collection retournée?

Question

J'ai des méthodes qui retournent des collections privées à l'appelant et je veux empêcher l'appelant de modifier les collections retournées.

private readonly Foo[] foos; 

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

Au moment de la collection privée est un réseau fixe, mais à l'avenir la collection pourrait devenir une liste si la nécessité d'ajouter de nouveaux éléments au moment de l'exécution se fait sentir.

Il existe plusieurs solutions pour empêcher l'appelant de modifier la collection. Renvoyer IEnumerable<T> est la solution la plus simple, mais l'appelant peut toujours convertir la valeur renvoyée en IList<T> et modifier la collection. Le clonage des collections présente l'inconvénient évident qu'il existe deux collections qui peuvent évoluer indépendamment. Jusqu'à présent, j'ai considéré les options suivantes.

1. Enveloppant la collection dans ReadOnlyCollection<T>.
2. Renvoyer l'un des itérateurs LINQ définis par la classe Enumerable en effectuant une projection fictive comme list.Select(item => item). En fait je considère utiliser Where(item => true) parce que l'itérateur retourné semble plus léger.
3. Ecriture d'un wrapper personnalisé.

Ce que je n'aime pas sur l'utilisation ReadOnlyCollection<T> est qu'il met en œuvre IList<T> et appelant Add() ou l'accès à l'indexeur entraînera des exceptions. Bien que cela soit absolument correct en théorie, presque aucun vrai code ne vérifie IList<T>.IsReadOnly ou IList<T>.IsFixedSize. L'utilisation des itérateurs LINQ - J'ai enveloppé le code dans une méthode d'extension MakeReadOnly() - empêche ce scénario, mais il a le goût d'un hack.

Écrire un emballage personnalisé? Réinventer la roue?

Des idées, des considérations ou d'autres solutions?

---

Bien que le marquage à cette question, j'ai découvert this Stack Overflow question je n'ai pas remarqué avant. Jon Skeet suggère d'utiliser le "LINQ hack", mais encore plus efficace en utilisant Skip(0).

Answer 1

Malheureusement, il n'y a aucun moyen d'atteindre exactement ce que vous cherchez dans la version actuelle de la structure. Il n'a tout simplement pas de concept d'une collection indexable immutable/en lecture seule sur le type concret et le style d'interface.

Comme vous l'avez souligné, ReadOnlyCollection<T> fonctionne bien sur le côté de béton. Mais il n'y a pas d'interface correspondante à mettre en œuvre qui soit également statiquement en lecture seule.

Vous n'êtes plus seul choix est de ...

• Définir votre propre classe de collection
• Soit que la mise en œuvre IEnumerable<T> ou définir un besoin interface de lecture seule qui vos outils de collecte.Comment faire une copie profonde de l'objet renvoyé?

Answer 2

[Il n'y aura donc pas d'effet sur la collection d'origine, même si l'appelant décide de modifier la copie revins]

Answer 3

List et Array ont une méthode AsReadOnly:

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

Answer 4

Dans ce cas, créer un méthodes Insérez la classe pour accéder aux éléments individuels de la collection privée. Vous pouvez également réaliser l'indexeur (http://msdn.microsoft.com/en-us/library/6x16t2tx.aspx) sur la classe qui contient la collection privée.