Custom Collection vs Generic Collection для общедоступных методов

Question

Каковы рекомендации по экспорту пользовательской коллекции и общей?

например

public class ImageCollection : Collection<Image> 
{ 
    ... 
} 

public class Product 
{ 
    public ImageCollection {get; set;} 
} 

VS

public class Product 
{ 
    public Collection<Image> Images{get; set;} 
} 

Какие дела вы бы рассмотреть вопрос о создании пользовательской коллекции? Каковы преимущества и недостатки каждого метода?

Answer 1

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

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

Если вы знаете ожидаемые шаблоны использования ваших «коллекций», вы должны предоставить соответствующий API, который в будущем будет обеспечивать минимальные ограничения на вас. Если, например, вы знаете, что людям просто нужно повторять ваши результаты, выведите IEnumerable<T>, чтобы позже вы могли перейти в ЛЮБОЙ коллекцию или даже переключиться непосредственно на возврат доходности.

Answer 2

Я бы пошел на второй. Клиентский код должен знать тип изображения в любом случае.

Первый означает только больше кода.

Answer 3

Единственная причина когда-либо использовать Collection<T> - это если вы хотите подключиться к набору виртуальных методов, который позволит вам увидеть все мутации в базовом списке. Это позволяет выполнять такие операции, как реагировать на удаление, осуществлять события и т. Д.

Если вы не заинтересованы в том, чтобы реагировать на эти изменения коллекции или наблюдать за ними, то более подходящим является тип List<T>.

Answer 4

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

• Расширяемость - вы можете добавлять функции в свою коллекцию в будущем без изменения API.

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

• Также легче сделать потенциально разрушающие изменения с меньшим воздействием. Возможно, позже вы решите, что не хотите, чтобы он был Collection<Image>, но другой тип коллекции - вы можете адаптировать свой класс ImageCollection к тем же методам, что и раньше, но наследовать от чего-то другого - и клиентский код вряд ли удастся сломать ,

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

Примером, приведенным в моей голове, является API-интерфейс ArcGIS Server от ESRI - они используют пользовательские коллекции в своих API-интерфейсах. По этим причинам мы также используем пользовательские коллекции в наших API.

Answer 5

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

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

class Product { 
    private readonly Collection<Image> _images; 
    public Product() { _images = new Collection<Image>(); } 
    public Collection<Image> Images { get { return _images; } } 
} 

-Oisin

Answer 6

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

Это обычно выглядит следующим образом:

public interface IProduct 
{ 
    ICollection<Image> Images { get; } 
} 

public class Product : IProduct 
{ 
    private class ImageCollection : Collection<Image> 
    { 
     // override InsertItem, RemoveItem, etc. 
    } 

    private readonly ImageCollection _images; 
    public ICollection<Image> Images 
    { 
     get { return _images; } 
    } 
} 

Я также часто делают пользовательский класс коллекции вложен внутри другого класса, что позволяет мне изменить некоторые частные члены родительского класса во время добавления/удаления.