一、 訪(fǎng)問(wèn)者(Visitor)模式
訪(fǎng)問(wèn)者模式的目的是封裝一些施加于某種數據結構元素之上的操作。一旦這些操作需要修改的話(huà),接受這個(gè)操作的數據結構則可以保持不變。
問(wèn)題提出
System.Collection命名空間下提供了大量集合操作對象。但大多數情況下處理的都是同類(lèi)對象的聚集。換言之,在聚集上采取的操作都是一些針對同類(lèi)型對象的同類(lèi)操作。但是如果針對一個(gè)保存有不同類(lèi)型對象的聚集采取某種操作該怎么辦呢?
粗看上去,這似乎不是什么難題??墒侨绻枰槍σ粋€(gè)包含不同類(lèi)型元素的聚集采取某種操作,而操作的細節根據元素的類(lèi)型不同而有所不同時(shí),就會(huì )出現必須對元素類(lèi)型做類(lèi)型判斷的條件轉移語(yǔ)句。這個(gè)時(shí)候,使用訪(fǎng)問(wèn)者模式就是一個(gè)值得考慮的解決方案。
訪(fǎng)問(wèn)者模式
訪(fǎng)問(wèn)者模式適用于數據結構相對未定的系統,它把數據結構和作用于結構上的操作之間的耦合解脫開(kāi),使得操作集合可以相對自由地演化。
數據結構的每一個(gè)節點(diǎn)都可以接受一個(gè)訪(fǎng)問(wèn)者的調用,此節點(diǎn)向訪(fǎng)問(wèn)者對象傳入節點(diǎn)對象,而訪(fǎng)問(wèn)者對象則反過(guò)來(lái)執行節點(diǎn)對象的操作。這樣的過(guò)程叫做"雙重分派"。節點(diǎn)調用訪(fǎng)問(wèn)者,將它自己傳入,訪(fǎng)問(wèn)者則將某算法針對此節點(diǎn)執行。
雙重分派意味著(zhù)施加于節點(diǎn)之上的操作是基于訪(fǎng)問(wèn)者和節點(diǎn)本身的數據類(lèi)型,而不僅僅是其中的一者。
二、 訪(fǎng)問(wèn)者模式的結構
如下圖所示,這個(gè)靜態(tài)圖顯示了有兩個(gè)具體訪(fǎng)問(wèn)者和兩個(gè)具體節點(diǎn)的訪(fǎng)問(wèn)者模式的設計,必須指出的是,具體訪(fǎng)問(wèn)者的數目與具體節點(diǎn)的數目沒(méi)有任何關(guān)系,雖然在這個(gè)示意性的系統里面兩者的數目都是兩個(gè)。
訪(fǎng)問(wèn)者模式涉及到抽象訪(fǎng)問(wèn)者角色、具體訪(fǎng)問(wèn)者角色、抽象節點(diǎn)角色、具體節點(diǎn)角色、結構對象角色以及客戶(hù)端角色。
- 抽象訪(fǎng)問(wèn)者(Visitor)角色:聲明了一個(gè)或者多個(gè)訪(fǎng)問(wèn)操作,形成所有的具體元素角色必須實(shí)現的接口。
- 具體訪(fǎng)問(wèn)者(ConcreteVisitor)角色:實(shí)現抽象訪(fǎng)問(wèn)者角色所聲明的接口,也就是抽象訪(fǎng)問(wèn)者所聲明的各個(gè)訪(fǎng)問(wèn)操作。
- 抽象節點(diǎn)(Node)角色:聲明一個(gè)接受操作,接受一個(gè)訪(fǎng)問(wèn)者對象作為一個(gè)參量。
- 具體節點(diǎn)(Node)角色:實(shí)現了抽象元素所規定的接受操作。
- 結構對象(ObiectStructure)角色:有如下的一些責任,可以遍歷結構中的所有元素;如果需要,提供一個(gè)高層次的接口讓訪(fǎng)問(wèn)者對象可以訪(fǎng)問(wèn)每一個(gè)元素;如果需要,可以設計成一個(gè)復合對象或者一個(gè)聚集,如列(List)或集合(Set)。
三、 示意性源代碼
// Visitor pattern -- Structural example
using System;
using System.Collections;
// "Visitor"
abstract class Visitor
{
// Methods
abstract public void VisitConcreteElementA(
ConcreteElementA concreteElementA );
abstract public void VisitConcreteElementB(
ConcreteElementB concreteElementB );
}
// "ConcreteVisitor1"
class ConcreteVisitor1 : Visitor
{
// Methods
override public void VisitConcreteElementA(
ConcreteElementA concreteElementA )
{
Console.WriteLine( "{0} visited by {1}",
concreteElementA, this );
}
override public void VisitConcreteElementB(
ConcreteElementB concreteElementB )
{
Console.WriteLine( "{0} visited by {1}",
concreteElementB, this );
}
}
// "ConcreteVisitor2"
class ConcreteVisitor2 : Visitor
{
// Methods
override public void VisitConcreteElementA(
ConcreteElementA concreteElementA )
{
Console.WriteLine( "{0} visited by {1}",
concreteElementA, this );
}
override public void VisitConcreteElementB(
ConcreteElementB concreteElementB )
{
Console.WriteLine( "{0} visited by {1}",
concreteElementB, this );
}
}
// "Element"
abstract class Element
{
// Methods
abstract public void Accept( Visitor visitor );
}
// "ConcreteElementA"
class ConcreteElementA : Element
{
// Methods
override public void Accept( Visitor visitor )
{
visitor.VisitConcreteElementA( this );
}
public void OperationA()
{
}
}
// "ConcreteElementB"
class ConcreteElementB : Element
{
// Methods
override public void Accept( Visitor visitor )
{
visitor.VisitConcreteElementB( this );
}
public void OperationB()
{
}
}
// "ObjectStructure"
class ObjectStructure
{
// Fields
private ArrayList elements = new ArrayList();
// Methods
public void Attach( Element element )
{
elements.Add( element );
}
public void Detach( Element element )
{
elements.Remove( element );
}
public void Accept( Visitor visitor )
{
foreach( Element e in elements )
e.Accept( visitor );
}
}
///
/// Client test
/// public class Client
{
public static void Main( string[] args )
{
// Setup structure
ObjectStructure o = new ObjectStructure();
o.Attach( new ConcreteElementA() );
o.Attach( new ConcreteElementB() );
// Create visitor objects
ConcreteVisitor1 v1 = new ConcreteVisitor1();
ConcreteVisitor2 v2 = new ConcreteVisitor2();
// Structure accepting visitors
o.Accept( v1 );
o.Accept( v2 );
}
}
結構對象會(huì )遍歷它自己所保存的聚集中的所有節點(diǎn),在本系統中就是節點(diǎn)ConcreteElementA和節點(diǎn)ConcreteElementB。首先ConcreteElementA會(huì )被訪(fǎng)問(wèn)到,這個(gè)訪(fǎng)問(wèn)是由以下的操作組成的:
- ConcreteElementA對象的接受方法被調用,并將VisitorA對象本身傳入;
- ConcreteElementA對象反過(guò)來(lái)調用VisitorA對象的訪(fǎng)問(wèn)方法,并將ConcreteElementA對象本身傳入;
- VisitorA對象調用ConcreteElementA對象的商業(yè)方法operationA( )。
從而就完成了雙重分派過(guò)程,接著(zhù),ConcreteElementB會(huì )被訪(fǎng)問(wèn),這個(gè)訪(fǎng)問(wèn)的過(guò)程和ConcreteElementA被訪(fǎng)問(wèn)的過(guò)程是一樣的。
因此,結構對象對聚集元素的遍歷過(guò)程就是對聚集中所有的節點(diǎn)進(jìn)行委派的過(guò)程,也就是雙重分派的過(guò)程。換言之,系統有多少個(gè)節點(diǎn)就會(huì )發(fā)生多少個(gè)雙重分派過(guò)程。
四、 一個(gè)實(shí)際應用Visitor模式的例子
以下的例子演示了Employee對象集合允許被不同的Visitor(IncomeVisitor與VacationVisitor)訪(fǎng)問(wèn)其中的內容。
// Visitor pattern -- Real World example
using System;
using System.Collections;
// "Visitor"
abstract class Visitor
{
// Methods
abstract public void Visit( Element element );
}
// "ConcreteVisitor1"
class IncomeVisitor : Visitor
{
// Methods
public override void Visit( Element element )
{
Employee employee = ((Employee)element);
// Provide 10% pay raise
employee.Income *= 1.10;
Console.WriteLine( "{0}‘s new income: {1:C}",
employee.Name, employee.Income );
}
}
// "ConcreteVisitor2"
class VacationVisitor : Visitor
{
public override void Visit( Element element )
{
Employee employee = ((Employee)element);
// Provide 3 extra vacation days
employee.VacationDays += 3;
Console.WriteLine( "{0}‘s new vacation days: {1}",
employee.Name, employee.VacationDays );
}
}
// "Element"
abstract class Element
{
// Methods
abstract public void Accept( Visitor visitor );
}
// "ConcreteElement"
class Employee : Element
{
// Fields
string name;
double income;
int vacationDays;
// Constructors
public Employee( string name, double income,
int vacationDays )
{
this.name = name;
this.income = income;
this.vacationDays = vacationDays;
}
// Properties
public string Name
{
get{ return name; }
set{ name = value; }
}
public double Income
{
get{ return income; }
set{ income = value; }
}
public int VacationDays
{
get{ return vacationDays; }
set{ vacationDays = value; }
}
// Methods
public override void Accept( Visitor visitor )
{
visitor.Visit( this );
}
}
// "ObjectStructure"
class Employees
{
// Fields
private ArrayList employees = new ArrayList();
// Methods
public void Attach( Employee employee )
{
employees.Add( employee );
}
public void Detach( Employee employee )
{
employees.Remove( employee );
}
public void Accept( Visitor visitor )
{
foreach( Employee e in employees )
e.Accept( visitor );
}
}
///
/// VisitorApp test
/// public class VisitorApp
{
public static void Main( string[] args )
{
// Setup employee collection
Employees e = new Employees();
e.Attach( new Employee( "Hank", 25000.0, 14 ) );
e.Attach( new Employee( "Elly", 35000.0, 16 ) );
e.Attach( new Employee( "Dick", 45000.0, 21 ) );
// Create two visitors
IncomeVisitor v1 = new IncomeVisitor();
VacationVisitor v2 = new VacationVisitor();
// Employees are visited
e.Accept( v1 );
e.Accept( v2 );
}
}
五、 在什么情況下應當使用訪(fǎng)問(wèn)者模式
有意思的是,在很多情況下不使用設計模式反而會(huì )得到一個(gè)較好的設計。換言之,每一個(gè)設計模式都有其不應當使用的情況。訪(fǎng)問(wèn)者模式也有其不應當使用的情況,讓我們
先看一看訪(fǎng)問(wèn)者模式不應當在什么情況下使用。
傾斜的可擴展性
訪(fǎng)問(wèn)者模式僅應當在被訪(fǎng)問(wèn)的類(lèi)結構非常穩定的情況下使用。換言之,系統很少出現需要加入新節點(diǎn)的情況。如果出現需要加入新節點(diǎn)的情況,那么就必須在每一個(gè)訪(fǎng)問(wèn)對象里加入一個(gè)對應于這個(gè)新節點(diǎn)的訪(fǎng)問(wèn)操作,而這是對一個(gè)系統的大規模修改,因而是違背"開(kāi)一閉"原則的。
訪(fǎng)問(wèn)者模式允許在節點(diǎn)中加入新的方法,相應的僅僅需要在一個(gè)新的訪(fǎng)問(wèn)者類(lèi)中加入此方法,而不需要在每一個(gè)訪(fǎng)問(wèn)者類(lèi)中都加入此方法。
顯然,訪(fǎng)問(wèn)者模式提供了傾斜的可擴展性設計:方法集合的可擴展性和類(lèi)集合的不可擴展性。換言之,如果系統的數據結構是頻繁變化的,則不適合使用訪(fǎng)問(wèn)者模式。
"開(kāi)一閉"原則和對變化的封裝
面向對象的設計原則中最重要的便是所謂的"開(kāi)一閉"原則。一個(gè)軟件系統的設計應當盡量做到對擴展開(kāi)放,對修改關(guān)閉。達到這個(gè)原則的途徑就是遵循"對變化的封裝"的原則。這個(gè)原則講的是在進(jìn)行軟件系統的設計時(shí),應當設法找出一個(gè)軟件系統中會(huì )變化的部分,將之封裝起來(lái)。
很多系統可以按照算法和數據結構分開(kāi),也就是說(shuō)一些對象含有算法,而另一些對象含有數據,接受算法的操作。如果這樣的系統有比較穩定的數據結構,又有易于變化的算法的話(huà),使用訪(fǎng)問(wèn)者模式就是比較合適的,因為訪(fǎng)問(wèn)者模式使得算法操作的增加變得容易。
反過(guò)來(lái),如果這樣一個(gè)系統的數據結構對象易于變化,經(jīng)常要有新的數據對象增加進(jìn)來(lái)的話(huà),就不適合使用訪(fǎng)問(wèn)者模式。因為在訪(fǎng)問(wèn)者模式中增加新的節點(diǎn)很困難,要涉及到在抽象訪(fǎng)問(wèn)者和所有的具體訪(fǎng)問(wèn)者中增加新的方法。
六、 使用訪(fǎng)問(wèn)者模式的優(yōu)點(diǎn)和缺點(diǎn)
訪(fǎng)問(wèn)者模式有如下的優(yōu)點(diǎn):
- 訪(fǎng)問(wèn)者模式使得增加新的操作變得很容易。如果一些操作依賴(lài)于一個(gè)復雜的結構對象的話(huà),那么一般而言,增加新的操作會(huì )很復雜。而使用訪(fǎng)問(wèn)者模式,增加新的操作就意味著(zhù)增加一個(gè)新的訪(fǎng)問(wèn)者類(lèi),因此,變得很容易。
- 訪(fǎng)問(wèn)者模式將有關(guān)的行為集中到一個(gè)訪(fǎng)問(wèn)者對象中,而不是分散到一個(gè)個(gè)的節點(diǎn)類(lèi)中。
- 訪(fǎng)問(wèn)者模式可以跨過(guò)幾個(gè)類(lèi)的等級結構訪(fǎng)問(wèn)屬于不同的等級結構的成員類(lèi)。迭代子只能訪(fǎng)問(wèn)屬于同一個(gè)類(lèi)型等級結構的成員對象,而不能訪(fǎng)問(wèn)屬于不同等級結構的對象。訪(fǎng)問(wèn)者模式可以做到這一點(diǎn)。
- 積累狀態(tài)。每一個(gè)單獨的訪(fǎng)問(wèn)者對象都集中了相關(guān)的行為,從而也就可以在訪(fǎng)問(wèn)的過(guò)程中將執行操作的狀態(tài)積累在自己內部,而不是分散到很多的節點(diǎn)對象中。這是有益于系統維護的優(yōu)點(diǎn)。
訪(fǎng)問(wèn)者模式有如下的缺點(diǎn):
- 增加新的節點(diǎn)類(lèi)變得很困難。每增加一個(gè)新的節點(diǎn)都意味著(zhù)要在抽象訪(fǎng)問(wèn)者角色中增加一個(gè)新的抽象操作,并在每一個(gè)具體訪(fǎng)問(wèn)者類(lèi)中增加相應的具體操作。
- 破壞封裝。訪(fǎng)問(wèn)者模式要求訪(fǎng)問(wèn)者對象訪(fǎng)問(wèn)并調用每一個(gè)節點(diǎn)對象的操作,這隱含了一個(gè)對所有節點(diǎn)對象的要求:它們必須暴露一些自己的操作 和內部狀態(tài)。不然,訪(fǎng)問(wèn)者的訪(fǎng)問(wèn)就變得沒(méi)有意義。由于訪(fǎng)問(wèn)者對象自己會(huì )積累訪(fǎng)問(wèn)操作所需的狀態(tài),從而使這些狀態(tài)不再存儲在節點(diǎn)對象中,這也是破壞封裝的。