(이펙티브 자바) 규칙58. 전통적인 for 문보다는 for-each 문을 사용하라

(Effective Java) 규칙58. 전통적인 for 문보다는 for-each 문을 사용하라

---

전통적인 for문의 컬렉션, 배열 순회의 단점

---

• 아래 관용구들은 while문보다는 낫지만(규칙57) 가장 좋은 방법은 아니다.

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

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

  • 반복자와 인덱스 변수는 모두 코드를 지저분하게 할 뿐 진정 필요한 건 원소들뿐임
    • 쓰이는 요소가 늘어나면 오류가 생길 가능성이 높아짐
  • 컬렉션이냐 배열니야에 코드 형태가 상당히 달라짐

 

for-each 문

---

• for-each 문의 정식 이름은 '향상된 for문'이다.

• 반복자와 인덱스 변수를 사용하지 않으니 코드가 깔끔해지고 오류가 날 일도 없다.

• 공통된 관용구로 컬렉션과 배열을 모두 처리할 수 있어서 어떤 컨테이너를 다루는지는 신경 쓰지 않아도 된다.

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

  • 이 반복문은 "elements 안의 각 원소 e에 대해" 라고 읽음
    • 여기서 콜론(:)은 "안의(in)"라고 읽으면 되기 때문
  • 반복 대상이 컬렉션이든 배열이든 for-each문을 사용해도 속도는 그대로임
    • for-each문이 만들어내는 코드는 사람이 손으로 최적화한 것과 사실상 같기 때문임

 

반복문의 중첩

---

• 컬렉션을 중첩해 순회해야 한다면 for-each문의 이점이 더욱 커진다.

반복문을 중첩할 때 흔히 저지르는 실수

• 실수 예제

  enum Suit {CLUB, DIAMOND, HEART, SPACE}
  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 메서드가 너무 많이 불린다는 것
  • 이 next()는 '숫자(Suit)하나당' 한번씩만 불려야 하는데, '카드(Rank) 하나당' 한 번씩 불리고 있음
    • 그래서 숫자가 바닥나면 반복문에서 NoSuchElementException을 던짐

• 좀 더 심각한 문제

  • 정말 운이 나빠서 바깥 컬렉션의 크기가 안쪽 컬렉션 크기의 배수라면 (같은 컬렉션일 때 이럴 수 있음)

  enum Face {ONE, TWO, THREE, FOUR, FIVE, SIX}
  ...
  Collections<Face> faces = EnumSet.allOf(Face.class);
  
  for (Iterator<Face> i = faces.iterator(); i.hasNext()) {
    for (Iterator<Rank> j = faces.iterator(); j.hasNext()) {
      System.out.println(i.next() + " " + j.next());
    }
  }

  • 이 프로그램은 예외를 던지진 않지만, 가능한 조합을 ("ONE ONE" 부터 "SIX SIX"까지) 단 여섯 쌍만 출력하고 끝나버림

해결 방법 및 for-each의 사용

• 위 문제를 해결하기 위해서는 바깥 반복문에 바깥 원솔을 저장하는 변수를 하나 추가해야 한다.

  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문을 사용할 수 없는 상황

---

• 안타깝게도 for-each문을 사용할 수 없는 상황이 세 가지 존재한다.
• 세 가지 상황 중 하나에 속할 때는 일반적인 for문을 사용하되 앞서 언급한 문제들은 경계하기 바란다.

1. 파괴적인 필터링

• 컬렉션을 순회하면서 선택된 원소를 제거해야 한다면 반복자의 remove 메서드를 호출해야 함
• 자바8부터 Coleection의 removeIf 메서드를 사용해 컬렉션을 명시적으로 순회하는 일을 피할 수 있음

2. 변형(transforming)

• 리스트나 배열을 순회하면서 그 원소의 값 일부 혹은 전체를 교체해야 한다면 리스트의 반복자나 배열의 인덱스를 사용해야 함

3. 병렬 반복 (parallel iteration)

• 여러 컬렉션을 병렬로 순회해야 한다면 각각의 반복자와 인덱스 변수를 사용해 엄격하고 명시적으로 제어해야 함
  • 앞선 첫번째 실수 예제 코드가 해당 사례에 속함

 

Iterable인터페이스

---

• for-each 문은 컬렉션과 배열은 물론 iterable 인터페이스를 구현한 객체라면 무엇이든 순회할 수 있다.

• Iterable 인터페이스는 다음과 같이 메서드가 단 하나뿐이다.

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

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

  • 해당 타입에서 Collection 인터페이스는 구현하지 않기도 했더라도

• Iterable을 구현해두면 그 타입을 사용하는 프로그래머가 for-each문을 사용 할때 마다 여러분에게 감사해할 것이다.

 

결론

---

• 전통적인 for문과 비교했을 때 for-each문은 명료하고, 유연하고, 버그를 예방해준다.

  • 성능 저하 또한 없음

• 가능한 모든 곳에서 for문 대신 for-each 문을 사용하자

   

---

끝으로

이 글이 도움이 되었다면, 하단의 Google 광고 👎👎👎 한번씩 클릭 부탁 드립니다. 🙏🙏🙏

광고 클릭은 많은 힘이 됩니다!