设计模式之访问者模式（Visitor Pattern）

What:

提供一个作用于某对象结构中的各元素的操作表示，它使得可以在不改变各元素的类的前提下定义作用于这些元素的新操作。

Why:

优点：

1.各角色职责分离，符合单一职责原则。
2.扩展性好，如果需要新增操作方式，只需要在具体访问者增加方法，灵活性高。
3.使得数据结构和作用于结构上的操作解耦，使得操作集合可以独立变化。

缺点：

1.具体元素对访问者公布细节，违反了迪米特原则。
2.增加新的元素类很困难，需要在每一个访问者类中增加相应访问操作代码，违背开闭原则。
3.访问者类visit方法参数为类对象，违背了依赖倒置转原则，应该面向接口编程而不是类。

Where:

1.对象结构中对象对应的类很少改变，但经常需要在此对象结构上定义新的操作。
2.需要对一个对象结构中的对象进行很多不同的并且不相关的操作，而需要避免让这些操作"污染"这些对象的类，也不希望在增加新操作时修改这些类。

How:

访问者模式有以下几个角色：

抽象访问者（Visitor）角色： 定义一个访问具体元素的接口，为每个具体元素类对应一个访问操作 visit() ，该操作中的参数类型标识了被访问的具体元素。

具体访问者（ConcreteVisitor）角色： 实现抽象访问者角色中声明的各个访问操作，确定访问者访问一个元素时该做什么。

抽象元素（Element）角色： 声明一个包含接受操作 accept() 的接口，被接受的访问者对象作为 accept() 方法的参数。

具体元素（ConcreteElement）角色： 实现抽象元素角色提供的 accept() 操作，其方法体通常都是 visitor.visit(this) ，另外具体元素中可能还包含本身业务逻辑的相关操作。

对象结构（Object Structure）角色： 是一个包含元素角色的容器，提供让访问者对象遍历容器中的所有元素的方法，通常由 List、Set、Map 等聚合类实现。

Staff（抽象元素角色）：

public interface Staff {
    void accept(Department department);
}

Manager、Engineer（具体元素角色）：

public class Engineer implements Staff {

    private String staffName;

    private double workTime;

    public Engineer(String staffName) {
        this.staffName = staffName;
    }


    @Override
    public void accept(Department department) {
        department.visit(this);
    }

    //省略get、set方法
}

public class Manager implements Staff {

    private String staffName;

    private double workTime;

    public Manager(String staffName) {
        this.staffName = staffName;
    }


    @Override
    public void accept(Department department) {
        department.visit(this);
    }

    //省略get、set方法
}

Department（抽象访问者角色）：

public interface Department {
    void visit(Engineer engineer);

    void visit(Manager manager);
}

AccountingDepartment、PersonnelDepartment（具体访问者角色）：

public class AccountingDepartment implements Department{
    private final double MANAGER_DAILY_SALARY = 1000D;

    private final double ENGINEER_DAILY_SALARY = 500D;

    @Override
    public void visit(Engineer engineer) {
        System.out.println(engineer.getStaffName() + " 工程师，月薪为：" + engineer.getWorkTime() * ENGINEER_DAILY_SALARY);
    }

    @Override
    public void visit(Manager manager) {
        System.out.println(manager.getStaffName() + " 经理，月薪为：" + manager.getWorkTime() * MANAGER_DAILY_SALARY);
    }
}
public class PersonnelDepartment implements Department {
    @Override
    public void visit(Engineer engineer) {
        engineer.setWorkTime(workTime());
        System.out.println(engineer.getStaffName() + " 工程师，上个月工作天数为：" + workTime());
    }

    @Override
    public void visit(Manager manager) {
        manager.setWorkTime(workTime());
        System.out.println(manager.getStaffName() + " 经理，上个月工作天数为：" + workTime());
    }

    //默认所有人都工作22天
    double workTime(){
        return 22;
    }
}

StaffContainer（对象结构角色）：

public class StaffContainer {
    private List<Staff> list = new ArrayList<>();

    public void addStaff(Staff staff){
        list.add(staff);
    }
    
    public void accept(Department department){
        Iterator<Staff> it = list.iterator();
        while(it.hasNext()){
            Staff staff = it.next();
            staff.accept(department);
        }
    }
}

Test:测试类

public class Test {
    public static void main(String[] args) {
        Staff engineer = new Engineer("Marry");
        Staff manager = new Manager("Tim");
        Department personnelDepartment = new PersonnelDepartment();
        Department accountingDepartment = new AccountingDepartment();
        StaffContainer container = new StaffContainer();
        container.addStaff(engineer);
        container.addStaff(manager);
        System.out.println("----------人事部统计员工上班天数----------");
        container.accept(personnelDepartment);
        System.out.println("----------财务部计算员工工资----------");
        container.accept(accountingDepartment);
    }
}

输出结果：

----------人事部统计员工上班天数----------
Marry 工程师，上个月工作天数为：22.0
Tim 经理，上个月工作天数为：22.0
----------财务部计算员工工资----------
Marry 工程师，月薪为：11000.0
Tim 经理，月薪为：22000.0

总结

《设计模式》的作者评价为：大多情况下，你不需要使用访问者模式，但是一旦需要使用它时，那就真的需要使用了。我们应该慎用访问者模式，因为使用不当会导致系统复杂度增加，维护难度加大。使用访问者模式的时候应该考虑对象的结构是否稳定，而对象结构是否经常被定义新的操作。

了解更多设计模式：

设计模式系列

参考资料:

http://c.biancheng.net/view/1397.html

https://www.runoob.com/design-pattern/visitor-pattern.html