Visual Studio DSL 入門 8—建立狀態機器中繼資料模型

    在前幾節中，我們以建立的預設項目介紹了Vs.net dsl的一些基本的知識，包括域類，域關係，圖形符號，圖形映射等，這些東西看起來可能會有些抽象，和我們第二節介紹的需求還沒有直接關係，不過這些概念確實我們開發我們自己的dsl之前必須要掌握的。如果你對我們將要做的這個實際的案例的需求並不是很瞭解，請仔細需求一下我們這個狀態機器的需求.如果你第一次看這一系列，或者是對這些基礎概念還不是很熟悉，建議你看一下前面的幾節基礎知識。
     首先，按照第三節建立一個Minimal Lanauge模板項目，開啟DslDefinition.dsl檔案：
      1. 把根域類ExampleModel的名稱修改StateMachine.同時簽入關係ExampleModelHasElements也會自動重新命名為StateMachineHasElements.
      2. 修改域關係StateMachineHasElements左側的域角色Elements的屬性名稱(Property Name 注意不是修改Name--域角色名稱)改成States.同時簽入關係StateMachineHasElements自動更新為StateMachineHasStates. [你也可以直接在域角色上點擊修改,因為圖的域角色上顯示的是屬性名稱而非角色名稱).
      3. 修改域關係StateMachineHasStates的右側已經更名的域角色StateMachine，修改屬性Name為State.[注意,這裡修改的是Name,而不是Property Name].
      4. 修改域類ExampleElement的Name為State.
     
     注意這裡是基於模板項目變更,當然,你也可以刪除這些自動產生的域類而是全新重新添加.另外或許你對這裡的屬性名稱(property name)和域角色名稱(name)有些迷惑,請看前面的詳細區分.
     其實到這一步我們已經完成了狀態機器與狀態之間中繼資料的dsl描述，接下來我們來完成狀態之間的關係.
       5.我們可以看到，圖中的State與State之間已經是參考關聯性，這正是我們想要的，我們修改關係StateReferencesTargets為Transition.
       6.修改Targets為屬性名稱為Successors，域角色名稱為Predecessor.
       7.修改Sources的屬性名稱為Predecessors,域角色名稱為Successor.
      
     同樣，如果不是基於修改，而是重新添加域類也是完全可以的.
     我們接下來給域類添加一些屬性:
       8.給域關係Transition右鍵添加域屬性(DomainProperty)Event,Condition,Action,Label.類型都為string.
     現在來看一下我們的Dsl,狀態機器StateMachine,狀態State.State之間的有參考關聯性Transition,也就是我們需求中描述的轉移，它的屬性也就是狀態機器元數資料---事件Event,警戒條件Condition,操作Action.  
      接下來，我們還需要給狀態添加一個屬性，來表示狀態機器中的狀態分類，是起始狀態,結束狀態，還是普通狀態.那麼這個屬性就需要是枚舉類型，下面我們需要添加一個自訂的枚舉類型:
       9.開啟DSL Explorer，在根結點LanguageSm（這個代表我們的dsl)上右鍵，選擇添加Domain Enumeration.
      
     選中剛添加的域枚舉類型，右鍵選擇屬性，修改Name為StateKind,這樣在Dsl瀏覽器的Domain Types下面除了通用的類型外，就多了我們的StateKind枚舉類型，同樣，我們可用同樣的方式添加其它外部類型（External Type),供我們的中繼資料所用。
     我們為這個枚舉類型添加枚舉值，右鍵添加Enumeration Literal，添加三個枚舉值Normal,Initial,Final,值分別對應0,1,2.為我們的域類State添加一個屬性Kind,資料類型Type選擇我們剛剛添加的StateKind.
     接下來，我們添加一個新的域類（從工具條中選擇Domain Class拖到左側域類區),更名為Action,這就是我們的中繼資料“操作”,為這個域類添加兩個string類型的屬性Label,Code.
     現在我們需要考慮一下中繼資料中提到的進入操作和退出操作，在進入一個狀態前，對於這個狀態可以有進入操作，在退出一個狀態時，可以有退出操作，很明顯，在狀態和操作之間，應該是內嵌關係而非參考關聯性，也就是我們的狀態可以包含零或多個進入操作，零或多個退出操作，那我們這個進入操作和退出操作怎麼來用dsl的域類表示呢？如果我們也象描述狀態State那樣，由一個屬性來區分是進入操作還是退出操作是否可行呢？如果是這樣的話，對操作Action的添加等就需要特殊處理。另外一點，如果我們針對狀態State與操作Action建立多個零至多的內嵌關係會導致dsl編譯時間就會發生錯誤，這是Vs.net dsl所不允許的，這會造成歧義.[包含域類方面和圖形映射方面都會有問題].
    在這裡我們打算用Dsl的另外一個特性來實現，也就是域類的繼承，我們建立兩個新的域類來表示進入操作和退出操作，他們都繼承操作Action：
    10.添加兩個新域類EntryAction和ExitAction,並不需要給他們添加任何屬性.
    11.建立它們與Action的繼承關係，選中工具箱中的Inheritance,先選中EntryAction,再指向選中Action.
                  

    就是完成後Action,我們可以通過Bring Tree Here更簡化域類顯示(上右圖).
    12.建立EntryAction和ExitAction和State的內嵌關係，注意選中工具箱中的embedding relationship後，要從State指向EntryAction.注意左邊的重數是0…*,右邊的重數是1..1.也就是說一個狀態可以沒有進入操作或退出操作，也可以有多個。而且對於每個進入操作和退出操作，它們只能從屬於一個狀態State.
     我們現在來看一下我們完成的整個Dsl中繼資料:
    

     儲存整個Dsl檔案後，我們點擊轉換所有模板(Transform All Templates),vs.net dsl根據我們的Dsl檔案中的中繼資料，用T4模板檔案產生對應的C#代碼，注意我們在以後每當修改完Dsl檔案中的中繼資料後，都要記得轉換模板，才會使更改起作用.當然，你也可以選中某一個tt檔案，右鍵運行自訂工具(Run Custom Tool)，針對這個檔案單獨產生，尤其當你的dsl檔案相當龐大時，這樣能夠提高產生速度。
     轉換完成後，可以重新編譯整個解決方案，查看是否有錯誤發生。我們象第五節那樣，查看一下DomainClasses.cs檔案類圖:

   可以看到，中繼資料中的域類，域關係都體現在產生的程式碼中了.

代碼下載

參考資源
      1. Visual Stuido DSL 工具特定領域開發指南
      2. DSL Tools Lab     http://code.msdn.microsoft.com/DSLToolsLab  系列教程  [本系列的入門案例的主要參考]

作者：孤獨俠客（似水流年）
出處：http://lonely7345.cnblogs.com/
本文著作權歸作者和部落格園共有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文串連，否則保留追究法律責任的權利。