设计模式之Visitor

设计模式之Visitor
板桥里人 http://www.jdon.com 2002/05/05（转载请保留）


Visitor访问者模式定义
作用于某个对象群中各个对象的操作. 它可以使你在不改变这些对象本身的情况下,定义作用于这些对象的新操作.

在Java中,Visitor模式实际上是分离了collection结构中的元素和对这些元素进行操作的行为.

为何使用Visitor?
Java的Collection(包括Vector和Hashtable)是我们最经常使用的技术,可是Collection好象是个黑色大染缸,本来有各种鲜明类型特征的对象一旦放入后,再取出时,这些类型就消失了.那么我们势必要用If来判断,如:

Iterator iterator = collection.iterator()
while (iterator.hasNext()) {
　　 Object o = iterator.next();
　　 if (o instanceof Collection)
　　 　　 messyPrintCollection((Collection)o);
　　 else if (o instanceof String)
　　 　　 System.out.println("'"+o.toString()+"'");
　　 else if (o instanceof Float)
　　 　　 System.out.println(o.toString()+"f");
　　 else
　　 　　 System.out.println(o.toString());
}
在上例中,我们使用了 instanceof来判断 o的类型.

很显然,这样做的缺点代码If else if 很繁琐.我们就可以使用Visitor模式解决它.


如何使用Visitor?
针对上例,定义接口叫Visitable,用来定义一个Accept操作,也就是说让Collection每个元素具备可访问性.

被访问者是我们Collection的每个元素Element,我们要为这些Element定义一个可以接受访问的接口(访问和被访问是互动的,只有访问者,被访问者如果表示不欢迎,访问者就不能访问),取名为Visitable，也可取名为Element。

public interface Visitable
{
　　 public void accept(Visitor visitor);
}

被访问的具体元素继承这个新的接口Visitable：

public class StringElement implements Visitable
{
　　 private String value;
　　 public StringElement(String string) {
　　 　　 value = string;
　　 }

　　 public String getValue(){
　　 　　 return value;
　　 }

　　 //定义accept的具体内容 这里是很简单的一句调用
　　 public void accept(Visitor visitor) {
　　 　　 visitor.visitString(this);
　　 }
}


上面是被访问者是字符串类型，下面再建立一个Float类型的：

public class FloatElement implements Visitable
{
　　 private Float value;
　　 public FloatElement(Float value) {
　　 　　 this.value = value;
　　 }

　　 public Float getValue(){
　　 　　 return value;
　　 }

　　 //定义accept的具体内容 这里是很简单的一句调用
　　 public void accept(Visitor visitor) {
　　 　　 visitor.visitFloat(this);
　　 }
}


我们设计一个接口visitor访问者，在这个接口中,有一些访问操作，这些访问操作是专门访问对象集合Collection中有可能的所有类，目前我们假定有三个行为：访问对象集合中的字符串类型；访问对象集合中的Float类型；访问对象集合中的对象集合类型。注意最后一个类型是集合嵌套，通过这个嵌套实现可以看出使用访问模式的一个优点。

接口visitor访问者如下：

public interface Visitor
{

　　 public void visitString(StringElement stringE);
　　 public void visitFloat(FloatElement floatE);
　　 public void visitCollection(Collection collection);

}


访问者的实现:

public class ConcreteVisitor implements Visitor
{
　　 //在本方法中,我们实现了对Collection的元素的成功访问
　　 public void visitCollection(Collection collection) {
　　 　　 Iterator iterator = collection.iterator()
　　 　　 while (iterator.hasNext()) {
　　 　　 　　 Object o = iterator.next();
　　 　　 　　 if (o instanceof Visitable)
　　 　　 　　 　　 ((Visitable)o).accept(this);
　　 　　 }
　　 ｝

　　 public void visitString(StringElement stringE) {
　　 　　 System.out.println("'"+stringE.getValue()+"'");
　　 }
　　 public void visitFloat(FloatElement floatE){
　　 　　 System.out.println(floatE.getValue().toString()+"f");
　　 }

}


在上面的visitCollection我们实现了对Collection每个元素访问,只使用了一个判断语句,只要判断其是否可以访问.

StringElement只是一个实现，可以拓展为更多的实现，整个核心奥妙在accept方法中，在遍历Collection时，通过相应的accept方法调用具体类型的被访问者。这一步确定了被访问者类型，

如果是StringElement，而StringElement则回调访问者的visiteString方法，这一步实现了行为操作方法。


客户端代码：

Visitor visitor = new ConcreteVisitor();

StringElement stringE = new StringElement("I am a String");
visitor.visitString(stringE);

Collection list = new ArrayList();
list.add(new StringElement("I am a String1"));
list.add(new StringElement("I am a String2"));
list.add(new FloatElement(new Float(12)));
list.add(new StringElement("I am a String3"));
visitor.visitCollection(list);


客户端代码中的list对象集合中放置了多种数据类型，对对象集合中的访问不必象一开始那样，使用instance of逐个判断，而是通过访问者模式巧妙实现了。

至此,我们完成了Visitor模式基本结构.


使用Visitor模式的前提
使用访问者模式是对象群结构中(Collection) 中的对象类型很少改变。

在两个接口Visitor和Visitable中,确保Visitable很少变化,也就是说，确保不能老有新的Element元素类型加进来，可以变化的是访问者行为或操作，也就是Visitor的不同子类可以有多种,这样使用访问者模式最方便.

如果对象集合中的对象集合经常有变化, 那么不但Visitor实现要变化，Visistable也要增加相应行为，GOF建议是,不如在这些对象类中直接逐个定义操作，无需使用访问者设计模式。

但是在Java中，Java的Reflect技术解决了这个问题，因此结合reflect反射机制，可以使得访问者模式适用范围更广了。

Reflect技术是在运行期间动态获取对象类型和方法的一种技术,具体实现参考Javaworld的英文原文 .