Visitor 模式

起源

Delphi中的Visitor模式在基本Visitor模式進行了擴展。更多Visitor模式的資料請參 [Gam+, pages 331..344].

目的

表示一個作用于某個對象結構的中和元素的操作。它使你可以在不改變各元素的類的前提下定義作用于這些元素的新操作。

 [Gam+, page 331].

動機

考慮一個面向對象的建模工具，比如說‘Rational Rose、ModelMaker’,它將一個模型表示為類和類的成員。

在建模工具上提供了許多操作成員功能，比如：列表類的所有成員、生成類的代碼框架、反向工程等。

這些操作大多對不同的成員進行不同的操作。它將成員分成字段（fields）、方法（methods）、

屬性（PRoperties）。因些我們必須建立專門處理字段的類，專門處理methods的類等等。成員類的集合當然依賴被編譯的語言。但對于一給定語言變化不大。

如圖顯示了部分成員類的框架。問題產生了，如果我將所有這些操作分散到不同的成員類，

將會導致整個系統難于理解，修改，維護。將類代碼生成與類成員檢查放在一起，將產生混亂。些外加入新的操作時要重新編譯的有的類（至少也重新編譯所有的相關的系）。有個辦法：你可能獨立的增加一個新的操作，并這個成員類獨立如作用于其上的操作。

要實現上述兩個目標，我們可以將每個類中相關操作包裝在一上獨立的對象（稱為visitor）

并在遍歷類成員列表時將此對象傳遞給當前成員。當一個成員‘接受’ 訪問，該成員向訪問者發送包含自身信息的請求。該成員請自本身作為一個參數。訪問者執行這些操作。

例如：一個不使用訪問者的代碼生成器可能會通成員類的抽象的方法：TMember.WriteInterfaceCode(Output: TStream)生成代碼。每一個成員都會調用WriteInterfaceCode生成適當的輸出代碼。如果通過訪問者來生成代碼，則會創建一個TinterfaceCodeVisitor對象,并在成員列表上調用參數為訪問對象的AcceptVisitor方法。每一個在員在實現AcceptVisitor將會回調visitor：一個字段將調用訪問者的VisitField方法，而一個方法則調用VisitMethod方法。這樣，以前類Tfield的WriteInterfaceCode操作現在成為TinterfaceCodeVisitor的VisitField操作。

為使訪問者不僅僅只做代碼生成，我們需要所有的成員列表的訪問者有一個抽象的父類TmemberVisitor。TmemberVisitor必須為每一個成員定義一種方法。一個需要將成員輸出為HTML格式的應用將定義TmemberVisitor新的子類，并不再需要在成員類中增加與特定應用相關的代碼。Visitor模式將每個操作封裝在一個相關的Visitor中

使用Visitor模式，必須定義兩個層次的類：一個應于接受操作的元素（Tmember層次）另一個定義于對元素的操作（TmemberVisitor 層次）。增加一個新的操作時只需給訪問者層次增加一個新的子類。我可能簡單的定義新的TmemberVisitor子類以增加新的功能。

應用

下面的代碼演示上面描述的類Tmember的Visitor模式的應用

type

  TMember = class (TObject)

  public

    procedure AcceptMemberVisitor(Visitor: TMemberVisitor); virtual;

  end;

  TField = class (TMember)

  public

    procedure AcceptMemberVisitor(Visitor: TMemberVisitor); override;

  end;

  TMethod = class (TMember)

  public

    procedure AcceptMemberVisitor(Visitor: TMemberVisitor); override;

  end;

  TProperty = class (TMember)

  public

    procedure AcceptMemberVisitor(Visitor: TMemberVisitor); override;

  end;

  TMemberVisitor = class (TObject)

  public

    procedure VisitField(Instance: TField); virtual;

    procedure VisitMember(Instance: TMember); virtual;

    procedure VisitMethod(Instance: TMethod); virtual;

    procedure VisitProperty(Instance: TProperty); virtual;

  end;

implementation

{ TMember }

begin

  Visitor.VisitMember(Self);

end;

{ TField }

procedure TField.AcceptMemberVisitor(Visitor: TMemberVisitor);

begin

end;

{ TMethod }

