[스위프트 디자인패턴] 반복자 패턴(Iterator Pattern)

반복자 패턴(Iterator Pattern)

반복자 패턴은 컬렉션의 내부 구현을 노출하지 않으면서 컬렉션의 모든 요소에 접근할 수 있는 방법을 제공합니다.

반복자 패턴은 컬렉션 객체로부터 반복적으로 컬렉션 요소에 접근하는 역할을 분리해내는 패턴입니다. 반복자 패턴을 사용하면 컬렉션은 자신의 요소들을 관리하는 역할에만 집중할 수 있고, 어떤 요청에 의해 특정한 요소를 외부로 알려주는 책임은 Iterator에게 모두 맡길 수 있게 되죠.

정의에서는 컬렉션의 내부 구현을 외부로 노출하지 않는다고 하는데요, 이 의미는 실제로 사용되는 컬렉션이 배열인지, 리스트인지와 같은 실제 구조와는 전혀 상관없이 각 원소들에 접근을 가능하게 한다는 것을 의미합니다. 그냥 Iterator를 받아서 끝에 도달할 때까지 다음 원소를 Iterator에게 다음 원소를 요청하기만 하면 되니까요.

그럼 반복자 패턴이 어떻게 구성되는지 알아봅시다.

 

반복자 패턴 이해하기

위 그림처럼 반복자 패턴은 크게 세 가지 요소로 구분됩니다.

먼저 Iterable 프로토콜과 이를 채택하는 객체입니다. Iterable은 말 그대로 순회가 가능한 요소들을 가지고 있는 객체가 됩니다. 따라서 우리가 컬렉션이라고 부르는, 여러 개의 요소들을 가지고 있는 객체가 Iterable이 되겠죠. Iterable은 컬렉션을 관리하는 책임을 가지게 되는데요, 반복자 패턴을 위해서 이 객체가 하는 일은 단 한 가지입니다. 클라이언트가 Iterable 객체 안에 있는 원소에 순차적으로 접근하고 싶을 때, 원소에 접근하는 책임을 가지는 객체는 Iterator를 생성해 반환해주는 것입니다. 

이 요청을 처리하는 메서드가 createIterator가 되겠죠. 

이제 반복자 패턴의 핵심이 되는 Iterator를 확인해봅시다. Iterator는 기본적으로 두 가지 메서드를 인터페이스로 제공해요. 물론 구현에 따라서 다른 편리한 API를 제공할 수도 있겠죠. hasNext는 아직 탐색하지 않은 원소가 존재하는지 확인하는 메서드이고, next는 다음 메서드를 가져오는 메서드에요. 이 iterator는 컬렉션에서 각각 구현하기 때문에 외부에서는 컬렉션의 내부 구현을 알지 못한 채로 hasNext와 next 인터페이스를 통해 원소들을 읽게 됩니다.

 

Iterator Pattern 만들어보기

protocol Iterable {
    associatedtype Iterator
    func makeIterator() -> Iterator
}

protocol Iterator {
    associatedtype Element
    func hasNext() -> Bool
    func next() -> Element?
}

이터레이터 패턴을 위해서 가장 먼저 Iterable과 Iterator 프로토콜을 정의했습니다. 우리가 그림에서 봤던 그 인터페이스를 그대로 제공하고 있어요. 

final class defaultIterator<T>: Iterator {
    typealias Element = T
    private var items: [Element] = []
    private var current = 0

    init(items: [Element]) {
        self.items = items
    }

    func next() -> Element? {
        guard hasNext() else { return nil }
        defer { self.current += 1 }

        return items[current]
    }

    func hasNext() -> Bool {
        current < items.count
    }
}

그리고 Iterator의 구체 타입을 정의했는데요, 먼저 초기화 시점에 어떤 배열을 입력받고, 현재 탐색 중인 요소를 표시하는 커서 역할을 하는 변수인 current를 정의했습니다. hasNext는 이 커서를 기준으로 다음 데이터가 있는지 판단하고, next에서는 current를 통해 데이터를 뽑아내 반환을 하게 됩니다. defer를 써보고 싶어서 한 번 써봤어요ㅎㅎ

그럼 이 패턴을 어떻게 응용하면 좋을지 클라이언트 코드를 만들어볼게요.

이터레이터 패턴의 정의나 책의 예제에서 가장 와닿았던 점이 내부 구현을 알지 못해도 반복을 돌릴 수 있다는 것이었는데요, 그래서 list와 map 두 종류의 컬렉션에 대한 클래스를 만들고 이터레이터 패턴을 적용해보았습니다.

final class MapCollection: Iterable {
    private var map: [String: String] = [:]

    func add(element: String, for key: String) {
        map.updateValue(element, forKey: key)
    }

    func makeIterator() -> defaultIterator<String> {
        return defaultIterator<String>(items: self.map.values.map({ $0 }))
    }
}

final class ListCollection: Iterable {
    private var list: [String] = []

    func add(element: String) {
        list.append(element)
    }

    func makeIterator() -> defaultIterator<String> {
        return defaultIterator<String>(items: self.list)
    }
}

두 클래스 모두 Iterable 프로토콜을 정의하지만 같은 타입의 Iterator를 생성해서 반환해주고 있습니다. 이제 이 클래스를 사용하는 사용자의 입장에서는 ListCollection이나 MapCollection이 이름을 통해 내부적으로 어떻게 구현되었는지 알 수 있을지는 몰라도, 반복문을 만들기 위해 내부 구현을 알 필요가 없습니다. 그냥 makeIterator()를 불러서 Iterator를 얻고, 원소를 탐색하기만 하면 되기 때문이죠.

let map = MapCollection()
let list = ListCollection()

map.add(element: "1", for: "1")
map.add(element: "2", for: "2")
map.add(element: "3", for: "3")

list.add(element: "11")
list.add(element: "22")
list.add(element: "33")

let iterators = [map.makeIterator(), list.makeIterator()]

for iterator in iterators {
    while iterator.hasNext() {
        print(iterator.next() ?? "0")
    }
}

// 3
// 2
// 1
// 11
// 22
// 33

이렇게 각각의 타입에 대한 반복문을 만들지 않아도, iterator를 통해 모든 요소에 대한 탐색이 간단하게 가능해집니다.

마무리

Iterator Pattern의 핵심은 내부 구현을 감추면서도 사용자가 컬렉션 객체가 가지고 있는 모든 원소들에 접근할 수 있는 방법을 제공한다는 것입니다. 그리고 동시에 원소를 탐색하는 역할을 컬렉션 객체에서 분리해낼 수 있죠. 

사실 스위프트에서는 IteratorProtocol 이라는 Foundation 프로토콜이 존재합니다.

이 예시처럼 스위프트는 Sequence 에 대해서 Iterator를 제공하는데요, for animal in animals와 같은 문법이 가능한 이유도

내부적으로는 이렇게 Iterator 패턴을 통해 구현이 되어있기 때문입니다.

Sequence 프로토콜을 채택하면 makeIterator 메서드를 통해 iterator를 얻을 수 있도록 구현할 수 있고, IteratorProtocol을 채택해 next() 메서드를 구현하면 다음 요소를 얻을 수 있는 구현을 제공할 수 있죠. 

 

이렇게 해서 Iterator 패턴을 공부해보았습니다. Swift에서는 기본적으로 모든 컬렉션에 Iterator가 제공되기 때문에 직접 구현할 일은 많지 않겠지만, 왜 Iterator 패턴이 필요한지, 어떤 점에서 유용한 지 조금은 알게 된 것 같아요. 

 

오늘도 읽어주셔서 감사합니다!