Retornando 'IList' vs 'ICollection' vs 'Collection'

Estou confuso sobre qual tipo de coleção devo retornar dos meus métodos e propriedades da API pública.

As coleções que eu tenho em mente são IList, ICollectione Collection.

O retorno de um desses tipos sempre é preferido em relação aos outros, ou depende da situação específica?

Geralmente, você deve retornar um tipo o mais geral possível, ou seja, aquele que conheça apenas os dados retornados que o consumidor precisa usar. Dessa forma, você tem maior liberdade para alterar a implementação da API, sem quebrar o código que a está usando.

Considere também a IEnumerable<T>interface como tipo de retorno. Se o resultado for apenas iterado, o consumidor não precisará mais do que isso.

ICollection<T>é uma interface que expõe semântica de recolha, tais como Add(), Remove()e Count.

Collection<T>é uma implementação concreta da ICollection<T>interface.

IList<T>é essencialmente um ICollection<T>com acesso baseado em ordem aleatória.

Nesse caso, você deve decidir se seus resultados requerem ou não semânticas de lista, como indexação baseada em pedidos (depois use IList<T>) ou se você só precisa retornar uma "bolsa" não ordenada de resultados (então use ICollection<T>).

A principal diferença entre IList<T>e ICollection<T>é que IList<T>permite acessar elementos por meio de um índice. IList<T>descreve tipos do tipo matriz. Os elementos em um ICollection<T>só podem ser acessados ​​por enumeração. Ambos permitem a inserção e exclusão de elementos.

Se você precisar enumerar apenas uma coleção, IEnumerable<T>é preferível. Tem duas vantagens sobre as outras:

1. Ele não permite alterações na coleção (mas não nos elementos, se eles são do tipo de referência).

2. Ele permite a maior variedade possível de fontes, incluindo enumerações que são geradas algoritmicamente e não são coleções.

Collection<T>é uma classe base que é útil principalmente para implementadores de coleções. Se você expô-lo em interfaces (APIs), muitas coleções úteis não derivadas serão excluídas.

Uma desvantagem IList<T>é que as matrizes a implementam, mas não permitem adicionar ou remover itens (ou seja, você não pode alterar o comprimento da matriz). Uma exceção será lançada se você chamar IList<T>.Add(item)uma matriz. A situação é um pouco neutralizada, pois IList<T>possui uma propriedade booleana IsReadOnlyque você pode verificar antes de tentar fazer isso. Mas, aos meus olhos, isso ainda é uma falha de design na biblioteca . Portanto, eu uso List<T>diretamente, quando a possibilidade de adicionar ou remover itens é necessária.

IList<T>é a interface base para todas as listas genéricas. Por ser uma coleção ordenada, a implementação pode decidir sobre a ordem, variando de ordem classificada a ordem de inserção. Além disso, Ilistpossui a propriedade Item que permite que os métodos leiam e editem entradas na lista com base em seu índice. Isso possibilita inserir, remover um valor na / da lista em um índice de posição.

Além disso IList<T> : ICollection<T>, todos os métodos de ICollection<T>também estão disponíveis aqui para implementação.

ICollection<T>é a interface base para todas as coleções genéricas. Ele define tamanho, enumeradores e métodos de sincronização. Você pode adicionar ou remover um item em uma coleção, mas não pode escolher em qual posição ele ocorre devido à ausência da propriedade de índice.

Collection<T>fornece uma implementação para IList<T>, IListe IReadOnlyList<T>.

Se você usar um tipo de interface mais restrito, como em ICollection<T>vez de IList<T>, protege seu código contra as alterações. Se você usar um tipo de interface mais amplo, como IList<T>, você corre o risco de quebrar as alterações de código.

Citando de uma fonte ,

ICollection, ICollection<T>: Você deseja modificar a coleção ou se importa com seu tamanho. IList, IList<T>: Você quer modificar a coleção e você se preocupa com a ordenação e / ou posicionamento dos elementos na coleção.

O retorno de um tipo de interface é mais geral, portanto (sem informações adicionais sobre seu caso de uso específico), eu me inclinaria para isso. Se você deseja expor o suporte à indexação, escolha IList<T>, caso contrário, ICollection<T>será suficiente. Por fim, se você deseja indicar que os tipos retornados são somente leitura, escolha IEnumerable<T>.

E, caso você não tenha lido antes, Brad Abrams e Krzysztof Cwalina escreveram um ótimo livro intitulado "Diretrizes de design de estrutura: convenções, expressões idiomáticas e padrões para bibliotecas .NET reutilizáveis" (você pode baixar um resumo aqui ).

Existem alguns assuntos que vêm dessa pergunta:

• interfaces versus classes
• qual classe específica, de várias classes iguais, coleção, lista, matriz?
• Classes comuns versus coleções de subitens ("genéricos")

Convém destacar que é uma API orientada a objetos

interfaces versus classes

Se você não tem muita experiência com interfaces, recomendo manter as aulas. Eu vejo muitas vezes os desenvolvedores pulando para interfaces, mesmo que não seja necessário.

E, finalize com um design de interface ruim, em vez de um bom design de classe, que, a propósito, pode eventualmente ser migrado para um bom design de interface ...

Você verá muitas interfaces na API, mas não se apresse, se não precisar.

Você acabará aprendendo como aplicar interfaces ao seu código.

qual classe específica, de várias classes iguais, coleção, lista, matriz?

Existem várias classes em c # (dotnet) que podem ser trocadas. Como já mencionado, se você precisar de algo de uma classe mais específica, como "CanBeSortedClass", torne explícito na sua API.

O usuário da API realmente precisa saber que sua classe pode ser classificada ou aplicar algum formato aos elementos? Em seguida, use "CanBeSortedClass" ou "ElementsCanBePaintedClass", caso contrário, use "GenericBrandClass".

Caso contrário, use uma classe mais geral.

Classes de coleção comuns versus coleções de subitens ("genéricos")

Você verá que existem classes que contêm outros elementos e pode especificar que todos os elementos devem ser de um tipo específico.

Coleções genéricas são aquelas classes que você pode usar a mesma coleção, para vários aplicativos de código, sem precisar criar uma nova coleção, para cada novo tipo de subitem, como este: Coleção .

Seu usuário da API precisará de um tipo muito específico, o mesmo para todos os elementos?

Use algo parecido List<WashingtonApple>.

Seu usuário da API precisará de vários tipos relacionados?

Expor List<Fruit>para o seu API, e usar List<Orange> List<Banana>, List<Strawberry>internamente, onde Orange, Bananae Strawberrysão descendentes de Fruit.

Seu usuário da API precisará de uma coleção de tipos genéricos?

Use List, onde todos os itens são object.

Felicidades.