Iterator 패턴

Java 언어에서 배열 arr의 모든 요소들을 표시하기 위해서는 다음과 같이 for문을 사용해야 한다.

1. for ( int i = 0 ; i < arr.length ; i++ ) {

2. System.our.println( arr[i] );

3. }

위에서 사용되고 있는 루프 변수 i를 살펴보겠습니다. 변수 i는 처음에 0으로 초기화되어 1, 2, 3, ... 으로 증가합니다. 그 때마다 arr[i]의 내용이 표시됩니다. 이와 같은 for문은 자주 사용됩니다. 배열은 요소가 많이 모여있는 것으로, 첨자를 지정하면 많은 교수 중 1개를 선택할 수 있습니다.

arr[0]   최초의 요소( 0번째 요소)

arr[1]   그 다음의 요소( 1번째 요소)

...

arr[i]   i번째 요소

...

arr[arr.length - 1 ]   최후의 요소

for 문이 i++에서 i를 하나씩 증가시키면, 현재 주목하고 있는 배열의 요소를 차례대로 처리해 갑니다. 이와 같이 i를 하나씩 증가시키면서 배열 arr의 요소 전체를 처음부터 차례대로 검색하게 됩니다. 여기에서 사용되고 있는 변수 i의 기능을 추상화해서 일반화한 것을 디자인 패턴에서는

Interator 패턴

이라고 합니다. Iterator 패턴이란, 무엇인가 많이 모여있는 것들을 순서대로 지정하면서 전체를 검색하는 처리를 실행하기 위한 것입니다.

iterator 는 무엇인가를 '반복한다'라는 의미이며, 반복자(反復子)라고도 합니다. 이번 장에서는 Iterator 패턴을 배우겠습니다.

예제 프로그램

Iterator 패턴을 사용하여 만든 예제 프로그램을 살펴봅시다. 여기에서 작성할 예제 프로그램은 서가(BookShelf) 안에 책(Book)을 넣고, 그 책의 이름을 차례대로 표시하는 프로그램 입니다(그림 1 - 1).

Aggregate 인터페이스

Aggregate 인터페이스(리스트 1 - 1 ) 는 요소들이 나열되어 있는 '집합체'를 나타냅니다. 이 인터페이스를 구현하고 있는 클래스는 배열과 같이 무엇인가가 많이 모여있습니다. aggregate는 '모으다', '모이다', '집합'이라는 의미입니다.

리스트 1-1 Aggregate 인터페이스(Aggregate.java)

1. public interface Aggregate {
       public abstract Iterator iterator();
   }

Aggregate 인터페이스에서 선언되어 있는 메소드는 iterator 메소드 하나뿐입니다. 이 메소드는 집합체에 대응하는 Iterator를 1개 생성하기 위한 것 입니다.

집합체를 하나씩 나열하고, 검색하고 싶을 때에는 iterator 메소드를 사용해서 Iterator 인터페이스를 구현한 클래스의 인터페이스를 만듭니다.

Iterator 인터페이스

다음으로 Iterator 인터페이스( 리스트 1 - 2 )를 살펴봅시다. Iterator 인터페이스는 요소를 하나씩 나열하면서 루프 변수와 같은 역할을 수행합니다. Iterator에는 어떤 메소드가 필요할까요? 다양한 기법이 있지만, 여기서는 가장 단순한 형태의 Iterator 인터페이스를 만들어 보았습니다.

리스트 1-2 Iterator 인터페이스(Iterator.java)

1. public interface Iterator {
       public abstract boolean hasNext();
       public abstract Object next();
   }

여기에 선언되어 있는 메소드는 2개 입니다. '다음 요소'가 존재하는지를 조사하기 위한 hasNext 메소드와 '다음 요소'를 얻기 위한 next 메소드 입니다. hasNext 메소드의 반환 값이 boolean 형인 이유가 이해가 될 것입니다(다음 요소가 있으면 True, 다음 요소가 없으면 False). 다음 요소가 존재하면 이 메소드는 True를 반환하고, 다음 요소가 존재하지 않는 마지막 요소라면 이 메소드의 반환값은 False 가 됩니다. 즉, hasNext 메소드를 루프의 종료 조건으로 사용하기 위한 것입니다.

