[Design Pattern] 방문자 패턴(Visitor Pattern)

visitor 는 어떤 장소에 방문하는 사람이라는 의미로 방문자가 특정 공간에 방문할 때, 적절한 행동을 취한다.
GoF(Gang of Four) Design Pattern 에서 행위(behavioral) 패턴에 속한다.

일반적으로 OOP 에서 객체는 스스로 일을 하도록 한다.
하지만, 그 행위를 분리하여 외부로 분리하는 다양한 패턴들이 존재하는데 비지터 패턴이 그중 하나이다.

방문자 패턴을 이용하여 데이터 구조와 처리를 분리하게 되면, 구조를 변경하지 않아도 새로운 연산을 추가할 수 있다.
즉, 비지터 패턴은 개방-페쇄 원칙을 적용하는 방법중에 하나인 것이다.

알고리즘이 너무 복잡해지거나 자료구조가 너무 많아져서 분리가 필요한 경우,
같은 자료구조에 알고리즘이 자주 변경되는 경우에 비지터 패턴을 유용하게 사용할 수 있다.

구조

방문자 패턴은 기존의 객체인 element 와 visitor 로 나눠지게 된다.
Visitor 인터페이스에는 Element 의 구현체 종류별로 메소드가 존재한다.
그러므로 visitor 를 구현하는 구현체들은 각 element 들을 위한 메소드들을 구현해야 한다.

Visitor
- 방문자 클래스의 인터페이스
- object 구조내의 ConcreteElement 만큼 visit operation 선언
- visit(Element) 를 공용 인터페이스로 사용
ConcreteVisitor
- 실제 알고리즘을 가지고 있는 구현체
Element
- 방문 공간 클래스의 인터페이스
- Visitor 가 방문하여 수행해야할 대상 (Visitor.visit(this) 호출)
- 방문자들을 수용할 수 있는 accept(Visitor) 를 공용 인터페이스로 사용
ConcreteElement
- Element 의 구현체
ObjectStructure
- Element 를 가지고 있는 객체 구조
- 보통 Set, List, CompositeComponent 가 그 역할

장점

방문하는 대상(Element)과 작업하는 대상(Visitor) 을 분리한다.
- 데이터만 담고 있는 자료구조를 만들 수 있음
- 작업하는 대상은 visit() 안에 대상을 받아 처리만 하면 됨
- 데이터와 알고리즘이 분리되어, 데이터의 독립성 향상

단점

새로운 방문 대상이 추가되면 모든 작업 대상(Visitor)들의 메소드를 추가해야 함
Element 와 Visitor의 양방향 참조로 결합도가 매우 높음

구현

Visitor

방문자 인터페이스는 다음과 같다.
Element 의 구현체만큼 메소드가 존재한다.

public interface CarElementVisitor {
    String visit(Wheel wheel);
    String visit(Engine engine);
    String visit(Body body);
    String visit(Car car);
}

방문자의 구현체는 본인의 목적에 맞게 메소드를 구현하면 된다.

public class CarElementPrintVisitor implements CarElementVisitor {

    @Override
    public String visit(Wheel wheel) {
        return wheel.name() + " 바퀴입니다.";
    }
    @Override
    public String visit(Engine engine) {
        return engine.name() + " 엔진입니다.";

    }
    @Override
    public String visit(Body body) {
        return body.name() + " 몸체입니다.";
    }
    @Override
    public String visit(Car car) {
        return car.name() + " 자동차입니다.";
    }
}

Element

방문 공간인 Element 의 인터페이스는 다음과 같다.
방문자를 받을 수 있는 한 개의 메소드가 존재한다.

public interface CarElement {
    String accept(CarElementVisitor visitor);
} 

방문 공간의 구현체들은 방문자를 수용하여
자기 자신의 정보를 가지고 visit() 메소드를 호출해주도록 한다.

public class Engine implements CarElement {

    private final String name;

    public Engine(String name) {
        this.name = name;
    }
    public String name() {
        return name;
    }
    @Override
    public String accept(CarElementVisitor visitor) {
        return visitor.visit(this);
    }
}

public class Wheel implements CarElement {

    private final String name;

    public Wheel(String name) {
        this.name = name;
    }
    public String name() {
        return name;
    }
    @Override
    public String accept(CarElementVisitor visitor) {
        return visitor.visit(this);
    }
}

public class Body implements CarElement {

    private final String name;

    public Body(String name) {
        this.name = name;
    }
    public String name() {
        return name;
    }
    @Override
    public String accept(CarElementVisitor visitor) {
        return visitor.visit(this);
    }
}

Object Structure

Object Structure 는 Element 들을 가지고 있는 역할을 한다.
이 코드에서는 Car 이 자신의 부품들을 가지고 있는 설정이다.

public class Car implements CarElement {

    private final String name;
    private final List<CarElement> elements = new ArrayList<>();

    public Car(String name) {
        this.name = name;
        elements.add(new Wheel("왼쪽"));
        elements.add(new Wheel("오른쪽"));
        elements.add(new Body("고철"));
        elements.add(new Engine("전기"));
    }
    public String name() {
        return name;
    }
    @Override
    public String accept(CarElementVisitor visitor) {
        StringBuilder sb = new StringBuilder();
        sb.append(visitor.visit(this));
        for (CarElement element : elements) {
            sb.append("\n");
            sb.append(element.accept(visitor));
        }
        return sb.toString();
    }
}

전체 코드는 깃허브 레포지토리 참고

Review

비지터 패턴은 자료구조와 처리하는 로직을 분리하는 패턴이다.
하지만 양방향 의존성을 가지기 때문에 결합도가 매우 높고 Element 구현체의 갯수만큼 Visitor 메소드가 추가되기 때문에 수정도 어렵다. 이렇게 단점들이 분명하기 때문에 어떤 상황에서 비지터 패턴을 사용해야할지 잘 모르겠다.

출처

https://dailyheumsi.tistory.com/216
https://thecodinglog.github.io/design/2019/10/29/visitor-pattern.html