Посетитель

Паттерны проектирования / Поведенческие паттерны
image

@class Engine, Wheel, Car;

//Visitor
//There is no overloading by parameter type in Objective-C:
//every visit has its own selector, and the element itself
//picks the right one in accept
@protocol CarVisitor <NSObject>
- (void)visitEngine:(Engine *)engine;
- (void)visitWheel:(Wheel *)wheel;
- (void)visitCar:(Car *)car;
@end

@protocol Element <NSObject>
- (void)accept:(id<CarVisitor>)v;
@end

//ConcreteElement
@interface Engine : NSObject <Element>
@end

@implementation Engine
- (void)accept:(id<CarVisitor>)v {
    [v visitEngine:self];
}
@end

//ConcreteElement
@interface Wheel : NSObject <Element>
@property (nonatomic, readonly) NSInteger number;

- (instancetype)initWithNumber:(NSInteger)number;
@end

@implementation Wheel

- (instancetype)initWithNumber:(NSInteger)number {
    self = [super init];
    if (self) {
        _number = number;
    }
    return self;
}

- (void)accept:(id<CarVisitor>)v {
    [v visitWheel:self];
}
@end

//ConcreteElement
@interface Car : NSObject <Element>
@property (nonatomic, strong, readonly) NSArray<id<Element>> *items;
@end

@implementation Car

- (instancetype)init {
    self = [super init];
    if (self) {
        _items = @[[[Engine alloc] init],
                   [[Wheel alloc] initWithNumber:1],
                   [[Wheel alloc] initWithNumber:2],
                   [[Wheel alloc] initWithNumber:3],
                   [[Wheel alloc] initWithNumber:4]];
    }
    return self;
}

- (void)accept:(id<CarVisitor>)v {
    for (id<Element> e in self.items) {
        [e accept:v];
    }
    [v visitCar:self];
}
@end

//ConcreteVisitor
@interface TestCarVisitor : NSObject <CarVisitor>
@end

@implementation TestCarVisitor

- (void)visitEngine:(Engine *)engine {
    NSLog(@"test engine");
}

- (void)visitWheel:(Wheel *)wheel {
    NSLog(@"test wheel #%ld", (long)wheel.number);
}

- (void)visitCar:(Car *)car {
    NSLog(@"test car");
}
@end

//ConcreteVisitor
@interface RepairCarVisitor : NSObject <CarVisitor>
@end

@implementation RepairCarVisitor

- (void)visitEngine:(Engine *)engine {
    NSLog(@"repair engine");
}

- (void)visitWheel:(Wheel *)wheel {
    NSLog(@"repair wheel #%ld", (long)wheel.number);
}

- (void)visitCar:(Car *)car {
    NSLog(@"repair car");
}
@end

//Client
Car *car = [[Car alloc] init];
TestCarVisitor *v1 = [[TestCarVisitor alloc] init];
RepairCarVisitor *v2 = [[RepairCarVisitor alloc] init];

[car accept:v1];
[car accept:v2];


Представляет операцию, которую надо выполнить над элементами объекта. Позволяет определить новую операцию, не меняя классы элементов, к которым он применяется.
Read more

Задача. Документ состоит из абзацев, картинок и таблиц. Программа должна выгружать его, считать в нём слова и проверять орфографию. Если каждую операцию добавлять методом в каждый вид части, классы частей растут с каждой новой операцией. К тому же код одной операции расползается по многим классам.

Идея. Каждая операция становится отдельным объектом - посетителем. У посетителя по методу на каждый вид элемента. У каждого элемента есть один метод, который принимает посетителя и вызывает его метод для своего вида. Так для каждой пары «элемент и операция» выполняется нужный код, без проверок типа. Чтобы добавить новую операцию, пишут нового посетителя, а классы элементов не меняются.

Как читать пример. Элементы бывают нескольких видов. Каждый конкретный посетитель - одна операция, с отдельным методом на каждый вид элемента. Клиентский код отдаёт посетителя элементам, и каждый элемент направляет его в метод для своего вида. В большинстве примеров один элемент содержит остальные и отдаёт посетителя каждой своей части. Затем два посетителя проходят по одним и тем же частям, каждый со своей операцией. В некоторых языках элементы - обычные данные с меткой типа, а посетитель - одна функция с вариантом для каждого вида.

Когда применять. Посетитель нужен, когда набор классов элементов устойчив, а новые операции над ними появляются часто. Если часто добавляются новые виды элементов, он не годится: каждый новый вид требует нового метода в каждом посетителе.

Частая ошибка. Проверять тип элемента условиями внутри одного общего метода посетителя. Тогда новый вид элемента пропускается без всякого предупреждения. У каждого вида должен быть свой метод.