next 메소드는 약간의 설명이 필요합니다. 반환값의 행태가 Object로 되어있는 것에서 알 수 있듯이 next 메소드는 집합체의 요소를 1개 반환해 줍니다. 그러나 next 메소드의 역할은 그것만이 아닙니다. 다음 next 메소드를 호출했을 때 정확히 다음 요소를 반환하도록 내부 상태를 다음으로 진행시켜 두는 역할이 뒤에 숨어있습니다. 그러나 '뒤에 숨어 있다'고 하더라도 Iterator 인터페이스에서는 메소드 이름만 알 수 있습니다. 구체적인 역할은 Iterator 인터페이스를 구현하고 있는 클래스(BookShelfIterator)에서 살펴봅시다. 그러면 next 메소드의 역할이 좀 더 확실해질 것입니다.

Book 클래스

Book 클래스( 리스트 1 - 3 )는 책을 나타내는 클래스입니다. 할 수 있는 일은 책 이름을 getName() 메소드에서 얻는 일 뿐입니다. 책 이름은 생성자(Constructor)에서 인스턴스 초기화할 때 인수로 지정합니다.

리스트 1 - 3 Book 클래스(Book.java)

1. public class Book {
       private String name;
   
       public Book(String name) {
           this.name = name;
       }
   
       public String getName() {
           return name;
       }
   }

BookShelf 클래스

BookShelf 클래스( 리스트 1 - 4 )는 서가를 나타내는 클래스 입니다. 이 클래스를 집합체로 다루기 위해 Aggregate 인터페이스를 구현하고 있습니다. 소스 안의 'implements Aggregate'가 Aggregate 인터페이스를 구현하고 있다는 것을 나타냅니다. 또한 Aggregate 인터페이스에서 선언되어 있던 iterator 메소드가 기술되어 있는 것도 확인할 수 있습니다.

리스트 1 - 4 BookShelf 클래스(BookShelf.java)

1. public class BookShelf implements Aggregate {
   
       private Book[] books;
       private int last = 0;
   
       public BookShelf( int maxsize ) {
           this.books = new Book[maxsize];
       }
   
       public Book getBookAt( int index ) {
           return books[index];
       }
   
       public void appendBook(Book book) {
           this.books[last] = book;
           last++;
       }
   
       public int getLength() {
           return last;
       }
   public Iterator iterator() {
           return new BookShelfIterator(this);
       }
   
   }

이 서가는 books 라는 필드를 가지고 있습니다. 이 필드는 Book의 배열입니다. 이 배열의 크기(maxsize)는 처음에 BookShelf의 인스턴스를 만들 때 지정합니다. books 필드를 private 로 한 이유는, 이 클래스 외부로부터 뜻하지 않게 변경되는 것을 방지하기 위해서 입니다.

iterator 메소드는 BookShelf 클래스에 대응하는 Iterator로서, BookShelfIterator 라는 클래스의 인스턴스를 생성해서 그것을 반환합니다. 이 서가의 책을 하나씩 나열하고 싶을 때는 iterator 메소드를 호출합니다.

BookShelfIterator 클래스

BookShelf 클래스의 검색을 실행하는 BookShelfIterator 클래스( 리스트 1 - 5 )를 살펴봅시다.

리스트 1 - 5  BookShelfIterator 클래스(BookShelfIterator.java)

1. public class BookShelfIterator implements Iterator {
      
       private BookShelf bookShelf;
       private int index;
   
       public BookShelfIterator ( BookShelf bookShelf ) {
           this.bookShelf = bookShelf;
           this.index = 0;
       }
   
       public boolean hasNext() {
           if ( index < bookShelf.getLength() ) {
               return true;
           } else {
               return false;
           }
       }
   
       public Object next() {
           Book book = bookShelf.getBookAt(index);
           index++;
           return book;
       }
   }

BookShelfIterator 를 Iterator로서 다루기 위해 Iterator 인터페이스를 구현하고 있다. bookShelf 필드는 BookShelfIterator가 검색할 서가이고, index 필드는 현재 주목하고 있는 책을 가리키는 첨자입니다.

생성자에서는 전달된 BookShelf의 인스턴스를 bookShelf 필드에 저장하고 index를 0으로 합니다. hasNext 메소드는 Iterator 인터페이스에서 선언되어 있는 메소드를 구현한 것입니다. '다음 책'이 있는지를 조사해서 있으면 true, 없으면 false를 반환합니다. 다음 책이 있는지 없는지는 index가 서가에 있는 책의 권수(식 bookShelf.getLength()의 값)보다 작은지, 큰지로 판정합니다.