procedure TMethod.AcceptMemberVisitor(Visitor: TMemberVisitor);

begin

  Visitor.VisitMethod(Self);

end;

{ TProperty }

procedure TProperty.AcceptMemberVisitor(Visitor: TMemberVisitor);

begin

  Visitor.VisitProperty(Self);

end;

{ TMemberVisitor }

procedure TMemberVisitor.VisitField(Instance: TField);

begin

end;

procedure TMemberVisitor.VisitMember(Instance: TMember);

begin

end;

procedure TMemberVisitor.VisitMethod(Instance: TMethod);

begin

end;

procedure TMemberVisitor.VisitProperty(Instance: TProperty);

begin

end;

說明:

?      TMember, TField, TMethod 和 Tproperty都實現了AcceptMemberVisitor方法. 這些方法都嵌入模式中

?      TMemberVisitor 類實現了VisitMember, VisitField等方法。TmemberVisitor是一個抽象的類，它所有的方法由具體的子類實現。

下面是一個簡單的代碼生成器的實現。

代碼介紹:

?      TCodeGenerationVisitor 是一個用于實現成員的代碼生成器的訪問者。

?      訪問者定義了一個上下文相關的屬性：Output: TTextStream,

?       它必須在VisitXXX調用前被定，如：DrawingVisitor典型的需要一個包括canvas的上下文，來支持畫圖操作。上下文在遍歷整個member對列前賦予了代碼生成器。

?      代碼生成器將整結的生成的類的所有代碼

要真正的了解Visitor模式,你可執行這個例子 ,并進一步的學習雙分派機制： accept/visit.

unit CodeGenerators;

interface

uses Classes, TextStreams;

type

  TCodeGenerator = class (TObject)

  public

    procedure Generate(Members: TList; Output: TTextStream);

  end;

implementation

uses Members;

type

  TCodeGenerationVisitor = class (TMemberVisitor)

  private

    FOutput: TTextStream;

  public

    procedure VisitField(Instance: TField); override;

    procedure VisitMethod(Instance: TMethod); override;

    procedure VisitProperty(Instance: TProperty); override;

    property Output: TTextStream read FOutput write FOutput;

  end;

{ TCodeGenerationVisitor }

procedure TCodeGenerationVisitor.VisitField(Instance: TField);

begin

  Output.WriteLnFmt('  %s: %s;', [Instance.Name, Instance.DataName]);

end;

procedure TCodeGenerationVisitor.VisitMethod(Instance: TMethod);

var

  MKStr, DTStr: string;

begin

  case Instance.MethodKind of

    mkConstructor: MKStr := 'constructor';

    mkDestructor: MKStr := 'destructor';

    mkProcedure: MKStr := 'procedure';

    mkFuntion: MKStr := 'function';

  end;

  if Instance.MethodKind = mkFunction then

    DTStr := ': ' + Instance.DataName

  else

    DTStr := ';

  {代碼不完整，現足以演示Tmethod代碼生成 }

  Output.WriteLnFmt('  %s %s%s%s;'

                    [MKStr, Instance.Name, Instance.Parameters, DTStr]);

end;

procedure TCodeGenerationVisitor.VisitProperty(Instance: TProperty);

begin

  Output.WriteLnFmt('  property %s: %s read %s write %s;',

                    [Instance.Name, Instance.DataName,

                     Instance.ReadSpecifier, Instance.WriteSpecifier]);

end;

{ TCodeGenerator }

procedure TCodeGenerator.Generate(Members: TList; Output: TTextStream);

var

  I: Integer;

begin

  {寫入類定義 }

  Output.WriteLine('TSample = class (TObject)');

  {好！ 加入代碼生成器的訪問者}

  Visitor := TCodeGenerationVisitor.Create;

  Try

    {記住為訪問都提供上下文，以便更好的訪問VisitXXX方法。}

    for I := 0 to Members.Count - 1 do

      { 代碼的具體段，好事情發生了}

      TMember(Members[I]).AcceptMemberVisitor(Visitor);

  finally

    Visitor.Free;

  end;

  {類成員的代碼生成完畢}

  Output.WriteLine('end;');

end;

Delphi實例

正在組織

//很多摘自《設計模式》，