iOS 设计模式之十七（迭代器模式）

一、概念

1、迭代器模式的动机

​ 平时我们经常使用for循环直接对数据进行遍历，但是如何对外提供遍历的接口呢，同时也不暴露自己的私有属性。这个时候迭代器模式就很有用处了，本文将介绍迭代器模式的设计。

2、迭代器模式的定义

​ 迭代器模式（Iterator Pattern）：提供一种方法来访问聚合对象，而不用暴露这个对象的内部表示，其别名为游标 (Cursor)。迭代器模式是一种对象行为型模式。

3、迭代器模式的4个角色

1）Iterator（抽象迭代器）：它定义了访问和遍历元素的接口，声明了用于遍历数据元素的方法，例如：用于获取第一个元素的first()方法，用于访问下一个元素的next()方法，用于判断是否还有下一个元素的hasNext()方法，用于获取当前元素的currentItem()方法等，在具体迭代器中将实现这些方法。

2）ConcreteIterator（具体迭代器）：它实现了抽象迭代器接口，完成对聚合对象的遍历，同时在具体迭代器中通过游标来记录在聚合对象中所处的当前位置，在具体实现时，游标通常是一个表示位置的非负整数。

3）Aggregate（抽象聚合类）：它用于存储和管理元素对象，声明一个createIterator()方法用于创建一个迭代器对象，充当抽象迭代器工厂角色。

4）ConcreteAggregate（具体聚合类）：它实现了在抽象聚合类中声明的createIterator()方法，该方法返回一个与该具体聚合类对应的具体迭代器ConcreteIterator实例。

​ 在迭代器模式结构中包含聚合和迭代器两个层次结构，考虑到系统的灵活性和可扩展性，在迭代器模式中应用了工厂方法模式。

4、结构图

迭代器模式

二、示例

1）先创建一个AbstractIterator协议，里面有一些迭代器的方法，表示抽象迭代器；

2）然后创建ProductIterator类，有一个初始化方法，遵循AbstractIterator协议，表示具体迭代器；

3）然后创建AbstractObjectList类，声明了创建迭代器方法createIterator()，表示抽象聚合类；

4）最后创建ProductList类，继承自AbstractObjectList，并实现createIterator()方法，表示具体聚合类。

具体代码如下：

AbstractIterator协议：

@protocol AbstractIterator <NSObject>
- (void)next;
- (BOOL)isLast;
- (id)getCurrentItem;
@end

typedef id<AbstractIterator> AbstractIterator;

ProductIterator类：

// 商品迭代器：具体迭代器
@interface ProductIterator : NSObject<AbstractIterator>
- (instancetype)initWithProductList:(ProductList *)list;
@end

@interface ProductIterator ()
@property(nonatomic, strong) NSArray *objects;
@property(nonatomic, assign) NSInteger index;
@end
@implementation ProductIterator
- (instancetype)initWithProductList:(ProductList *)list {
    self = [super init];
    if (self) {
        _objects = [list getObjects];
        _index = 0;
    }
    return self;
}

- (void)next {
    if (self.index < self.objects.count) {
        self.index ++;
    }
}

- (BOOL)isLast {
    return (self.index == self.objects.count);
}

- (id)getCurrentItem {
    return self.objects[self.index];
}
@end

AbstractObjectList类：

// 抽象聚合类
@interface AbstractObjectList : NSObject
- (void)addObject:(id)object;
- (void)removeObject:(id)object;
- (NSArray *)getObjects;
// 声明创建迭代器对象的抽象工厂方法
- (AbstractIterator)createIterator;
@end

@interface AbstractObjectList ()
@property(nonatomic, strong) NSMutableArray *objects;
@end
@implementation AbstractObjectList
- (instancetype)init
{
    self = [super init];
    if (self) {
        _objects = [NSMutableArray array];
    }
    return self;
}

- (void)addObject:(id)object {
    [self.objects addObject:object];
}

- (void)removeObject:(id)object {
    [self.objects removeObject:object];
}

- (NSArray *)getObjects {
    return self.objects;
}

- (AbstractIterator)createIterator {
    return nil;
}
@end

ProductList类：

// 商品数据类：具体聚合类
@interface ProductList : AbstractObjectList
@end

@implementation ProductList
- (AbstractIterator)createIterator {
    return [[ProductIterator alloc] initWithProductList:self];
}
@end

运行代码：

- (void)viewDidLoad {
    [super viewDidLoad];
    
    ProductList *products = [ProductList new];
    [products addObject:@"苹果"];
    [products addObject:@"香蕉"];
    [products addObject:@"橘子"];

    AbstractIterator iterator = [products createIterator];
    while (![iterator isLast]) {
        NSLog(@"%@", [iterator getCurrentItem]);
        [iterator next];
    }
}

