设计模式系列 — 访问者模式

点赞再看，养成习惯，公众号搜一搜【一角钱技术】关注更多原创技术文章。
本文 GitHub org_hejianhui/JavaStudy 已收录，有我的系列文章。

前言

• 23种设计模式速记
• 工厂方法（factory method）模式
• 抽象工厂（abstract factory）模式
• 原型（prototype）模式
• 单例（singleton）模式
• 建造者/构建器（builder）模式
• 适配器（adapter）模式
• 桥接（bridge）模式
• 组合（composite）模式
• 装饰（decorator）模式
• 外观（facade）模式
• 享元（flyweight）模式
• 代理（proxy）模式
• 责任链（chain of responsibility）模式
• 命令（command）模式
• 解释器（interpreter）模式
• 迭代器（iterator）模式
• 中介者（mediator）模式
• 备忘录（memento）模式
• 观察者（observer）模式
• 状态（state）模式
• 策略（strategy）模式
• 模版方法（template method）模式

23种设计模式快速记忆的请看上面第一篇，本篇和大家一起来学习访问者模式相关内容。

这是23种设计模式的最后一个——访问者模式，这个模式确实不怎么好理解，不怎么好用，而且实际中也很少用到这个设计模式。

在现实生活中，有些集合对象中存在多种不同的元素，且每种元素也存在多种不同的访问者和处理方式。例如，公园中存在多个景点，也存在多个游客，不同的游客对同一个景点的评价可能不同；医院医生开的处方单中包含多种药元素，査看它的划价员和药房工作人员对它的处理方式也不同，划价员根据处方单上面的药品名和数量进行划价，药房工作人员根据处方单的内容进行抓药。

这些被处理的数据元素相对稳定而访问方式多种多样的数据结构，如果用“访问者模式”来处理比较方便。访问者模式能把处理方法从数据结构中分离出来，并可以根据需要增加新的处理方法，且不用修改原来的程序代码与数据结构，这提高了程序的扩展性和灵活性。

模式定义

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

访问者（Visitor）模式实现的关键是如何将作用于元素的操作分离出来封装成独立的类

模板实现如下：

package com.niuh.designpattern.visitor.v1;

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

/**
 * <p>
 * 访问者模式
 * </p>
 */
public class VisitorPattern {
    public static void main(String[] args) {
        ObjectStructure os = new ObjectStructure();
        os.add(new ConcreteElementA());
        os.add(new ConcreteElementB());
        Visitor visitor = new ConcreteVisitorA();
        os.accept(visitor);
        System.out.println("=================");
        visitor = new ConcreteVisitorB();
        os.accept(visitor);
    }
}

//抽象访问者
interface Visitor {
    void visit(ConcreteElementA element);

    void visit(ConcreteElementB element);
}

//具体访问者A类
class ConcreteVisitorA implements Visitor {
    public void visit(ConcreteElementA element) {
        System.out.println("具体访问者A访问-->" + element.operationA());
    }

    public void visit(ConcreteElementB element) {
        System.out.println("具体访问者A访问-->" + element.operationB());
    }
}

//具体访问者B类
class ConcreteVisitorB implements Visitor {
    public void visit(ConcreteElementA element) {
        System.out.println("具体访问者B访问-->" + element.operationA());
    }

    public void visit(ConcreteElementB element) {
        System.out.println("具体访问者B访问-->" + element.operationB());
    }
}

//抽象元素类
interface Element {
    void accept(Visitor visitor);
}

//具体元素A类
class ConcreteElementA implements Element {
    public void accept(Visitor visitor) {
        visitor.visit(this);
    }

    public String operationA() {
        return "具体元素A的操作。";
    }
}

//具体元素B类
class ConcreteElementB implements Element {
    public void accept(Visitor visitor) {
        visitor.visit(this);
    }

    public String operationB() {
        return "具体元素B的操作。";
    }
}

//对象结构角色
class ObjectStructure {
    private List<Element> list = new ArrayList<Element>();

    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);
    }
}

输出结果如下：

具体访问者A访问-->具体元素A的操作。
具体访问者A访问-->具体元素B的操作。
=================
具体访问者B访问-->具体元素A的操作。
具体访问者B访问-->具体元素B的操作。

解决的问题

稳定的数据结构和易变的操作耦合问题。

需要对一个对象结构中的对象进行很多不同的并且不相关的操作，而需要避免让这些操作"污染"这些对象的类，使用访问者模式将这些封装到类中。

模式组成

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

实例说明

实例概况

用访问者模式实现一个用户访问博客的场景

