반환 타입으로는 스트림보다 컬렉션이 낫다 - [7장. 람다와 스트림(아이템47)]

📙 1. 원소 시퀀스 반환 타입 비교

  일련의 원소(원소 시퀀스)를 반환하는 메서드는 수없이 많다. 이런 메서드의 반환 타입으로 Collection, Set, List와 같은 인터페이스, Iterable, 배열, 스트림이 존재한다. 이 중 가장 적합한 타입은 컬렉션 인터페이스다.

 

  만약, API를 스트림만 반환하도록 짜놓으면 반환된 스트림을 for-each로 반복하길 원하는 사용자는 당연히 불만을 토로할 것이다. 스트림을 반복하기 위해서는 아래와 같은 우회 방법을 선택해야 한다.

for (ProcessHandle ph : (Iterable<ProcessHandle>) ProcessHandle.allProcesses()::iterator) {
    ...
}

  작동은 하지만 실전에 쓰기에는 너무 난잡하고 직관성이 떨어진다. 그래서 아래와 같이 어댑터 메서드를 사용할 수도 있다.

public static <E> Iterable<E> iterableOf(Stream<E> stream) {
    return stream::iterator;
}

for (ProcessHandle p : iterableOf(ProcessHandle.allProcesses())) {
    ...
}

  또한, API가 Iterable만 반환하면 이를 스트림 파이프라인에서 처리하려는 프로그래머가 불만을 토로할 것이다. 이러한 경우에도 어댑터를 이용하여 우회하는 방법이 있다.

public static <E> Stream<E> streamOf(Iterable<E> iterable) {
    return StreamSupport.stream(iterable.spliterator(), false);
}

 

  하지만, 일반적으로는 공개 API를 작성할 때는 스트림 파이프라인을 사용하는 사람과 반복문에서 쓰려는 사람 모두를 배려해야 한다. 그렇기 때문에 원소 시퀀스의 반환타입으로는 Collection 인터페이스가 가장 적절하다.

 

📙 2. 권장사항 3가지

  Collection 인터페이스는 Iterable의 하위 타입이고 stream 메서드도 제공하니 반복과 스트림을 동시에 지원한다. 따라서 원소 시퀀스를 반환하는 공개 API의 반환 타입에는 Collection이나 그 하위 타입을 쓰는 게 일반적으로 최선이다. 원소 시퀀스를 반환하는 경우 아래 3가지 방법을 참고하도록 하자.

📌 1. 반환하는 시퀀스의 크기가 메모리에 올려도 안전할 만큼 작다면 ArrayList나 HashSet 같은 표준 컬렉션 구현체를 반환하는 게 최선일 수 있다.

📌 2. 반환할 시퀀스가 크지만 표현을 간결하게 할 수 있다면 전용 컬렉션을 구현하는 방안을 검토해 보자.

  멱집합(한 집합의 모든 부분집합을 원소로 하는 집합)을 생각해 보자. 원소 개수가 n개면 멱집합의 원소 개수는 2^n개가 된다.

  크기가 커질 수 있기 때문에 이를 표준 컬렉션 구현체에 저장하려는 것은 위험하다. 그렇기 때문에 아래와 같이 AbstractList를 이용하여 전용 컬렉션을 구현할 수 있다.

public class PowerSet {
    public static final <E> Collection<Set<E>> of(Set<E> s) {
        List<E> src = new ArrayList<>();
        if(src.size() > 30)
            throw new IllegalArgumentException("집합에 원소가 너무 많습니다(최대 30개).: " + s);

        return new AbstractList<Set<E>>() {
            @Override
            public int size() {
                // 멱집합의 크기는 2를 원래 집합의 원소 수만큼 거듭제곱 한 것과 같다.
                return 1 << src.size();
            }

            @Override
            public boolean contains(Object o) {
                return o instanceof Set && src.containsAll((Set) o);
            }

            @Override
            public Set<E> get(int index) {
                Set<E> result = new HashSet<>();
                for (int i = 0; index != 0; i++, index >>= 1)
                    if((index & 1) == 1)
                        result.add(src.get(i));
                return result;
            }
        };
    }
}

📌 3. 컬렉션을 반환하는 게 불가능하면 스트림과 Iterable 중 더 자연스러운 것을 반환하라.

  그리고 반복을 사용하는 게 더 자연스러운 상황에서도 사용자는 그냥 스트림을 쓰거나 Stream을 Iterable로 변환해 주는 어댑터를 사용하는 게 낫다. (그러나 어댑터는 클라이언트 코드를 어수선하게 만들고 더 느리게 만든다는 것을 알고 있어야 한다.)

 

해당 글은 Joshua Bloch 님의 'Effective Java 3/E'를 참고하였습니다.