[아이템 58] 전통적인 for 문보다는 for-each 문을 사용하라

[Why]

스트림이 제격인 작업이 있고 반복이 제격인 작업이 있다.

for (Iterator<Element> i = c.iterator(); i.hasNext();) {
    Element e = i.next();
    ... // e로 무언가를 한다.
}

for (int i=0; i<a.length; i++) {
    ... // a[i]로 무언가를 한다.
}

• 반복자(Iterator)와 인덱스 변수(i)는 모두 코드를 지저분하게 할 뿐 우리에게 진짜 필요한 건 원소들뿐이다.
  • 1회 반복에서 반복자는 세 번 등장하며, 인덱스는 네 번이나 등장하여 변수를 잘못 사용할 틈새가 넓어진다.
  • 잘못된 변수를 사용했을 때 컴파일러가 잡아주리라는 보장도 없다.
  • 컬렉션이냐 배열이냐에 따라 코드 형태가 상당히 달라지므로 주의해야 한다.

 

[When]

안타깝게도 for-each 문을 사용할 수 없는 상황이 세 가지 존재한다.

• 파괴적인 필터링(destructive filtering) : 컬렉션을 순회하면서 선택된 원소를 제거해야 한다면 반복자의 remove 메서드를 호출해야 한다. 자바 8부터는 Collection의 removeIf 메서드를 사용해 컬렉션을 명시적으로 순회하는 일을 피할 수 있다.
• 변형(transforming) : 리스트나 배열을 순회하면서 그 원소의 값 일부 혹은 전체를 교체해야 한다면 리스트의 반복자나 배열의 인덱스를 사용해야 한다.
• 병렬 반복(parallel iteration) : 여러 컬렉션을 병렬로 순회해야 한다면 각각의 반복자와 인덱스 변수를 사용해 엄격하고 명시적으로 제어해야 한다.

 

[How]

for-each 문을 사용하면 모두 해결된다.

• for-each 문의 정식 이름은 '향상된 for 문(enhanced for statement)'이다.
• for-each 문은 컬렉션과 배열은 물론 Iterable 인터페이스를 구현한 객체라면 무엇이든 순회할 수 있다.

for (Element e : elements) {
    ... // e로 무언가를 한다.
}

 

버그를 찾아보자

enum Suit { CLUB, DIAMOND, HEART, SPADE }
enum Rank { ACE, DEUCE, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT,
            NINE, TEN, JACK, QUEEN, KING }
...

static Collection<Suit> suits = Arrays.asList(Suit.values());
static Collection<Rank> ranks = Arrays.asList(Rank.values());

List<Card> deck = new ArrayList<>();
for (Iterator<Suit> i = suits.iterator(); i.hasNext(); )
    for (Iterator<Rank> j = ranks.iterator(); j.hasNext(); )
        deck.add(new Card(i.next(), j.next()));

• 문제는 바깥 컬렉션(suits)의 반복자에서 next 메서드가 너무 많이 불린다는 것이다.
  • 마지막 줄의 i.next()는 '숫자(Suit) 하나당' 한 번씩만 불려야 하는데,
    안쪽 반복문에서 호출되는 바람에 '카드(Rank) 하나당' 한 번씩 불리고 있다.
  • 그래서 숫자가 바닥나면 반복문에서 NoSuchElementException을 던진다.

for (Suit suit : suits)
    for (Rank rank : ranks)
        deck.add(new Card(suit, rank));

• for-each 문을 중첩하는 것으로 이 문제는 간단히 해결된다.