分享一款狀態機自動生成工具
為實用的軟件系統編寫狀態機并不是一件十分輕松的事情，特別是當狀態機本身比較復雜的時候尤其如此，許多有過類似經歷的程序員往往將其形容為"毫無創意"的過程，因為他們需要將大量的時間與精力傾注在如何管理好狀態機中的各種狀態上，而不是程序本身的運行邏輯。
作為一種通用的軟件設計模式，各種軟件系統的狀態機之間肯定會或多或少地存在著一些共性，因此人們開始嘗試開發一些工具來自動生成有限狀態機的框架代碼，而在Linux下就有一個挺不錯的選擇──FSME（Finite State Machine Editor）。
可視化的FSME
FSME是一個基于Qt的有限狀態機工具，它能夠讓用戶通過圖形化的方式來對程序中所需要的狀態機進行建模，并且還能夠自動生成用C++或者Python實現的狀態機框架代碼。
下面就以下圖中城門的狀態機為例，來介紹如何利用FSME來自動生成程序中所需要的狀態機代碼。
控制城門的狀態機
1狀態機建模
首先運行fsme命令來啟動狀態機編輯器，然后單擊工具欄上的"New"按鈕來創建一個新的狀態機。FSME中用于構建狀態機的基本元素一共有五種：事件（Event）、輸入（Input）、輸出（Output）、狀態（State）和轉換（Transition），在界面左邊的樹形列表中可以找到其中的四種。
- 狀態建模
在FSME界面左邊的樹形列表中選擇"States"項，然后按下鍵盤上的Insert鍵來插入一個新的狀態，接著在右下方的"Name"文本框中輸入狀態的名稱，再在右上方的繪圖區域單擊該狀態所要放置的位置，一個新的狀態就創建好了。用同樣的辦法可以添加狀態機所需要的所有狀態，如下圖所示。
狀態建模
- 事件建模
在FSME界面左邊的樹形列表中選擇"Events"項，然后按下鍵盤上的Insert鍵來添加一個新的事件，接著在右下方的"Name"文本框中輸入事件的名稱，再單擊"Apply"按鈕，一個新的事件就創建好了。用同樣的辦法可以添加狀態機所需要的所有事件，如下圖所示。
- 轉換建模
狀態轉換是整個建模過程中最重要的一個部分，它用來定義有限狀態機中的一個狀態是如何切換到另一個狀態的。例如，當用來控制城門的狀態機處于Opened狀態時，如果此時有Close事件產生，那么狀態機的當前狀態將切換到Closed狀態，這樣一個完整的過程在狀態機模型中可以用closeDoor這樣一個轉換來進行描述。
要在FSME中添加這樣一個轉換，首先需要在界面左邊的樹形列表中選擇"States"下的"Opened"項，然后按下鍵盤上的Insert鍵來添加一個新的轉換，接著在右下角的"Name"文本框中輸入轉換的名字"closeDoor"，在"Condition"文本框中輸入"Close"表明觸發該轉換的條件是事件Close的產生，在"Target"下拉框中選擇"Closed"項表明該轉換發生后狀態機將被切換到Closed狀態，最后再單擊"Apply"按鈕，一個新的狀態轉換關系就定義好了，如下圖所示。用同樣的辦法可以添加狀態機所需要的所有轉換。
轉換建模
2 生成狀態機框架
使用FSME不僅能夠進行可視化的狀態機建模，更重要的是它還可以根據得到的模型自動生成用C++或者Python實現的狀態機框架。首先在FSME界面左邊的樹形列表中選擇"Root"項，然后在右下角的"Name"文本框中輸入狀態機的名字"DoorFSM"，再從"Initial State"下拉列表中選擇狀態"Opened"作為狀態機的初始化狀態，如圖6所示。
設置初始屬性
在將狀態機模型保存為door.fsm文件之后，使用下面的命令可以生成包含有狀態機定義的頭文件：
[xiaowp@linuxgam code]$ fsmc door.fsm -d -o DoorFSM.h
進一步還可以生成包含有狀態機實現的框架代碼：
[xiaowp@linuxgam code]$ fsmc door.fsm -d -impl DoorFSM.h -o DoorFSM.cpp
如果想對生成的狀態機進行驗證，只需要再手工編寫一段用于測試的代碼就可以了：
/* * TestFSM.cpp * 測試生成的狀態機框架 */ #include "DoorFSM.h" int main() { DoorFSM door; door.A(DoorFSM::Close); door.A(DoorFSM::Lock); door.A(DoorFSM::Unlock); door.A(DoorFSM::Open); }
有限狀態機是由事件來進行驅動的，在FSME生成的狀態機框架代碼中，方法A()可以被用來向狀態機發送相應的事件，從而提供狀態機正常運轉所需要的"動力"。狀態機負責在其內部維護一個事件隊列，所有到達的事件都會先被放到事件隊列中進行等候，從而能夠保證它們將按照到達的先后順序被依次處理。在處理每一個到達的事件時，狀態機都會根據自己當前所處的狀態，檢查與該狀態對應的轉換條件是否已經被滿足，如果滿足的話則激活相應的狀態轉換過程。
使用下面的命令能夠將生成的狀態機框架和測試代碼編譯成一個可執行文件：
[xiaowp@linuxgam code]$ g++ DoorFSM.cpp TestFSM.cpp -o fsm
由于之前在用fsmc命令生成狀態機代碼時使用了-d選項，生成的狀態機框架中會包含一定的調試信息，包括狀態機中每次狀態轉換時的激活事件、轉換前的狀態、所經歷的轉換、轉換后的狀態等，如下所示：
[xiaowp@linuxgam code]$ ./fsm DoorFSM'Close' DoorFSM'Opened' DoorFSM'closeDoor' DoorFSM:new state:'Closed' DoorFSM'Lock' DoorFSM'Closed' DoorFSM'lockDoor' DoorFSM:new state:'Locked' DoorFSM'Unlock' DoorFSM'Locked' DoorFSM'unlockDoor' DoorFSM:new state:'Unlocked' DoorFSM'Open' DoorFSM'Unlocked' DoorFSM'openDoor' DoorFSM:new state:'Opened'
3定制狀態機
目前得到的狀態機已經能夠響應來自外部的各種事件，并適當地調整自己當前所處的狀態，也就是說已經實現了狀態機引擎的功能，接下來要做的就是根據應用的具體需求來進行定制，為狀態機加入與軟件系統本身相關的那些處理邏輯。在FSME中，與具體應用相關的操作稱為輸出（Output），它們實際上就是一些需要用戶給出具體實現的虛函數，自動生成的狀態機引擎負責在進入或者退出某個狀態時調用它們。
仍然以控制城門的那個狀態機為例，假設我們希望在進入每個狀態時都添加一部分處理邏輯。首在FSME界面左邊的樹形列表選擇"Outputs"項，然后按下鍵盤上的Insert鍵來添加一個新的輸出，接著在右下方的"Name"文本框中輸入相應的名稱，再單擊"Apply"按鈕，一個新的輸出就創建好了，如圖所示。用同樣的辦法可以添加狀態機所需要的所有輸出。
添加輸出
當所有的輸出都定義好之后，接下來就可以為狀態機中的每個狀態綁定相應的輸出。首先在FSME界面左側的"States"項中選擇相應的狀態，然后從右下角的"Available"列表框中選擇與該狀態對應的輸出，再單擊"<"按鈕將其添加到"In"列表中，如圖所示。用同樣的辦法可以為狀態機中的所有狀態設置相應的輸出，同一個狀態可以對應有多個輸出，其中In列表中的輸出會在進入該狀態時被調用，而Out列表中的輸出則會在退出該狀態時被調用，輸出調用的順序是與其在In或者Out列表中的順序相一致的。
圖為狀態設置輸出
由于對狀態機模型進行了修改，我們需要再次生成狀態機的框架代碼，不過這次不需要加上-d參數：
[xiaowp@linuxgam code]$ fsmc door.fsm -o DoorFSM.h [xiaowp@linuxgam code]$ fsmc door.fsm -d -impl DoorFSM.h -o DoorFSM.cpp
我們在新的狀態機模型中添加了enterOpend、enterClosed、enterLocked和enterUnlocked四個輸出，因此生成的類DoorFSM中會包含如下幾個純虛函數：
virtual void enterOpened() = 0; virtual void enterLocked() = 0; virtual void enterUnlocked() = 0; virtual void enterClosed() = 0;
顯然，此時生成的狀態機框架不能夠再被直接編譯了，我們必須從類DoorFSM派生出一個子類，并提供對這幾個純虛函數的具體實現：
/* * DoorFSMLogic.h * 狀態機控制邏輯的頭文件 */ #include "DoorFSM.h" class DoorFSMLogic : public DoorFSM { protected: virtual void enterOpened(); virtual void enterLocked(); virtual void enterUnlocked(); virtual void enterClosed(); };
正如前面所提到過的，這幾個函數實際上代表的正是應用系統的處理邏輯，作為例子我們只是簡單地輸出一些提示信息：
/* * DoorFSMLogic.cpp * 狀態機控制邏輯的實現文件 */ #include "DoorFSMLogic.h" #include
同樣，為了對生成的狀態機進行驗證，我們還需要手工編寫一段測試代碼：
/* * TestFSM.cpp * 測試狀態機邏輯 */ #include "DoorFSMLogic.h" int main() { DoorFSMLogic door; door.A(DoorFSM::Close); door.A(DoorFSM::Lock); door.A(DoorFSM::Unlock); door.A(DoorFSM::Open); }
使用下面的命令能夠將生成的狀態機框架和測試代碼編譯成一個可執行文件：
[xiaowp@linuxgam code]$ g++ DoorFSM.cpp DoorFSMLogic.cpp TestLogic.cpp -o logic
運行結果如下所示：
[xiaowp@linuxgam code]$ ./logic Enter Closed state. Enter Locked state. Enter Unlocked state. Enter Opened state.
-
Linux
+關注
關注
87文章
11335瀏覽量
210088 -
狀態機
+關注
關注
2文章
492瀏覽量
27613 -
軟件系統
+關注
關注
0文章
63瀏覽量
9518
原文標題：一款狀態機自動生成工具
文章出處：【微信號：strongerHuang，微信公眾號：strongerHuang】歡迎添加關注！文章轉載請注明出處。
發布評論請先 登錄
相關推薦
如何設計自動駕駛系統的狀態機
如何利用Linux下的工具來自動生成實用的狀態機框架？
使用ModelSim自動生成狀態機FSM的狀態轉換圖
有限狀態機設計是HDL Designer Series的關鍵應用
如何構建基于狀態機的軟件系統
狀態機自動生成工具FSME
自動生成程序狀態機代碼狀態機建模方法
如何生成狀態機框架
工商網監
評論