Effective Java ( 이펙티브 자바 ) - 아이템 58

전통적인 for문보다는 for-each 문을 사용하라

---

전통적인 for문으로 컬렉션과 배열을 순회하는 코드다.

for (Iterator<Element> i = c.iterator(); i.hasNext(); ) {
   Element e = i.next();
}

for (int i=0; i< a.length; i++) {
   ...
}

  while문 보다는 낫지만 가장 좋은 방법은 아니다. 반복자와 인덱스 변수는 모두 코드를 지저분하게 할 뿐 진짜 필요한건 원소들뿐이다.  쓰이는 요소 종류가 늘어나면 오류가 생길 가능성이 높다. 컬렉션이냐 배열이냐에 따라 코드 형태가 상당히 달라지므로 주의해야 한다.

 

  이상의 문제는 for-each 문을 사용하면 모두 해결된다. 정식 이름은 '향상된 for 문(enhanced for statement)' 이다. 컬렉션과 배열을 모두 처리할 수 있어서 어떤 컨테이너를 다루는지는 신경 쓰지 않아도 된다.

for (Element e : elements) {
    ...
}

콜론은 "안의(in)"라고 읽으면 된다. 따라서 이 반복문은 "elements 안의 각 원소 e에 대해"라고 읽는다. 반복 대상이 컬렉션이든 배열이든 속도는 그대로다. 사람이 최적화한 것과 사실상 같게 동작한다.

 

  컬렉션을 중첩해 순회해야 한다면 for-each문의 이점이 더욱 커진다. 다음 코드는 반복문을 중첩할 때 흔히 저지르는 실수가 담겨있다.

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())); // 여기가 문제다. 
      // i.next()를 호출해버리면 위의 i의 지시자가 뒤로 밀려난다.

위의 코드는 NoSuchElementException을 던진다.

 

enum Face { ONE, TWO, THREE, FOUR, FIVE, SIX }
...
Collection<Face> faces = EnumSet.allOf(Face.class);

for (Iterator<Face> i = faces.iterator(); i.hasNext(); )
   for (Iterator<Face> j = faces.iterator(); j.hasNext(); )
      System.out.println(i.next() + " " + j.next());

이 프로그램은 예외를 던지진 않지만, ONE ONE ~ SIX SIX 까지 6개만 출력하고 끝난다. 이 문제를 해결하려면 바깥 반복문에 변수가 하나 더 필요하다.

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

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

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

---

 

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

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

세 가지 상황 중 하나에 속할 때는 일반적인 for문을 사용하되 이번 아이템에서 언급한 문제들을 경계하자.

 

---

for-each 문은 컬렉션과 배열은 물론 Iterable 인터페이스를 구현한 객체라면 무엇이든 순회할 수 있다. Iterable 인터페이스는 다음과 같이 메서드가 단 하나뿐이다.

public interface Iterable<E> {
   // 이 객체의 원소들을 순회하는 반복자를 반환한다.
   Iterator<E> iterator();
}

Iterable을 처음부터 직접 구현하기는 까다롭지만, 원소들의 묶음을 표현하는 타입을 작성해야 한다면 Iterable을 구현하는 쪽으로 고민해보자.

 

전통적인 for 문과 비교했을 때 for-each 문은 명료하고, 유연하고, 버그를 예방해준다. 성능 저하도 없다. 가능한 모든 곳에서 for문이 아닌 for-each 문을 사용하자.