Devolver 'IList' vs 'ICollection' vs 'Collection'

Estoy confundido acerca de qué tipo de colección debería devolver de mis métodos y propiedades de API públicas.

Las colecciones que tengo en mente son IList, ICollectiony Collection.

¿Devolver uno de estos tipos siempre se prefiere sobre los demás, o depende de la situación específica?

Generalmente, debe devolver un tipo que sea lo más general posible, es decir, uno que conozca lo suficiente de los datos devueltos que el consumidor necesita usar. De esa forma tienes mayor libertad para cambiar la implementación de la API, sin romper el código que la está usando.

Considere también la IEnumerable<T>interfaz como tipo de retorno. Si el resultado solo se va a iterar, el consumidor no necesita más que eso.

ICollection<T>es una interfaz que expone la semántica de recogida, tales como Add(), Remove(), y Count.

Collection<T>es una implementación concreta de la ICollection<T>interfaz.

IList<T>es esencialmente un ICollection<T>acceso basado en orden aleatorio.

En este caso, debe decidir si sus resultados requieren o no semántica de lista, como indexación basada en orden (luego usar IList<T>) o si solo necesita devolver una "bolsa" desordenada de resultados (luego usar ICollection<T>).

La principal diferencia entre IList<T>y ICollection<T>es que le IList<T>permite acceder a elementos a través de un índice. IList<T>describe tipos similares a matrices. ICollection<T>Solo se puede acceder a los elementos de una enumeración. Ambos permiten la inserción y eliminación de elementos.

Si solo necesita enumerar una colección, entonces IEnumerable<T>es preferible. Tiene dos ventajas sobre las demás:

1. No permite cambios en la colección (pero no en los elementos, si son del tipo de referencia).

2. Permite la mayor variedad posible de fuentes, incluidas las enumeraciones que se generan algorítmicamente y no son colecciones en absoluto.

Collection<T>es una clase base que es principalmente útil para implementadores de colecciones. Si lo expone en interfaces (API), se excluirán muchas colecciones útiles que no se deriven de él.

Una desventaja de IList<T>es que los arreglos lo implementan pero no le permiten agregar o quitar elementos (es decir, no puede cambiar la longitud del arreglo). Se lanzará una excepción si llama IList<T>.Add(item)a una matriz. La situación está algo desactivada, ya que IList<T>tiene una propiedad booleana IsReadOnlyque puede verificar antes de intentar hacerlo. Pero en mi opinión, esto sigue siendo un defecto de diseño en la biblioteca . Por lo tanto, lo uso List<T>directamente, cuando se requiere la posibilidad de agregar o quitar elementos.

IList<T>es la interfaz base para todas las listas genéricas. Dado que es una colección ordenada, la implementación puede decidir sobre el orden, desde el orden clasificado hasta el orden de inserción. Además, Ilisttiene la propiedad Item que permite a los métodos leer y editar entradas en la lista según su índice. Esto hace posible insertar, eliminar un valor en / de la lista en un índice de posición.

Además IList<T> : ICollection<T>, todos los métodos de ICollection<T>también están disponibles aquí para su implementación.

ICollection<T>es la interfaz base para todas las colecciones genéricas. Define tamaño, enumeradores y métodos de sincronización. Puede agregar o eliminar un elemento en una colección, pero no puede elegir en qué posición ocurre debido a la ausencia de la propiedad del índice.

Collection<T>proporciona una implementación para IList<T>, IListy IReadOnlyList<T>.

Si usa un tipo de interfaz más estrecha, como en ICollection<T>lugar de IList<T>, protege su código contra cambios importantes. Si usa un tipo de interfaz más amplio como IList<T>, corre más peligro de romper los cambios de código.

Citando de una fuente ,

ICollection, ICollection<T>: Quiere modificar la colección o le importa su tamaño. IList, IList<T>: Quiere modificar la colección y le importa el orden y / o posicionamiento de los elementos en la colección.

Devolver un tipo de interfaz es más general, por lo que (sin más información sobre su caso de uso específico) me inclinaría por eso. Si desea exponer el soporte de indexación, elija IList<T>, de lo contrario ICollection<T>será suficiente. Por último, si desea indicar que los tipos devueltos son de solo lectura, elija IEnumerable<T>.

Y, en caso de que no lo haya leído antes, Brad Abrams y Krzysztof Cwalina escribieron un gran libro titulado "Pautas de diseño de marcos: convenciones, modismos y patrones para bibliotecas .NET reutilizables" (puede descargar un resumen desde aquí ).

Hay algunos temas que surgen de esta pregunta:

• interfaces versus clases
• ¿Qué clase específica, de varias clases similares, colección, lista, matriz?
• Clases comunes frente a colecciones de subelementos ("genéricos")

Es posible que desee resaltar que es una API orientada a objetos

interfaces versus clases

Si no tienes mucha experiencia con las interfaces, te recomiendo que sigas las clases. Veo muchas veces a los desarrolladores saltar a las interfaces, incluso si no es necesario.

Y, terminar haciendo un diseño de interfaz deficiente, en lugar de un buen diseño de clase, que, por cierto, eventualmente se puede migrar a un buen diseño de interfaz ...

Verá muchas interfaces en la API, pero no se apresure a buscarlas si no las necesita.

Eventualmente aprenderá a aplicar interfaces a su código.

¿Qué clase específica, de varias clases similares, colección, lista, matriz?

Hay varias clases en c # (dotnet) que se pueden intercambiar. Como ya se mencionó, si necesita algo de una clase más específica, como "CanBeSortedClass", hágalo explícito en su API.

¿Su usuario de API realmente necesita saber que su clase se puede ordenar o aplicar algún formato a los elementos? Luego use "CanBeSortedClass" o "ElementsCanBePaintedClass", de lo contrario use "GenericBrandClass".

De lo contrario, use una clase más general.

Clases de colección comunes versus colecciones de subelementos ("genéricos")

Verá que hay clases que contienen otros elementos y puede especificar que todos los elementos deben ser de un tipo específico.

Las colecciones genéricas son aquellas clases que puede usar la misma colección, para varias aplicaciones de código, sin tener que crear una nueva colección, para cada nuevo tipo de subelemento, como este: Colección .

¿Su usuario de API va a necesitar un tipo muy específico, igual para todos los elementos?

Usa algo como List<WashingtonApple>.

¿Su usuario de API necesitará varios tipos relacionados?

Exponer List<Fruit>para su API, y utilizar List<Orange> List<Banana>, List<Strawberry>internamente, en donde Orange, Bananay Strawberryson descendientes de Fruit.

¿Su usuario de API necesitará una colección de tipos genéricos?

Use List, donde están todos los artículos object.

Salud.