图解设计模式--Visitor(访问者)模式

访问数据结构并处理数据

Visitor 模式

将数据结构和处理分离开。编写一个表示“访问者”的类来访问数据结构中的元素，并把对各元素的处理交给访问者类。

示例程序

名字	说明	角色
Visitor	表示访问者的抽象类，它访问文件和文件夹	Visitor
Element	表示数据结构的接口，它接受访问者的访问	Element
ListVisitor	Visitor 的子类，显示文件和文件夹一览	ConcreteVisitor
Entry	File 类和 Directory 类的父类，它是抽象类（实现了Element接口）
File	表示文件的类	ConcreteElement
Directory	表示文件夹的类	ConcreteElement,ObjectStructure
FileTreatmentException	表示向文件中 add 时发生的异常的类
Main	测试程序行为的类

Visitor.java

package visitor;

public abstract class Visitor {
    public abstract void visit(File file);
    public abstract void visit(Directory directory);
}

Element.java

package visitor;

public interface Element {
    public abstract void accept(Visitor v);
}

ListVisitor.java

package visitor;

import java.util.Iterator;

public class ListVisitor extends Visitor {
    private String currentdir = "";
    public void visit(File file) {
        System.out.println(currentdir + "/" + file);
    }
    public void visit(Directory directory) {
        System.out.println(currentdir + "/" + directory);
        String savedir = currentdir;
        currentdir = currentdir + "/" + directory.getName();
        Iterator it = directory.iterator();
        while (it.hasNext()) {
            Entry entry = (Entry)it.next();
            entry.accept(this);
        }
        currentdir = savedir;
    }
}

Entry.java

package visitor;

import java.util.Iterator;

public abstract class Entry implements Element {
    public abstract String getName();
    public abstract int getSize();
    public Entry add(Entry entry) throws FileTreatmentException{
        throw new FileTreatmentException();
    }
    public Iterator iterator() throws FileTreatmentException{
        throw new FileTreatmentException();
    }
    public String toString() {
        return getName() + "(" + getSize() + ")";
    }
}

File.java

package visitor;

public class File extends Entry {
    private String name;
    private int size;
    public File(String name, int size) {
        this.name = name;
        this.size = size;
    }
    public String getName() {
        return name;
    }
    public int getSize() {
        return size;
    }
    public void accept(Visitor v) {
        v.visit(this);
    }
}

Directory.java

package visitor;

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

public class Directory extends Entry {
    private String name;
    private ArrayList dir = new ArrayList();
    public Directory(String name) {
        this.name = name;
    }
    public String getName() {
        return name;
    }
    public int getSize() {
        int size = 0;
        Iterator it = dir.iterator();
        while (it.hasNext()) {
            Entry entry = (Entry)it.next();
            size += entry.getSize();
        }
        return size;
    }
    public Entry add(Entry entry) {
        dir.add(entry);
        return this;
    }
    public Iterator iterator() {
        return dir.iterator();
    }
    public void accept(Visitor v) {
        v.visit(this);
    }
}

FileTreatmentException.java

package visitor;

public class FileTreatmentException extends RuntimeException {
    public FileTreatmentException(){}
    public FileTreatmentException(String msg){
        super(msg);
    }
}

Main.java

package visitor;

public class Main {
    public static void main(String[] args) {
        try {
            System.out.println("Making root entries...");
            Directory rootdir = new Directory("root");
            Directory bindir = new Directory("root");
            Directory tmpdir = new Directory("root");
            Directory usrdir = new Directory("root");
            rootdir.add(bindir);
            rootdir.add(tmpdir);
            rootdir.add(usrdir);
            bindir.add(new File("vi", 10000));
            bindir.add(new File("latex", 20000));
            rootdir.accept(new ListVisitor());

            System.out.println("");
            System.out.println("Making user entries...");
            Directory yuki = new Directory("yuki");
            Directory hanako = new Directory("hanako");
            Directory tomura = new Directory("tomura");
            usrdir.add(yuki);
            usrdir.add(hanako);
            usrdir.add(tomura);
            yuki.add(new File("diary.html", 100));
            yuki.add(new File("Composite.java", 100));
            hanako.add(new File("memo.tex", 300));
            tomura.add(new File("game.doc", 400));
            tomura.add(new File("junk.mail", 500));

            rootdir.accept(new ListVisitor());
        } catch (FileTreatmentException e) {
            e.printStackTrace();
        }
    }
}

Visitor 模式中的角色

1. Visitor(访问者)

   Visitor 角色负责对数据结构中每个具体的元素(ConcreteElement角色)声明一个用于访问 XXXX 的 visit(xxxx) 方法。visit(xxxx) 是用于处理 XXXX 的方法，负责实现该方法的是 ConcreteVisitor。

2. ConcreteVisitor(具体的访问者)

   ConcreteVisitor 角色负责实现 Visitor 角色定义的接口。它要实现所有的 visit(xxxx) 方法，即实现如何处理每个 ConcreteElement 角色。

3. Element(元素)

   Element 角色表示 Visitor 角色的访问对象。它声明了接受访问者的 accept 方法。accept 方法接收到的参数是 Visitor 角色。

4. ConcreteElement(具体的元素)

   ConcreteElement 角色负责实现 Element 角色所定义的接口。

5. ObjectStructure(对象结构)

   ObjectStructure 角色负责处理 Element 角色的集合。ConcreteVisitor 角色为每个 Element 角色都准备了处理方法。

拓展思路

一、双重分发

在该模式中，element 接受 visitor(element.accept(visitor)，而 visitor 又访问 element(visitor.visit(element)。

在 Visitor 模式中，ConcreteVisitor 和 ConcreteElement 这两个角色共同决定了实际进行的处理。这种消息分发的方式一般被称为双重分发。

二、开闭原值 —— 对扩展开放，对修改关闭

三、易于增加 ConcreteVisitor 角色，难以增加 ConcreteElement 角色。