¿Son posibles matrices inmutables en .NET?

Question

¿Es posible de alguna manera marcar un System.Array como inmutable. Cuando se ponen detrás de un público-get/set-privada que no se pueden añadir a, ya que requiere la re-asignación y reasignación, pero un consumidor aún puede establecer cualquier subíndice que desean:

public class Immy 
{ 
    public string[] { get; private set; } 
} 

pensé la palabra clave readonly podría hacer el truco, pero no tuvo tanta suerte.

Answer 1

ReadOnlyCollection<T> es probablemente lo que está buscando. No tiene un método Add().

Answer 2

Creo que la mejor práctica es usar IList <T> en lugar de matrices en API públicas por este motivo. readonly evitará que una variable miembro se establezca fuera del constructor, pero como descubrió, no impedirá que las personas asignen elementos en la matriz.

Consulte Arrays Considered Somewhat Harmful para obtener más información.

Editar: Arrays no pueden ser leídos solamente, pero pueden ser convertidos a implementaciones IList vía Array.AsReadOnly de sólo lectura() como @shahkalpesh señala.

Answer 3

Puede usar el método Array.AsReadOnly para devolver.

Answer 4

El Framework Design Guidelines sugiere devolver una copia de la matriz. De esta forma, los consumidores no pueden cambiar los elementos de la matriz.

// bad code 
// could still do Path.InvalidPathChars[0] = 'A'; 
public sealed class Path { 
    public static readonly char[] InvalidPathChars = 
     { '\"', '<', '>', '|' }; 
} 

éstos son mejores:

public static ReadOnlyCollection<char> GetInvalidPathChars(){ 
    return Array.AsReadOnly(InvalidPathChars); 
} 

public static char[] GetInvalidPathChars(){ 
    return (char[])InvalidPathChars.Clone(); 
} 

Los ejemplos son directamente desde el libro.

Answer 5

Lo único que se debe agregar es que las matrices implican mutabilidad. Cuando devuelve un Array desde una función, está sugiriendo al programador cliente que pueden/deberían cambiar las cosas.

Answer 6

Además de la respuesta de Matt, IList es una interfaz abstracta completa para una matriz, por lo que permite agregar, eliminar, etc. No estoy seguro de por qué Lippert parece sugerirlo como una alternativa a IEnumerable donde se necesita inmutabilidad. (Edit: porque la implementación IList puede arrojar excepciones para esos métodos de mutación, si te gusta ese tipo de cosas).

Quizás otra cosa a tener en cuenta es que los elementos en la lista también pueden tener estado mutable. Si realmente no desea que la persona que llama modifique dicho estado, tiene algunas opciones:

Asegúrese de que los elementos de la lista sean inmutables (como en el ejemplo: la cadena es inmutable).

Devuelve un clon profundo de todo, por lo que en ese caso podrías usar una matriz de todos modos.

Volver una interfaz que permite el acceso de sólo lectura a un artículo:

interface IImmutable 
{ 
    public string ValuableCustomerData { get; } 
} 

class Mutable, IImmutable 
{ 
    public string ValuableCustomerData { get; set; } 
} 

public class Immy 
{ 
    private List<Mutable> _mutableList = new List<Mutable>(); 

    public IEnumerable<IImmutable> ImmutableItems 
    { 
     get { return _mutableList.Cast<IMutable>(); } 
    } 
} 

Tenga en cuenta que todos los valores accesibles desde la interfaz IImmutable mismo debe ser inmutable (por ejemplo, cadena), o bien sea una copia que haga situ la mosca.

Answer 7

Lo mejor que puede hacer es extender una colección existente para crear la suya propia. El gran problema es que debería funcionar de manera diferente a cada tipo de colección existente porque cada llamada tendría que devolver una nueva colección.

Answer 8

Es posible que desee consultar my answer a una pregunta similar para obtener más ideas sobre la exposición de colecciones en un objeto.

Answer 9

Consulte Immutable Collections Now Available en la biblioteca de la clase base (actualmente en la vista previa).

Answer 10

.NET tiende a alejarse de las matrices para todos los casos menos el más simple y tradicional. Para todo lo demás, hay varias implementaciones enumerables/de colección.

Cuando desea marcar un conjunto de datos como inmutables, está yendo más allá de la capacidad proporcionada por una matriz tradicional. .NET proporciona una capacidad equivalente, pero no técnicamente en forma de matriz. Para tener una colección inmutable de una matriz, utilice Array.AsReadOnly<T>:

var mutable = new[] 
{ 
    'a', 'A', 
    'b', 'B', 
    'c', 'C', 
}; 

var immutable = Array.AsReadOnly(mutable); 

immutable habrá una instancia ReadOnlyCollection<char>. Como un caso de uso más general, puede crear un ReadOnlyCollection<T> desde cualquier implementación genérica de IList<T>.

var immutable = new ReadOnlyCollection<char>(new List<char>(mutable)); 

Tenga en cuenta que tiene que ser una implementación genérica; plain old IList no funcionará, lo que significa que no puede usar este método en una matriz tradicional, que solo implementa IList. Esto saca a la luz la posibilidad de usar Array.AsReadOnly<T> como un medio rápido para obtener acceso a implementaciones genéricas que normalmente son inaccesibles a través de una matriz tradicional.

ReadOnlyCollection<T> le dará acceso a todas las características que se esperan de una matriz inmutable:

// Note that .NET favors Count over Length; all but traditional arrays use Count: 
for (var i = 0; i < immutable.Count; i++) 
{ 
    // this[] { get } is present, as ReadOnlyCollection<T> implements IList<T>: 
    var element = immutable[i]; // Works 

    // this[] { set } has to be present, as it is required by IList<T>, but it 
    // will throw a NotSupportedException: 
    immutable[i] = element; // Exception! 
} 

// ReadOnlyCollection<T> implements IEnumerable<T>, of course: 
foreach (var character in immutable) 
{ 
} 

// LINQ works fine; idem 
var lowercase = 
    from c in immutable 
    where c >= 'a' && c <= 'z' 
    select c; 

// You can always evaluate IEnumerable<T> implementations to arrays with LINQ: 
var mutableCopy = immutable.ToArray(); 
// mutableCopy is: new[] { 'a', 'A', 'b', 'B', 'c', 'C' } 
var lowercaseArray = lowercase.ToArray(); 
// lowercaseArray is: new[] { 'a', 'b', 'c' }