访问者模式 Visitor Pattern

一、模式介绍

1.1、定义

将作用于某种数据结构中的各元素的操作分离出来封装成独立的类，使其在不改变数据结构的前提下可以添加作用于这些元素的新的操作，为数据结构中的每个元素提供多种访问方法。它将对数据的操作与数据结构进行分离，是行为模式中最复杂的一种模式。

1.2、优点

1. 扩展性好。能够在不修改对象结构中的元素的情况下，为对象结构中的元素添加新的功能
2. 复用性好。可以通过访问者来定义整个对象结构通用的功能，从而提高系统的复用程度
3. 灵活性好。访问者模式将数据结构与作用于结构上的操作解耦，使得操作集合可相对自由地演化，而不影响系统的数据结构
4. 复合单一职责原则。访问者模式把相关的行为封装在一起，构成一个访问者，是每一个访问者的功能都比较单一

1.3、缺点

1. 增加新的元素类很困难。在访问者模式中，每增加一个新的元素类，都要在一个具体访问者类中增加相应的具体操作，违背了开闭原则
2. 破坏封装。访问者模式中具体元素对访问者公布细节，这破坏了对象的封装性
3. 违反了依赖倒置原则。访问者模式依赖了具体类，而没有依赖抽象类

二、结构与实现

2.1、结构

1. 抽象访问者角色（Visitor）：定义一个访问具体元素的接口，为每个具体元素类对应一个访问操作 visit，该操作中的参数类型标识了被访问的具体元素
2. 具体访问者角色（ConcreteVisitor）：实现抽象访问者角色中声明的各个访问操作，确定访问者访问一个元素时该做什么
3. 抽象元素角色（Element）：是一个声明包含接受操作 accept 方法的接口，被接受的访问者对象作为 accept 方法的入参
4. 具体元素角色（ConcreteElement）：实现抽象元素角色提供的 accept 方法，其方法通常都是 visitor.visit(this)，另外具体元素中可能还包含本身业务逻辑的相关操作
5. 对象结构角色（ObjectStructure）：是一个包含元素角色的容器，提供让访问者对象遍历容器中的所有元素的方法，通常由 List、Set、Map 等聚合类实现
   

2.2、实现

2.2.1、Visitor

package com.erlang.visitor;

/**
 * @description: 抽象访问者
 * @author: erlang
 * @since: 2022-02-20 16:07
 */
public interface Visitor {

    /**
     * 访问方法
     *
     * @param e 具体元素1
     */
    void visit(ConcreteElement1 e);

    /**
     * 访问方法
     *
     * @param e 具体元素2
     */
    void visit(ConcreteElement2 e);

}

2.2.2、ConcreteVisitor1

package com.erlang.visitor;

/**
 * @description: 具体访问者 1
 * @author: erlang
 * @since: 2022-02-20 16:13
 */
public class ConcreteVisitor1 implements Visitor {

    @Override
    public void visit(ConcreteElement1 element) {
        System.out.println("具体访问者 1 访问：" + element.operation());
    }

    @Override
    public void visit(ConcreteElement2 element) {
        System.out.println("具体访问者 1 访问：" + element.operation());
    }
}

2.2.3、ConcreteVisitor2

package com.erlang.visitor;

/**
 * @description: 具体访问者 2
 * @author: erlang
 * @since: 2022-02-20 16:13
 */
public class ConcreteVisitor2 implements Visitor {

    @Override
    public void visit(ConcreteElement1 element) {
        System.out.println("具体访问者 2 访问：" + element.operation());
    }

    @Override
    public void visit(ConcreteElement2 element) {
        System.out.println("具体访问者 2 访问：" + element.operation());
    }
}

2.2.4、Element

package com.erlang.visitor;

/**
 * @description: 抽象元素
 * @author: erlang
 * @since: 2022-02-20 16:09
 */
public interface Element {
    /**
     * 访问指定的访问者
     *
     * @param v 访问者
     */
    void accept(Visitor v);
}

2.2.5、ConcreteElement1

package com.erlang.visitor;

/**
 * @description: 具体元素 1
 * @author: erlang
 * @since: 2022-02-20 16:09
 */
public class ConcreteElement1 implements Element {

    @Override
    public void accept(Visitor visitor) {
        visitor.visit(this);
    }

    public String operation() {
        return "具体元素 1 operation 方法";
    }
}

2.2.6、ConcreteElement2

package com.erlang.visitor;

/**
 * @description: 具体元素 2
 * @author: erlang
 * @since: 2022-02-20 16:09
 */
public class ConcreteElement2 implements Element {

    @Override
    public void accept(Visitor visitor) {
        visitor.visit(this);
    }

    public String operation() {
        return "具体元素 2 operation 方法";
    }
}

2.2.7、ObjectStructure

package com.erlang.visitor;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

/**
 * @description: 对象结构角色
 * @author: erlang
 * @since: 2022-02-20 16:12
 */
public class ObjectStructure {

    private List<Element> list = new ArrayList<>();

    public void accept(Visitor visitor) {
        Iterator<Element> i = list.iterator();
        while (i.hasNext()) {
            ((Element) i.next()).accept(visitor);
        }
    }

    public void add(Element element) {
        list.add(element);
    }

    public void remove(Element element) {
        list.remove(element);
    }
}

2.2.8、VisitorClient

package com.erlang.visitor;

/**
 * @description: 访问者客户端测试
 * @author: erlang
 * @since: 2022-02-20 16:15
 */
public class VisitorClient {

    public static void main(String[] args) {
        ObjectStructure os = new ObjectStructure();
        os.add(new ConcreteElement1());
        os.add(new ConcreteElement2());
        Visitor visitor = new ConcreteVisitor1();
        os.accept(visitor);
        System.out.println("------------------------");
        visitor = new ConcreteVisitor2();
        os.accept(visitor);
    }

}

2.2.9、执行结果

具体访问者 1 访问：具体元素 1 operation 方法
具体访问者 1 访问：具体元素 2 operation 方法
------------------------
具体访问者 2 访问：具体元素 1 operation 方法
具体访问者 2 访问：具体元素 2 operation 方法