Возвращение 'IList' vs 'ICollection' vs 'Collection'

Question

Я смущен о том, какой тип коллекции я должен вернуть из своих общедоступных методов и свойств API.

Коллекции, которые я имею в виду, это IList, ICollection и Collection.

Возврат одного из этих типов всегда предпочтительнее других или зависит от конкретной ситуации?

Answer 1

Как правило, вы должны вернуть тип, который является настолько общим, насколько это возможно, то есть тот, который знает только достаточное количество возвращаемых данных, которые потребитель должен использовать. Таким образом, у вас есть большая свобода изменять реализацию API, не нарушая код, который его использует.

Рассмотрите также интерфейс IEnumerable<T> как тип возврата. Если результат будет только повторен, потребитель не нуждается в большем, чем это.

Answer 2

ICollection<T> - это интерфейс, который предоставляет семантику коллекции, такую ​​как Add(), Remove() и Count.

Collection<T> - это конкретная реализация интерфейса ICollection<T>.

IList<T> по существу ICollection<T> со случайным доступом на основе заказа.

В этом случае вы должны решить, нужны ли результаты для семантики списка, например, для индексации по заказу (затем используйте IList<T>) или вам нужно просто вернуть неупорядоченный «мешок» результатов (затем используйте ICollection<T>).

Answer 3

Основное различие между IList<T> и ICollection<T> состоит в том, что IList<T> позволяет получить доступ к элементам через индекс. IList<T> описывает типы массива. Элементы в ICollection<T> могут быть доступны только через перечисление. Оба позволяют вставлять и удалять элементы.

Если вам нужно только перечислить коллекцию, то предпочтительнее IEnumerable<T>. Она имеет два преимущества по сравнению с другими:

1. Он запрещает изменения в коллекции (но не ссылаться объекты, если они ссылочного типа).

2. Он позволяет использовать самые разнообразные источники, включая перечисления, которые генерируются алгоритмически и не являются коллекциями вообще.

Collection<T> - базовый класс, который в основном полезен разработчикам коллекций. Если вы откроете его в интерфейсах (API), многие полезные коллекции, не вытекающие из него, будут исключены.

---

Одним из недостатков является то, что IList<T> массивы реализовать его, но не позволяют добавлять или удалять элементы (т.е. вы не можете изменить длину массива). Исключение будет вызываться, если вы вызовете IList<T>.Add(item) на массив. Ситуация несколько разряжена, поскольку IList<T> имеет логическое свойство IsReadOnly, которое вы можете проверить, прежде чем пытаться это сделать.Но в моих глазах это еще недостаток дизайна в библиотеке. Поэтому я непосредственно использую List<T>, когда требуется возможность добавления или удаления элементов.

Answer 4

Возвращение типа интерфейса является более общим, поэтому (не имея дополнительной информации о вашем конкретном случае использования), я бы наклонился к этому. Если вы хотите открыть поддержку индексирования, выберите IList<T>, иначе ICollection<T> будет достаточно. Наконец, если вы хотите указать, что возвращаемые типы доступны только для чтения, выберите IEnumerable<T>.

И, если вы еще не прочитали его, Брэд Абрамс и Кшиштоф Квалина написал замечательную книгу под названием «Руководства по дизайну рамок: условности, идиомы и шаблоны для многоразовых библиотек .NET» (вы можете скачать дайджест из here).

Answer 5

Есть некоторые предметы, которые приходят от этого вопроса:

• интерфейсов против классов
• какой конкретный класса, от нескольких классов, так, коллекции, списка, массива?
• Общие классы против подпункта («дженерики») коллекции

Вы можете подчеркнуть, что сво объектно-ориентированного A.P.I.

интерфейсы против классов

Если у вас нет большого опыта работы с интерфейсами, я рекомендую придерживаться классов. Я вижу много раз разработчиков, прыгающих на интерфейсы, даже если это не обязательно.

И, конец делает плохой дизайн интерфейса, а, хороший дизайн класса, который, кстати, может в конечном счете, быть перенесен на хороший дизайн интерфейса ...

Вы увидите много интерфейсов в API, но, не спешите с ним, , если вам это не нужно.

В конечном итоге вы научитесь применять интерфейсы к вашему коду.

какой конкретный класс, из нескольких классов, коллекции, списка, массива?

Существует несколько классов в C# (dotnet), которые могут быть взаимозаменяемы. Как уже упоминалось, если вам нужно что-то из более конкретного класса, например «CanBeSortedClass», то сделайте его явным в вашем A.P.I ..

Имеет ли ваш A.P.I. пользователь действительно должен знать, что ваш класс может быть отсортирован или применить какой-то формат к элементам? Затем используйте «CanBeSortedClass» или «ElementsCanBePaintedClass», , иначе используйте «GenericBrandClass».

В противном случае используйте более общий класс.

Общие классы коллекций против подпункта («дженериков») коллекции

Вы найдете, что есть классы, которые содержат другие элементы, и вы можете указать, что все элементы должны быть из определенного типа.

Общих Коллекции являются теми классами, которые вы можете использовать тот же набор, для нескольких приложений коды, без необходимости создавать новую коллекцию, для каждого нового типа пп, как это: Коллекции.

Есть ли у вас A.P.I. пользователю нужен очень специфический тип, такой же для всех элементов?

Используйте что-то наподобие List<WashingtonApple>.

Есть ли у вас A.P.I. пользователю понадобится несколько родственных типов?

Expose List<Fruit> для A.P.I., и использовать List<Orange>List<Banana>, List<Strawberry> внутри, где Orange, Banana и Strawberry являются потомками Fruit.

Есть ли у вас A.P.I. пользователю понадобится коллекция универсального типа?

Использовать List, где все предметы object (s).

Cheers.

Answer 6

IList<T> - базовый интерфейс для всех общих списков. Поскольку это упорядоченная коллекция, реализация может принять решение о заказе, начиная от упорядоченного порядка и заканчивая порядком размещения. Кроме того, Ilist имеет свойство Item, которое позволяет методам читать и редактировать записи в списке на основе их индекса. Это позволяет вставлять, удалять значение в/из списка по индексу позиции.

Также с IList<T> : ICollection<T> все методы от ICollection<T> также доступны здесь для реализации.

ICollection<T> является базовым интерфейсом для всех общих коллекций. Он определяет размер, счетчики и методы синхронизации. Вы можете добавить или удалить элемент в коллекцию, но вы не можете выбрать, в какой позиции это происходит из-за отсутствия свойства индекса.

Collection<T> обеспечивает реализацию для IList<T>, IList и IReadOnlyList<T>.

Если вы используете более узкий тип интерфейса, такой как ICollection<T> вместо IList<T>, вы защищаете свой код от нарушений. Если вы используете более широкий тип интерфейса, такой как IList<T>, вам больше угрожает нарушение изменений кода.

Цитирование из source,

ICollection, ICollection<T>: Вы хотите изменить коллекцию или вы заботитесь о его размере. IList, IList<T>: Вы хотите изменить коллекцию и заботиться о заказе и/или размещении элементов в коллекции.