Допустимо ли возвращать unmodifiableList или я должен возвращать массив?

Question

У меня есть метод List<Foo> getFoos(), который получает данные с удаленного сервера и возвращает его.

Конечно, пользователь не должен изменять количество элементов списка, потому что он будет получать данные, не синхронизированные с данными на сервере (и если он хочет изменить количество элементов, у него есть специальные методы, такие как addFoo()).

Первый подход состоял в том, чтобы вернуть массив и подменить метод подписи Foo[] getFoos(). Но он более распространен в java и более удобен для пользователя для работы с коллекциями, поэтому я сменил подпись на List<Foo> getFoos(). Этот метод всегда возвращает

Collections.unmodifiableList (originalList)

Таким образом, когда пользователь попытается изменить список, он получит RuntimeException.

Есть ли какие-либо рекомендации по дизайну api в подобных случаях?

Answer 1

Collections.unmodifiableList вполне приемлем и должен быть быстрее (нет необходимости создавать массив).

Редактировать - Что касается дизайна API, вы должны просто сделать свой JavaDoc понятным! Люди, которые используют метод, не читая его док, заслуживают удивления: p

Answer 2

Если вы хотите создать специализированное специализированное свойство из существующего объекта или List в этом случае, почему бы не попытаться расширить или скрыть его и заставить соответствующие аксессуры бросать исключение?

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

Answer 3

Я бы также сказал, что это вполне приемлемо и намного лучше, чем возвращение массива (что предложение some должно рассматриваться как устаревший тип вообще). Если вы хотите более подробно рассказать об этом в API, вы можете подумать о возврате ImmutableList от Google Collections.

Answer 4

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

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

Answer 5

Если у вас есть полная свобода, и, похоже, это так, то вам не нужно выбирать между массивом или списком, а скорее возвращать итератор. Это также поможет, если вам нужна уникальность, поэтому вместо возврата Set - все равно возвратите итератор.