设计模式（Java）—Visitor模式

在数据结构中保存着许多元素，我们会对这些元素进行“处理”。在Visitor模式中，数据结构与处理被分离开来。我们编写一个表示“访问者”的类来访问数据结构中的元素，并把对各元素的处理交给访问类。这样，当需要增加新的处理时，我们只需要编写新的访问者，然后让数据结构可以接受访问者的访问即可。

示例程序
使用Composite模式中用到的那个文件和文件夹的例子作为访问者要访问者的数据结构，访问者会访问由文件和文件夹构成的数据结构，然后显示出文件和文件夹的一览。

Visitor类
该类是访问者的抽象类。访问者依赖于它所访问的数据结构（即File类和Directory类）。

package Visitor;

//访问者的抽象类
public abstract class Visitor {
	//声明对不同数据结构的处理方法
	public abstract void visit(File file);
	public abstract void visit(Directory directory);
}

类中定义了两个方法，名字都叫做visit，不过它们接受的参数不同，一个接受File类型的参数，另一个接收Directory类型参数，从外部调用visit方法时，程序会根据接受的参数的类型自动选择和执行相应的visit方法，通常我们将这种方法就做重载。

Element类
该接口是接受访问者的访问的接口。

package Visitor;

//数据结构的访问接口，声明数据结构对于访问者的接受方法
public interface Element {
	public abstract void accpet(Visitor v);
}

Entry类
该类实现Element接口。

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类
该类实现接口中的accept方法。

package Visitor;

//具体的实体类，文件类，提供类内数据
public class File extends Entry {

	private String name;
	private int size;
	public File(String name,int size) {
		// TODO Auto-generated constructor stub
		this.name = name;
		this.size = size;
	}
	public String getName(){
		return name;
	}
	public int getSize(){
		return size;
	}
	@Override
	public void accpet(Visitor v) {
		// TODO Auto-generated method stub
		v.visit(this);
		
	}

}

Directory类
该类是表示文件夹的类，实现接口中的accept方法。

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) {
		// TODO Auto-generated constructor stub
		this.name = name;
	}

	@Override
	public void accpet(Visitor v) {
		// TODO Auto-generated method stub
		v.visit(this);

	}

	@Override
	public String getName() {
		// TODO Auto-generated method stub
		return name;
	}

	@Override
	public int getSize() {
		// TODO Auto-generated method stub
		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();
	
    }
}

ListVisitor类
该类是Visitor的子类，它的作用是访问数据结构并显示元素一览，并且实现了visit两个不同参数的方法。

package Visitor;

import java.util.Iterator;

//访问者的具体类，实现对数据结构的处理

public class ListVisitor extends Visitor {
	private String currentdir = "";
    //根据传入参数的不同，对同名方法进行重载
	@Override
	public void visit(File file) {
		// TODO Auto-generated method stub
		System.out.println(currentdir+"/"+file);

	}

	@Override
	public void visit(Directory directory) {
		// TODO Auto-generated method stub
		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.accpet(this);
		}
		currentdir = savedir;

	}

}

accept方法调用visit方法，visit方法又会调用accept方法，这样就形成了非常复杂的递归调用。通常的递归调用是某个方法调用自身，在Visitor模式中，则是accept方法与visit方法之间的互相调用。

FileTreatmentException类

package Visitor;

public class FileTreatmentException extends RuntimeException {
	public FileTreatmentException() {
		// TODO Auto-generated constructor stub
	}
	public FileTreatmentException(String msg){
		super(msg);
	}
}

Main类

package Visitor;

import java.util.Iterator;

public class Main {

	public static void main(String[] args) {
		// TODO Auto-generated method stub
		try {
			System.out.println("Making root entries...");
			Directory rootdir = new Directory("root");
			Directory bindir = new Directory("bin");
			Directory userdir = new Directory("user");
			Directory tmpdir = new Directory("tmp");
			rootdir.add(bindir);
			rootdir.add(tmpdir);
			rootdir.add(userdir);
			bindir.add(new File("vi",10000));
			bindir.add(new File("latex", 20000));
			rootdir.accpet(new ListVisitor());
			
			System.out.println("========");
			Directory yuki = new Directory("yuki");
			Directory hanako = new Directory("hanako");
			Directory tomura = new Directory("tomura");
			userdir.add(yuki);
			userdir.add(hanako);
			userdir.add(tomura);
			yuki.add(new File("diary.html", 100));
			yuki.add(new File("Composite.java",200));
			hanako.add(new File("memo.tex", 300));
			tomura.add(new File("game.doc",400));
			tomura.add(new File("junk.mail",500));
			rootdir.accpet(new ListVisitor());
			
			
			FileFindVisitor ffv  = new FileFindVisitor(".html");
			rootdir.accpet(ffv);
			
			Iterator it = ffv.getFoundFiles();
			while (it.hasNext()) {
				File file =  (File)it.next();
				System.out.println(file.toString());
				
			}
			
		} catch (FileTreatmentException e) {
			// TODO: handle exception
			e.printStackTrace();
		}

	}

}

示例程序的时序图：

Visitor模式的类图

开闭原则——对扩展开放，对修改关闭
对扩展是开放的，对修改时关闭的

在设计类时，若无特殊理由，必须要考虑到将来可能会扩展类，绝不能毫无理由的禁止扩展类。这就是“对扩展开放”的意思。

但是，如果在每次扩展类时都需要修改现有的类就太麻烦了，所以我们需要在不修改现有类的前提下能够扩展类，这就是“对修改时关闭”的意思。

练习
在示例程序中增加一个FileFoundVisitor类，用于将带有指定后缀名的文件汇集起来。
FileFoundVisitor类

package Visitor;

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

public class FileFindVisitor extends Visitor {
	private String type;
	private ArrayList found = new ArrayList();
	public FileFindVisitor(String type) {
		// TODO Auto-generated constructor stub
		this.type = type;
	}
	//返回已找到文件数组的迭代器
	public Iterator getFoundFiles(){
		return found.iterator();
	}
    //如果是文件，则将文件加入数组里
	@Override
	public void visit(File file) {
		// TODO Auto-generated method stub
		if(file.getName().endsWith(type)){
			found.add(file);
		}

	}
    //如果是文件夹，则递归访问，直至访问到文件
	@Override
	public void visit(Directory directory) {
		// TODO Auto-generated method stub
		Iterator it = directory.iterator();
		while(it.hasNext()){
			Entry entry = (Entry)it.next();
			entry.accpet(this);
		}

	}

}