Slickflow.Graph 開源工作流引擎快速入門之四: 圖形編碼建模工具使用手冊
前言: 業務人員繪製流程時，通常使用圖形GUI介面互動操作來完成，然而對於需要頻繁操作或者管理較多流程的系統管理使用者，就需要一款輔助工具，來幫助他們快速完成流程的建立和編輯更新。Slickflow.Graph 圖形編碼建模工具通過命令列直接編寫程式碼建立圖形，實現了流程圖形繪製效率的快速提升。
申明: 本篇文章為Slickflow原創文章，任何人不得私自轉載，部落格園為作者授權的中文文章唯一來源。
1. 圖形建立程式碼文字
首先通過一個程式碼片段來進行說明，這個程式碼片段建立了一個簡單的序列流程。程式碼如下：
using Slickflow.Graph;
using Slickflow.Engine.Common;
//firstly, create a process model builder
var pmb = ProcessModelBuilder.CreateProcess("BookSellerProcess", "BookSellerProcessCode", "3");
var process = pmb.Start("Start")
.Task("Package Books", "003") //task name, code
.Task("Deliver Books", "005") //task name, code
.End("End")
.Store();
圖形截圖如下：
1.1 流程建立命令
命令示例：
var pmb = ProcessModelBuilder.CreateProcess("BookSellerProcess", "BookSellerProcessCode", "3");
引數: (processName, processCode, processVersion)
1.2 活動節點建立命令
1.2.1 開始節點建立: Start()
命令示例:
pmb.Start("Start")
引數: (activityName, activityCode)
1.2.2 結束節點建立: End()
命令示例:
pmb.End("End")
引數: (activityName, activityCode)
1.2.3 任務節點建立: Task()
1.2.3.1 基本方法
命令示例:
pmb.Task("Package Books", "003")
引數: (activityName, activityCode)
1.2.3.2 擴充套件方法
命令示例:
pmb.Task(
VertexBuilder.CreateTask("Task-001")
.SetUrl("http://www.slickflow.com")
.AddRole("TestRole")
.AddAction(
VertexBuilder.CreateAction(ActionTypeEnum.Event,
FireTypeEnum.Before,
"Slickflow.Module.External.OrderSubmitService"
))
)
1) CreateTask(): 建立任務節點
引數: (task)
2) SetUrl(): 設定節點Url頁面屬性
引數: (pageUrl) 頁面地址字串
3) AddRole(): 設定節點繫結角色資料
引數: (roleCode) 角色程式碼
4) AddAction(): 新增Action操作明細專案
引數: (action) 物件
5) CreateAction(): 建立Action操作明細物件
引數: (actionType, fireType, methodName)
1.2.4 分支節點建立: Split()
分支和合並通常作為一個整體的程式碼片段來建立，如下圖，建立了兩個分支的流程圖，每個分支上又有兩個任務節點，完整的程式碼片段示例如下：
pmb.Split("split")
.Parallels(
() => pmb.Branch(
() => pmb.Task("task-010"),
() => pmb.Task("task-011")
)
, () => pmb.Branch(
() => pmb.Task("task-020"),
() => pmb.Task("task-021")
)
)
.Join("join")
圖形截圖如下：
1) Split(): 建立分支節點
引數: (activityName, activityCode)
2) Parallels(): 建立多個分支的外部方法
引數:
(params Func<ProcessModelBuilder>[] branches)
描述: 引數branches 表示分支列表的組合, 一個並行模式可以由多個分支組成，params表示是可變引數列表關鍵字。
3) Branch(): 分支具體建立方法
引數:
(params Func<ProcessModelBuilder>[] nodes)
描述: 引數nodes表示節點列表的組合，一個分支可以由多個節點組成，params表示是可變引數列表關鍵字。
4) Join(): 建立合併節點
引數: (activityName, activityCode)
說明: 合併和分支通常是對應成對出現的，用於表達決策型別的分支選擇模式。
1.3 圖形儲存命令
命令示例:
pmb.Store();
儲存命令會把上述圖形按照XML序列化後，作為資料庫中的一條記錄進行儲存。
2. 圖形維護命令
2.1 流程載入命令
1) 命令:
var pmb = ProcessModelBuilder.LoadProcess("BookSellerProcessCode", "3");
引數: (processCode, processVersion)
說明: 流程程式碼和版本組成唯一關鍵字標識用於唯一確定流程記錄。
2.2 圖形節點編輯程式碼
1) 命令:
using Slickflow.Graph;
using Slickflow.Engine.Common;
//firstly load a process model builder
var pmb = ProcessModelBuilder.LoadProcess("BookSellerProcessCode", "3");
//execute deffrient task operation once together
pmb.Add("003", ActivityTypeEnum.TaskNode, "zzz", "zzz-code")
.Insert("003", ActivityTypeEnum.TaskNode, "task004", "004")
.Set("003", (a) => pmb.GetBuilder(a).SetUrl("slickflow.com").SetName("mer-sss-ryxmas"))
.Replace("004", ActivityTypeEnum.TaskNode, "task222", "222")
.Exchange("222", "zzz-code")
.Fork("zzz-code", ActivityTypeEnum.TaskNode, "yyy", "555")
.Remove("222", true)
.Update();
說明:對圖形節點元素的增加、插入、交換、取代、分支、編輯和刪除等所有更新操作，可以通過鏈式服務介面一次執行完成。
2.3 節點編輯命令詳解
2.3.1 增加節點: Add()
1) 命令:
//add a new task node zzz after task with code 003(Package Books)
pmb.Add("003", ActivityTypeEnum.TaskNode, "zzz", "zzz-code")
引數: (currentActivityCode, addActivityType, addActivityName, addActivityCode)
說明: Add()方法是在當前節點的後面增加一個新的節點，而且繼續保持新增加的節點也是在流程的連線上。
2) 命令執行後的圖形示例：
2.3.2 插入節點: Insert()
1) 命令:
//insert a new task node named task004 before task 003(Package Books)
pmb.Insert("003", ActivityTypeEnum.TaskNode, "task004", "004")
引數: (currentActivityCode, addActivityType, addActivityName, addActivityCode)
說明: Insert()方法是在當前節點的前面增加一個新的節點，而且繼續保持新增加的節點也是在流程的連線上。
2) 命令執行後的圖形示例:
2.3.3 更新節點屬性: Set()
1) 命令:
//set task 003(Package Books) property url and name
pmb.Set("003", (a) => pmb.GetBuilder(a).SetUrl("slickflow.com").SetName("mer-sss-ryxmas"))
引數: (currentActivityCode, vertexBuilder)
說明: 根據當前節點的程式碼表示，獲取當前節點物件，然後更新Url屬性和Name屬性。
2) 命令執行後的圖形示例:
2.3.4 替換節點: Replace()
1) 命令:
//replace task 004(task004) by the new task named task222
pmb.Replace("004", ActivityTypeEnum.TaskNode, "task222", "222")
引數: (currentActivityCode, replacedByActivityType, replacedByActivityName, replacedByActivityCode)
說明: 可以把當前節點用一個新增的節點進行代替，新增的節點為: replacedByActivity，取代操作，相當於先執行刪除(Remove)操作，然後再執行新增(Add)操作。節點取代之後原來的連線Transition的唯一標識GUID也會發生改變。
2) 命令執行後的圖形示例:
2.3.5 互換節點: Exchange()
1) 命令:
//exchange task 222 to zzz
pmb.Exchange("222", "zzz-code")
引數: (firstActivityCode, secondActivityCode)
說明: 該方法將兩個節點進行位置調換，其它節點的屬性保持不變。此外說明的是：調換之後節點之間的連線Transition重新賦予唯一標識GUID，因為連線的節點已經發生變化，需要改變連線標識GUID的取值。
2) 命令執行後的圖形示例:
2.3.6 分支節點: Fork()
1) 命令:
//fork a new Task 555 from task zzz
pmb.Fork("zzz-code", ActivityTypeEnum.TaskNode, "yyy", "555")
引數: (currentActivityCode, forkActivityType, forkActivityName, forkActivityCode)
說明: 該方法是在當前節點上增加分支路徑，如果當前節點的沒有後續節點，則等同於新增Add方法。如果當前節點已經有後續節點，則在鄰近位置新增加一個節點。
2) 命令執行後的圖形示例:
2.3.7 刪除節點: Remove()
1) 命令:
//remove the task 222, and afterward nodes will be caught up
pmb.Remove("222", true)
引數: (currentActivityCode, isCaughtUp)
說明: 刪除當前節點，並且如果當前節點已經有後續節點，則需要前置該後續節點到當前已經刪除節點的位置，包括重新增加連線。
2) 命令執行後的圖形示例:
2.3.8 新增分支/合併: Cover()
1) 命令:
//cover a split/join pattern into canvas
pmb.Cover("003", "005",
VertexBuilder.CreateSplit(GatewayDirectionEnum.AndSplit,"AndSplit", "AndSplicCode"),
VertexBuilder.CreateJoin(GatewayDirectionEnum.AndJoin, "AndJoin", "AndJoinCode"),
VertexBuilder.CreateTask("branchTask001", "b001"),
VertexBuilder.CreateTask("branchTask002", "b002")
)
.Update();
2) 命令執行後的圖形示例:
2.3.9 刪除分支/合併: Uncover()
1) 命令
//uncover a split/join pattern from canvas
pmb.Uncover("003", "005")
.Update();
2) 命令執行後的圖形示例:
2.3.10 連線節點: Connect()
1) 命令
//connect two task node
pmb.Connect("003", "005")
.Update();
2) 命令執行後的圖形示例:
2.3.11 斷開節點: Disconnect()
1) 命令:
//disconnect two task node
pmb.Disconnect("003", "005")
.Update();
2) 命令執行後的圖形示例:
2.4 流程更新命令Update()
1) 命令:
pmb.Update();
說明: 將會重新對流程節點和連線資料進行XML序列化處理，並且儲存資料到資料庫。
3. 程式設計環境
目前程式碼程式設計建模工具已經提供線上使用體驗工具，左側為純文字程式碼輸入區域，右側為更新後的圖形顯示區域。每次執行程式碼文字後，將會更新右側的圖形顯示。
4. 線上地址
為方便流程愛好者使用者學習和掌握Slickflow流程圖形語言模型，特意提供了網上編寫程式碼的示例環境，請按照如下地址進行訪問：
http://demo.slickflow.com/sfd/model
5. 總結
程式碼程式設計建模工具的實現，方便了使用者快速建立和更新圖形，程式碼命令簡單易學，建議流程技術人員、流程管理使用者和系統分析人員可以投入時間學習掌握，從而提升流程開發效