分析：用户可以通过电脑上的Web方式（访问者）或者手机APP方式（访问者）去访问博客，每篇博客是一个元素，然后博客列表是一个对象结构类。

使用步骤

步骤1：定义抽象访问者(Visitor)

abstract class Visitor {
    public abstract void visitBlog(Element element);
}

步骤2：定义具体访问者(ConcreteVisitor)，web 和 app两种

//具体访问者(ConcreteVisitor)
class WebVisitor extends Visitor {
    public void visitBlog(Element element) {
        System.out.println("通过电脑web网站方式访问Blog:" + element.blogName);
    }
}

//具体访问者(ConcreteVisitor)
class AppVisitor extends Visitor {
    public void visitBlog(Element element) {
        System.out.println("通过手机App网站方式访问Blog:" + element.blogName);
    }
}

步骤3：定义抽象元素(Element)

//抽象元素(Element)
abstract class Element {
    public String blogName;

    abstract public void accept(Visitor visotr);
}

步骤4：定义具体元素(ConcreteElement)，即博客

//具体元素(ConcreteElement)
class BlogElement extends Element {
    public BlogElement(String blogname) {
        this.blogName = blogname;
    }

    public void accept(Visitor visitor) {
        visitor.visitBlog(this);
    }
}

步骤5：定义对象结构类(ObjectStructure)，即博客列表

//对象结构类(ObjectStructure)
class Blogs {
    private List<Element> blogList = new ArrayList<Element>();

    public void addBlog(Element element) {
        blogList.add(element);
    }

    public void removeBlog(Element element) {
        blogList.remove(element);
    }

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

}

步骤6：测试验证

public class VisitorPattern {
    public static void main(String[] args) {
        Blogs blogs = new Blogs();
        blogs.addBlog(new BlogElement("一角钱技术第一篇博文"));
        blogs.addBlog(new BlogElement("一角钱技术第二篇博文"));
        blogs.addBlog(new BlogElement("一角钱技术第三篇博文"));
        blogs.addBlog(new BlogElement("一角钱技术第四篇博文"));

        Visitor webVisit = new WebVisitor();
        Visitor appVisit = new AppVisitor();

        blogs.accept(webVisit);
        blogs.accept(appVisit);

    }
}

输出结果

通过电脑web网站方式访问Blog:一角钱技术第一篇博文
通过电脑web网站方式访问Blog:一角钱技术第二篇博文
通过电脑web网站方式访问Blog:一角钱技术第三篇博文
通过电脑web网站方式访问Blog:一角钱技术第四篇博文
通过手机App网站方式访问Blog:一角钱技术第一篇博文
通过手机App网站方式访问Blog:一角钱技术第二篇博文
通过手机App网站方式访问Blog:一角钱技术第三篇博文
通过手机App网站方式访问Blog:一角钱技术第四篇博文

优点

访问者（Visitor）模式是一种对象行为型模式，其主要优点如下。

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

缺点

访问者（Visitor）模式的主要缺点如下。

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

应用场景

通常在以下情况可以考虑使用访问者（Visitor）模式。

1. 对象结构相对稳定，但其操作算法经常变化的程序。
2. 对象结构中的对象需要提供多种不同且不相关的操作，而且要避免让这些操作的变化影响对象的结构。
3. 对象结构包含很多类型的对象，希望对这些对象实施一些依赖于其具体类型的操作。

模式的扩展

访问者（Visitor）模式是使用频率较高的一种设计模式，它常常同以下两种设计模式联用。

(1) 与“迭代器模式”联用。因为访问者模式中的“对象结构”是一个包含元素角色的容器，当访问者遍历容器中的所有元素时，常常要用迭代器。如案例中的对象结构是用 List 实现的，它通过 List 对象的 Itemtor() 方法获取迭代器。如果对象结构中的聚合类没有提供迭代器，也可以用迭代器模式自定义一个。

(2) 访问者（Visitor）模式同“组合模式”联用。因为访问者（Visitor）模式中的“元素对象”可能是叶子对象或者是容器对象，如果元素对象包含容器对象，就必须用到组合模式，其结构图如下：

源码中的应用

javax.lang.model.element.Element
javax.lang.model.element.ElementVisitor
javax.lang.model.type.TypeMirror
javax.lang.model.type.TypeVisitor

PS：以上代码提交在 Github ：https://github.com/Niuh-Study/niuh-designpatterns.git

文章持续更新，可以公众号搜一搜「 一角钱技术 」第一时间阅读， 本文 GitHub org_hejianhui/JavaStudy 已经收录，欢迎 Star。