next 메소드는 현재 처리하고 있는 책(Book의 인스턴스)을 반환하고, 다시 '다음'으로 진행시키기 위한 메소드 입니다. Iterator 인터페이스에서 선언되어 있는 메소드로써 조금 복잡합니다. 우선 반환값으로 반환해야 할 책을 book이라는 변수로 저장해 두고 index를 다음으로 진행시킵니다.

'index를 다음으로 진행'시키는 처리는 서두에서 언급한 for문의 i++에 해당하는 처리입니다. 루프변수를 '다음'으로 진행시킨 것입니다.

Main 클래스

이것으로 서가를 검색할 준비가 끝났습니다. 그러면 Main 클래스( 리스트 1 - 6 )를 이용해서 작은 서가를 만들어 봅시다.

리스트 1 - 6 Main 클래스(Main.java)

1. public class Main {
       public static void main(String[] args)    {
           BookShelf bookShelf = new BookShelf(4); // 서고에 있는 책 수 정의
           bookShelf.appendBook( new Book("Around the world in 80 days") );
           bookShelf.appendBook( new Book("Bible") );
           bookShelf.appendBook( new Book("Cinderella") );
           bookShelf.appendBook( new Book("Daddy-Long-legs") );
           Iterator it = bookShelf.iterator();
           while ( it.hasNext() ) {
               Book book = (Book)it.next();
               System.out.println(book.getName());
           }
       }
   }

우선 책이 4권 들어가는 서가를 만듭니다. 그리고 순서대로

• Around the world in 80 days

• Bible

• Cinderalla

• Daddy-Long-Legs

라는 4권의 책을 만들었습니다. 책 이름은 순서를 알기 쉽도록 첫 글자의 A, B,C, ... 알파벳 순서로 하였습니다.

bookShelf.iterator()에 의해 얻어지는 it가 서가를 검색하기 위한 Iterator의 인스턴스입니다. while의 조건 부분에 쓰는 것은 물론 it.hasNext() 입니다. 이것으로 책이 있는 한 while 루프가 돌아가고, 루프 내에서 it.next()에 의해 책을 한 권씩 조사하게 됩니다. 실행 결과는 그림 1-3과 같습니다.

그림 1 - 3

Around the world in 80 days
Bible
Cinderella
Daddy-Long-legs

Iterator 패턴의 등장인물

예제 프로그램을 살펴보았으니, 이제 Iterator 패턴의 등장 인물을 정리해 봅시다.

Iterator(반복자)의 역할

요소를 순서대로 검색해가는 인터페이스(API)를 결정합니다. 예제 프로그램에서 Iterator 인터페이스가 그 역할을 하고, 다음 요소가 전재하는지를 얻기 위한 hasNext() 메소드와 다음 요소를 얻기 위한 next 메소드를 결정합니다.

ConcreteIterator(구체적인 반복자)의 역할

Iterator가 결정한 인터페이스(API)를 실제로 구현합니다. 예제 프로그램에서는 BookShelfIterator 클래스가 이 역할을 하였습니다. 이 역할은 검색하기 위해 필요한 정보를 가지고 있어야 합니다. 예제 프로그램에서는 BookShelf 클래스의 인스턴스는 bookShelf 필드에서, 처리되고 있는 책은 index 필드에 기억되어 있었습니다.

Aggregate(집합체)의 역할

iterator 역할을 만들어내는 인터페이스(API)를 결정합니다. 이 인터페이스(API)는 '내가 가지고 있는 요소를 순서대로 검색해 주는 사람'을 만들어 내는 메소드 입니다. 예제 프로그램에서는 Aggregate 인터페이스가 이 역할을 담당하며 iterator 메소드를 결정합니다.

ConcreAggregate(구체적인 집합체)의 역할

Aggregate 역할이 결정한 인터페이스(API)를 실제로 구현하는 일을 합니다. 구체적인 Iterator 역할, 즉 ConcreIterator 역할의 인스턴스를 만들어냅니다. 예제 프로그램에는 BookShelf 클래스가 이 역할을 담당하며, iterator 메소드를 구현합니다. 이상의 Iterator 패턴을 클래스 다이어그램으로 표기하면 그림 1 - 4와 같습니다.

이 글은 스프링노트에서 작성되었습니다.