Wann sollte ich einen Parameter von Iterable <T> vs. Sammlung <T> in Java akzeptieren?

Question

Was sind die Überlegungen zur Verwendung von Iterable<T> vs. Collection<T> in Java?

Sie können beispielsweise einen Typ implementieren, der in erster Linie eine Sammlung von Foo s und einige zugehörige Metadaten enthält. Der Konstruktor dieses Typs erlaubt eine einmalige Initialisierung der Objektliste. (Die Metadaten können später festgelegt werden.) Welchen Typ sollte dieser Konstruktor akzeptieren? Iterable<Foo> oder Collection<Foo>?

Was sind die Überlegungen für diese Entscheidung?

dem Muster folgend von Bibliothekstypen wie ArrayList dargelegt (die von jedem Collection initialisiert werden kann, aber nicht ein Iterable) würde mich führen Collection<Foo> zu verwenden.

Aber warum nicht akzeptieren Iterable<Foo>, vorausgesetzt, das ist ausreichend für die Initialisierung braucht? Warum vom Kunden ein höheres Maß an Funktionalität (Collection) verlangen als das, was unbedingt notwendig ist (Iterable)?

Answer 1

Viele der Sammlungstypen existierten, bevor Iterable<T> (die nur in 1,5 eingeführt wurde) - gibt es wenig Grund, ein Konstruktor hinzufügen zu akzeptieren Iterable<T>sowieCollection<T> aber die vorhandene Konstruktor zu ändern wäre ein Bruch Änderung gewesen.

Persönlich würde ich Iterable<T> verwenden, wenn Sie damit alles tun können, was Sie wollen. Es ist flexibler für Anrufer, und insbesondere können Sie relativ einfache Filterung/Projektion/etc mit den Google Java Collections (und ohne Zweifel ähnliche Bibliotheken) tun.

Answer 2

Nach dem Prinzip der geringsten Überraschung sollten Sie das Java-Sammlungsmuster emulieren und einen Collection-Konstruktor arg verwenden. Es wird die Leute, die nach dir kommen, etwas weniger verwirrt machen.

Answer 3

Sie haben Recht, da es als gute Praxis gilt, nach der allgemeinsten Form dessen zu fragen, was Sie brauchen.

Answer 4

Verwenden Sie die allgemeinste Schnittstelle, die Sie können. Da alles, was Sie tun werden, iterieren wird, würde ich sagen, Iterable ist der Weg zu gehen (da es faule Iteratoren usw. erlaubt). Es ist Ihnen egal, woher der Iterator kommt, also beschränken Sie ihn nicht mehr als nötig.

Answer 5

Wenn Sie auf Sammlung zugreifen, kann Ihre Klasse nur aus einer Sammlung initialisiert werden. Wenn Sie Iterable verwenden, können Sie entweder aus einer Sammlung oder iterierbar initialisieren.

Da der Aufwand und die Leistung für beide identisch sind, ist es absolut sinnvoll, Iterable im Konstruktor zu akzeptieren.

Answer 6

Ein Iterable produziert Iterator Objekte. Ein Iterator Objekt per Definition iteriert. Beachten Sie, dass die Iterator-Schnittstelle kein Versprechen gibt, wie oft aufgerufen werden kann, bevor hasNext()false zurückgibt. Ein Iterator könnte möglicherweise über Integer.MAX_VALUE + 1 Werte iterieren, bevor seine hasNext() Methode false zurückgibt.

Eine Collection ist jedoch eine spezielle Form von Iterable. Da ein Collection nicht mehr als Integer.MAX_VALUE Elemente haben kann (aufgrund der Methode size()), wird natürlich angenommen, dass seine Iterator Objekte nicht über diese vielen Elemente iterieren werden.

Durch die Annahme einer Collection anstelle einer Iterable kann Ihre Klasse eine gewisse Garantie dafür haben, wie viele Elemente übergeben werden. Dies ist besonders wünschenswert, wenn Ihre Klasse selbst eine Collection ist.

Nur meine zwei Cents ...

Answer 7

Einige Konstruktoren, z.B. ArrayList (Collection c), verwenden Sie die ToArray() -Methode von Collection für Effizienz.

Answer 8

Siehe "Warum so viel Wert auf Iteratoren und Iterables?" auf der Google Collection FAQ für ein gutes Argument für die Bevorzugung von Iteratoren, vor allem, wenn es sich um eine Menge Daten handelt. Eine Analogie, die helfen könnte, ist der Unterschied zwischen Nur-Lese-Cursors und schreibbaren Cursorn.

Answer 9

Benutzer von Spring Data JPA werden feststellen, dass die Repositories return Sammlungen von Typ Iterable<T>.

auf Projekten, die ich habe in der Vergangenheit gearbeitet, die Spring verwenden, die ich gefunden habe, dass die Notwendigkeit an einer Sammlung für den Betrieb nach dem Abrufen hat oft diktiert, dass Iterable<T> in der Business-Schicht statt Collection<T> verwendet wird, um ein Objekt T aus der Sammlung auszuwählen.

Alle Kollektionen sind Iterable (dass die Schnittstellen sind, die die Collection Schnittstelle erweitern, so dass nicht Map!), So Iterable in der Business-Schicht verwenden, ist nur ein Fall von durch seinen Supertyp eine Sammlung beziehen und immer noch erlaubt die Verwendung von for-each zu iterieren.

Wenn Sie den Inhalt einer Sammlung bearbeiten müssen, eine bequeme Methode erlaubt es dir, ein neues Collection zu füllen, so können Sie nutzen , remove() usw. mit den ursprünglichen Sammlungsdaten zu machen.

Alternativ werden Komfortmethoden von beliebten Drittanbieter-APIs wie Google Guava und Apache Commons für diesen Zweck bereitgestellt.