打印结果：

苹果
香蕉
橘子

三、总结

​ 迭代器模式是一种使用频率非常高的设计模式，通过引入迭代器可以将数据的遍历功能从聚合对象中分离出来，聚合对象只负责存储数据，而遍历数据由迭代器来完成。

1、优点

1、它支持以不同的方式遍历一个聚合对象，在同一个聚合对象上可以定义多种遍历方式。在迭代器模式中只需要用一个不同的迭代器来替换原有迭代器即可改变遍历算法，我们也可以自己定义迭代器的子类以支持新的遍历方式。

2、迭代器简化了聚合类。由于引入了迭代器，在原有的聚合对象中不需要再自行提供数据遍历等方法，这样可以简化聚合类的设计。

3、 在迭代器模式中，由于引入了抽象层，增加新的聚合类和迭代器类都很方便，无须修改原有代码，满足“开闭原则”的要求。

2、缺点

1、由于迭代器模式将存储数据和遍历数据的职责分离，增加新的聚合类需要对应增加新的迭代器类，类的个数成对增加，这在一定程度上增加了系统的复杂性。

2、抽象迭代器的设计难度较大，需要充分考虑到系统将来的扩展，例如JDK内置迭代器Iterator就无法实现逆向遍历，如果需要实现逆向遍历，只能通过其子类ListIterator等来实现，而ListIterator迭代器无法用于操作Set类型的聚合对象。在自定义迭代器时，创建一个考虑全面的抽象迭代器并不是件很容易的事情。

3、适用场景

1、访问一个聚合对象的内容而无须暴露它的内部表示。将聚合对象的访问与内部数据的存储分离，使得访问聚合对象时无须了解其内部实现细节。

2、需要为一个聚合对象提供多种遍历方式。

3、为遍历不同的聚合结构提供一个统一的接口，在该接口的实现类中为不同的聚合结构提供不同的遍历方式，而客户端可以一致性地操作该接口。

4、iOS应用举例

​ 这里介绍在Cocoa Touch框架中的四种迭代器模式，当然在iOS中枚举器就是迭代器😄。

1）NSEnumerator：从iOS 2.0开始，可以使用NSEnumerator来枚举NSArray、NSDictionary和NSSet对象中的元素。常见用法如下：

- (void)viewDidLoad {
    [super viewDidLoad];
    
    NSMutableArray *arr = [NSMutableArray array];
    [arr addObject:@"苹果"];
    [arr addObject:@"香蕉"];
    [arr addObject:@"橘子"];
    
    NSEnumerator *iterator = [arr objectEnumerator];
    id fruit;
    while (fruit = [iterator nextObject]) {
        NSLog(@"%@", fruit);
    }
}

2）Block-Based Enumeration（块的枚举）：从iOS 4.0开始，可以使用block的枚举来遍历集合对象中的元素。常见用法如下：

- (void)viewDidLoad {
    [super viewDidLoad];
    
    NSMutableArray *arr = [NSMutableArray array];
    [arr addObject:@"苹果"];
    [arr addObject:@"香蕉"];
    [arr addObject:@"橘子"];
    
    [arr enumerateObjectsUsingBlock:^(id  _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {
        NSString *str = (NSString *)obj;
        NSLog(@"%@", str);
        if ([str isEqualToString:@"香蕉"]) {
            *stop = YES; // 提前停止枚举
        }
    }];
}

3）快速枚举：Objective-C 2.0提供一种枚举，称为快速枚举，它是苹果公司推荐的枚举方法。快速枚举不需要使用其他枚举器对象，而且比传统的基于索引的for循环效率更高。常见用法如下：

- (void)viewDidLoad {
    [super viewDidLoad];
    
    NSMutableArray *arr = [NSMutableArray array];
    [arr addObject:@"苹果"];
    [arr addObject:@"香蕉"];
    [arr addObject:@"橘子"];
    
    for (NSString *str in arr) {
        NSLog(@"%@", str);
    }
}

4）内部枚举：NSArray有个实例方法(void)makeObjectsPerformSelector:(SEL)aSelector，它允许客户端向数组中的每个元素发送一个消息，让每个元素执行指定的选择器aSelector。常见用法如下：

- (void)viewDidLoad {
    [super viewDidLoad];
    
    NSMutableArray *arr = [NSMutableArray array];
    [arr addObject:[UIView new]];
    [arr addObject:[UIView new]];
    [arr makeObjectsPerformSelector:@selector(removeFromSuperview)];
}

Demo地址：iOS-Design-Patterns