指南 · SysML v2
SysML v1 與 v2:兩種語言的差異
收聽本指南 20 分鐘
SysML v1 與 SysML v2 目的相同,許多名稱也相同,但 SysML v2 是一種新語言,而不是修訂版。本指南並列比較兩者:基礎、定義與用法、文字表示法、單位、埠、行為、需求、檢視、API,以及從 v1 遷移到 v2 所涉及的工作。
本頁內容
概覽
熟悉 SysML v1 的讀者會在 SysML v2 中認出大部分的概念。改變的是它們的建構方式,以及定義的精確程度。下表總結了這項比較;每一列在下方都有自己的章節。
| 主題 | SysML v1 | SysML v2 |
|---|---|---|
| 基礎 | UML 2 的設定檔:套用在 UML 元類別子集上的構造型 | 建立在核心建模語言(KerML)上的自有元模型,其語意定義在一個正式的庫中 |
| 結構 | 具有零件、參照與值屬性的區塊 | 每種元素都有定義與用法:part def 與 part、port def 與 port,依此類推 |
| 表示法 | 圖形(九種圖);沒有涵蓋整個模型的標準文字 | 同一個模型有標準的文字表示法與標準的圖形表示法 |
| 量與單位 | 透過單位模型與模型庫,使用帶有單位的值型別 | 標準庫中的 ISQ 量與 SI 單位,直接用於數值中,例如 6.5 [kg] |
| 介面 | 完整埠與代理埠、介面區塊、流動屬性、連接器上的項目流 | 具有方向特徵的埠定義、共軛 ~、具有型別端點的介面定義、流動與繫結 |
| 行為 | 來自 UML 的活動、狀態機與互動,透過分配連結到結構 | 以事件發生表示的動作、狀態與訊息,透過 perform 與 exhibit 連結到結構 |
| 需求 | 具有 id 與文字的構造型類別;約束另外存放在約束區塊中 | 需求是具有主體的約束;文字與可檢查的條件在同一個元素中 |
| 驗證 | 以 verify 關聯的測試案例 | 具有目標與判定的驗證案例 |
| 圖 | 由工具保存的繪圖;版面配置很少能在工具之間移轉 | 檢視是說明其顯示內容的模型元素;由工具負責呈現 |
| 交換 | XMI 檔案,各工具之間有差異 | 文字檔、JSON 以及標準的 Systems Modeling API |
基礎:UML 設定檔對比 KerML
SysML v1 被定義為 UML 2 的設定檔。它取用 UML 的一個子集並加上構造型:區塊是帶有 «block» 構造型的 UML 類別,需求是帶有 «requirement» 的類別,流動屬性是帶有 «flowProperty» 的屬性。這讓 SysML v1 能很快被採用,因為 UML 工具就能承載它,但這也表示系統概念被扭曲以配合軟體概念,而許多結構的意義來自為軟體而寫的 UML 語意。
SysML v2 捨棄了 UML 基礎。它建立在核心建模語言(KerML)之上,這是一種較小的語言,其核心在一個 KerML 模型庫中被賦予精確的意義。SysML v2 在其上加入系統工程的概念:零件、埠、動作、狀態、需求、案例與檢視。每個 SysML v2 結構都被定義為該庫中某個東西的特化。實務上這表示:
- 結構與行為共用同一個基礎。零件與動作都是隨時間存在的事件發生,因此零件可以執行動作或展現狀態,而不需要另外的分配層。
- 各工具對模型意義的理解更加一致,因為意義存在於規格及其庫中,而不是各工具自己的詮釋中。
- 構造型不再是擴充機制。SysML v2 使用中繼資料定義來加入工具特定或領域特定的註記。
以定義與用法取代區塊與屬性
在 SysML v1 中,區塊是核心元素:區塊定義圖定義區塊,內部區塊圖顯示一個區塊的零件。零件屬性由區塊指定型別;值屬性由值型別指定型別。若要讓某個零件具有與其區塊預設值不同的值,例如某個產品變體中較重的泵,就需要變通做法:重新定義該屬性的特化區塊、屬性專用型別,或實例規格。
SysML v2 將此一般化為適用於每種元素的單一模式:定義 說明某類事物是什麼,用法 則是在某個情境中的這樣一個事物。用法可以巢狀,而巢狀的用法可以用自己的值重新定義它所繼承的內容。同樣的模式適用於屬性、埠、動作、狀態、需求與檢視。
package CoolingLoop {
doc /* The engine cooling loop of a small generator set. */
private import ScalarValues::*;
private import ISQ::*;
private import SI::*;
part def Pump {
attribute mass : MassValue;
attribute shaftPower : PowerValue;
}
part def ElectricPump :> Pump {
attribute supplyVoltage : ElectricPotentialValue;
}
part def Radiator {
attribute mass : MassValue;
attribute heatRejection : PowerValue;
}
part def CoolingSystem {
part pump : ElectricPump {
attribute redefines mass = 2.4 [kg];
attribute redefines shaftPower = 150 [W];
attribute redefines supplyVoltage = 24 [V];
}
part radiator : Radiator {
:>> mass = 6.5 [kg];
:>> heatRejection = 18 [kW];
}
attribute totalMass : MassValue = pump.mass + radiator.mass;
}
}
| SysML v1 | 此清單中的 SysML v2 |
|---|---|
具有值屬性的區塊 Pump | 具有屬性的 part def Pump |
從 ElectricPump 到 Pump 的一般化 | 特化 part def ElectricPump :> Pump |
CoolingSystem 的零件屬性 pump,由該區塊指定型別 | 零件用法 part pump : ElectricPump |
| 透過特化區塊或實例設定的情境特定值 | 直接在用法上寫 attribute redefines mass = 2.4 [kg] |
| 以約束區塊與參數圖表示的衍生值 | 以屬性上的運算式表示的 totalMass |
:>> 是 redefines 的簡寫。v1 中指向他處所擁有之零件的參照屬性,在 v2 中變成 ref 用法。
標準的文字表示法
SysML v1 沒有涵蓋整個模型的標準文字形式。模型存放在工具的儲存庫中,大家在圖中工作,檔案以 XMI 在工具之間移轉,而 XMI 是給機器讀的,不是給人讀的。文字只出現在少數地方:約束運算式、不透明行為,以及某些工具中的動作語言。
SysML v2 有涵蓋整個語言的文字表示法,並有圖形表示法。兩者顯示同一個模型。本頁的每份清單都是這種文字表示法;SysML v2 教學 會以它逐步建立一個完整的模型。文字改變了團隊的工作方式:
- 模型可以逐行審查、以差異比較,並與其他工程資料一起納入版本控制。
- 工程師可以快速輸入模型、在模型之間複製模式,並以腳本產生模型的某些部分。
- 模型可以像原始碼一樣檢查:無法解析的名稱、錯誤的單位與不相符的埠,都會在發生之處回報。
文字表示法並不取代圖。它讓模型成為主要的產出物,而圖則成為模型的檢視,如 下文 所述。
標準庫、量與單位
SysML v1 以值型別為值屬性指定型別,值型別可以帶有單位與量的種類。規格包含量與單位的模型,以及常用單位的模型庫,但各工具隨附哪些庫、以及在運算式中檢查單位的程度都不相同。
SysML v2 隨附一個屬於語言一部分的標準庫。其中包括國際量制(ISQ)、SI 單位(SI)、美制單位、純量型別、集合以及標準檢視定義。在上面的清單中:
attribute mass : MassValue表示該屬性是質量,而不是一個數字。6.5 [kg]是一個量值:帶有單位的數字,直接寫在行內。pump.mass + radiator.mass將兩個質量相加。會評估單位的工具,可以拒絕將質量與功率相加的運算式,或以伏特表示的質量。
埠、介面與連接
SysML v1 中的埠經歷過好幾種設計。早期版本有標準埠與流動埠;後來的版本以完整埠、代理埠以及具有流動屬性的介面區塊取代了它們。流動屬性有方向(in、out 或 inout),埠可以共軛以反轉方向,而連接器上的項目流說明移動的是什麼。許多現有的 v1 模型仍然混用新舊兩類埠。
SysML v2 保留了這些概念,並使其一致。埠定義列出有方向的特徵,接收端使用同一定義的共軛 ~,而介面定義描述一種具有型別端點的連接。
package CoolantInterfaces {
private import ISQ::*;
item def Coolant {
attribute temperature : ThermodynamicTemperatureValue;
}
port def CoolantPort {
out item coolant : Coolant;
}
interface def Hose {
end supply : CoolantPort;
end ret : ~CoolantPort;
}
part def Pump {
port outlet : CoolantPort;
}
part def Radiator {
port inlet : ~CoolantPort;
}
part def Loop {
part pump : Pump;
part radiator : Radiator;
interface hose : Hose connect pump.outlet to radiator.inlet;
}
}
| SysML v1 | SysML v2 |
|---|---|
| 具有流動屬性的介面區塊 | 具有 in、out 或 inout 特徵的 port def |
| 由介面區塊指定型別的代理埠或完整埠 | 由埠定義指定型別的 port 用法 |
| 共軛埠型別 | ~CoolantPort |
| 連接器,可選擇由關聯區塊指定型別 | connect … to …,或由 interface def 指定型別的 interface 用法 |
| 繫結連接器 | bind a = b |
| 連接器上的項目流 | flow 用法,或埠的項目特徵 |
由於方向是定義的一部分,當連接的兩端都傳送同一個特徵、卻沒有任何一端接收時,檢查器就能發出警告。
Loop 顯示在 Interconnection View 中,這是內部區塊圖在 SysML v2 中的對應。行為:動作與狀態
SysML v1 的行為借自 UML:具有符記流語意的活動、狀態機,以及用於序列圖的互動。行為透過分配連結到執行它的結構,通常使用活動分割區(泳道)或 «allocate» 關係。
在 SysML v2 中,動作與狀態都是事件發生,就像零件一樣。動作定義具有輸入與輸出參數;接續(first … then …)提供順序,而流動說明步驟之間傳遞的是什麼。狀態定義具有狀態與轉移,轉移帶有觸發、防護條件與效果。零件 perform 一個動作並 exhibit 一個狀態,因此與結構的連結是語言的一部分,而不是另外加入的關係。
package PumpBehavior {
private import ISQ::*;
item def StartCommand;
item def StopCommand;
item def Coolant;
action def Circulate {
in item cold : Coolant;
out item warm : Coolant;
}
action def CoolEngine {
action pumpCoolant : Circulate;
action rejectHeat : Circulate;
flow pumpCoolant.warm to rejectHeat.cold;
first start then pumpCoolant;
first pumpCoolant then rejectHeat;
first rejectHeat then done;
}
state def PumpModes {
entry; then off;
state off;
state running;
transition first off accept StartCommand then running;
transition first running accept StopCommand then off;
}
part def Pump {
exhibit state modes : PumpModes;
}
}
| SysML v1 | SysML v2 |
|---|---|
| 具有動作、控制流與物件流的活動 | 具有動作用法、接續與 flow 的 action def |
| 分叉、結合、決策與合併節點 | fork、join、decide 與 merge |
| 呼叫行為動作 | 由另一個動作定義指定型別的動作用法 |
| 從活動到區塊的分割區或 «allocate» | 零件中的 perform |
| 由區塊擁有的狀態機 | state def,並在零件中使用 exhibit state |
| 具有觸發、防護條件與效果的轉移 | transition … accept … if … do … then … |
| 互動(序列圖) | 帶有 message 的事件發生,顯示在序列檢視中 |
PumpModes,由上面的文字繪製。需求與驗證案例
SysML v1 需求是帶有兩個字串的構造型類別:id 與文字。關係將它連接到模型的其他部分:satisfy、verify、derive、refine、trace 與 copy。測試案例是標記為 «testCase» 的行為。以數字檢查需求,需要在參數圖中另外建立約束區塊,而語言中沒有任何東西將該約束與需求的文字綁在一起。
在 SysML v2 中,需求定義是一種約束定義。它有一個主體(需求所針對的對象),可以有屬性(例如限制值),並包含必須成立的條件。doc 文字與條件位於同一個元素中。驗證案例在其目標中說明它所驗證的需求,並傳回判定。
package CoolingRequirements {
private import ScalarValues::*;
private import ISQ::*;
private import SI::*;
part def CoolingSystem {
attribute heatRejection : PowerValue;
}
part cooling : CoolingSystem {
attribute redefines heatRejection = 18 [kW];
}
requirement def <'CR-1'> HeatRejection {
doc /* The cooling system shall reject at least the engine's waste heat at full load. */
subject system : CoolingSystem;
attribute wasteHeat : PowerValue;
require constraint { system.heatRejection >= wasteHeat }
}
requirement coolingSpec : HeatRejection {
subject system : CoolingSystem;
attribute redefines wasteHeat = 15 [kW];
}
satisfy coolingSpec by cooling;
verification def <'VC-1'> HeatRunTest {
doc /* Run the engine at full load on a test stand and measure the heat the radiator rejects. */
subject system : CoolingSystem;
objective {
verify coolingSpec;
}
return verdict : Boolean = system.heatRejection >= coolingSpec.wasteHeat;
}
verification heatRun : HeatRunTest {
subject system = cooling;
}
}
<'CR-1'>是短名稱,也就是 v1 需求 id 在 v2 中的歸宿。require constraint是文字的可檢查形式。以 18 kW 對照 15 kW,會評估約束的工具會回報該需求已滿足。satisfy與verify保留其 v1 的意義。derive、refine 與 trace 對應到相依,或對應到巢狀於其他需求中的需求用法;由團隊決定如何建模。- SysML v2 為需求加入了假設(
assume constraint)、利害關係人與關注點,並在驗證案例之外加入使用案例與分析案例。
以檢視取代手繪的圖
SysML v1 的圖是由工具擁有的繪圖:由人選擇哪些元素出現以及出現在哪裡。同一個區塊的兩張圖可能對其內容有不同的說法,而圖的版面配置很少能在工具之間的交換中保留下來。後來的 v1 版本加入了檢視與觀點,但它們大多用於文件,而不是工程師每天繪製的圖。
在 SysML v2 中,檢視是模型的一個元素。它以 expose 指明要顯示什麼,以 filter 指明要包含哪些種類的元素,並指明以哪個標準檢視定義呈現。版面配置交給工具;檢視包含的內容則在模型中,並可在文字中讀取。
package CoolingViews {
private import StandardViewDefinitions::*;
part def Pump;
part def Radiator;
part def Loop {
part pump : Pump;
part radiator : Radiator;
connect pump to radiator;
}
view loopConnections : InterconnectionView {
expose Loop;
}
view structure : GeneralView {
filter @SysML::PartDefinition;
expose CoolingViews::*;
}
}
| SysML v1 圖 | SysML v2 檢視 |
|---|---|
| 區塊定義圖、套件圖、需求圖 | General View,搭配篩選 |
| 內部區塊圖 | Interconnection View |
| 活動圖 | Action Flow 檢視 |
| 狀態機圖 | 狀態轉換檢視 |
| 序列圖 | 序列檢視 |
| 參數圖 | 約束及其繫結的 General View 或 Interconnection View |
| 使用案例圖 | 使用案例與參與者的 General View |
| 表格與矩陣(在 v1 中依工具而定) | Grid View |
Systems Modeling API 與 JSON 交換
SysML v1 模型以 XMI 在工具之間移轉。XMI 是標準,但每個工具都會寫出自己的變體、構造型與圖資料,因此交換通常需要針對每一對工具進行測試,而且沒有標準的方式讓程式查詢存放在另一個工具中的模型。
SysML v2 附帶 Systems Modeling API and Services 規格。它定義了專案、分支、提交、元素與查詢的服務,以及一個 REST/HTTP 繫結,其中每個元素都是一個帶有 @id 與 @type 的 JSON 物件。其結果是:
- 腳本、儀表板或其他工具可以透過一個有文件說明的介面讀取與查詢模型,而不是透過廠商專屬的介面。
- 元素 id 隨模型一起移動,因此工具之間的連結可以在交換中保留下來。
- 模型以分支上的提交進行版本管理,就像原始碼一樣。
文字檔與 JSON 相輔相成:文字供人閱讀、審查與比較差異;JSON 則保留工具所依賴的 id。
將模型從 SysML v1 遷移到 v2
將 v1 模型移到 v2 是語言之間的翻譯,而不是檔案升級,而目標工具決定其中有多少能自動化:SysML v2 工具要檢查什麼 在其他檢查項目之外也涵蓋了 v1 匯入。典型模型的大部分內容可以直接對應,而有些部分以 v2 的方式重建,會比逐字翻譯更好。
可以直接對應的部分
- 套件及其巢狀結構。
- 區塊對應到零件定義,零件屬性對應到零件用法,參照屬性對應到
ref用法,一般化對應到特化。 - 值屬性對應到屬性;若 v1 的值型別有單位,則帶有量與單位。
- 具有流動屬性的介面區塊對應到埠定義;代理埠與完整埠對應到埠用法;連接器對應到連接或介面。
- 需求 id 與文字對應到短名稱與
doc;satisfy 與 verify 關係。 - 狀態機對應到狀態定義;結構良好的活動對應到具有接續與流動的動作定義。
需要重新思考的部分
- 情境特定的值。只為了設定某個值而建立的屬性專用型別、實例規格與重新定義,會變成用法上的一般重新定義。逐字翻譯會保留這些變通做法。
- 只有文字的需求。v2 允許這種需求,但好處來自加入條件。決定哪些需求要加上
require constraint。 - 約束區塊與參數圖。它們會變成約束定義與計算定義,通常直接寫成屬性上的運算式,就像上面的
totalMass一樣。 - 分配。在意義為「這個零件做這件事」之處,從行為到結構的活動分割區與 «allocate» 關係會變成
perform與exhibit。 - 較舊的埠種類。早期 v1 模型中的標準埠與流動埠需要最多的工作,因為 v2 只有一種埠概念。
- 設定檔與構造型。自訂構造型與標記值會變成中繼資料定義;它們的意義必須重新設計。
- 圖。版面配置不會帶過去。每張重要的圖都會變成一個檢視,其內容以
expose與filter重新表述。 - 不透明行為與工具腳本。以動作語言或工具腳本撰寫的程式碼無法翻譯;必須改寫或保留在模型之外。
像規劃任何模型變更一樣規劃遷移:先轉換一個具代表性的套件,與使用模型的人一起審查,為上述各點確定建模模式,然後轉換其餘部分。在 v2 模型經過審查之前,保留 v1 模型作為參考依據。將 SysML v1 模型移轉到 SysML v2 逐步說明這些步驟。
清單如何檢查
本頁的每份清單都以 Holarch Language Engine(Holarch 的 SysML v2 編輯器背後的引擎)在載入 SysML v2 標準庫的情況下剖析並檢查過,沒有錯誤也沒有警告。關於引擎支援哪些 SysML v2 結構及其已知缺口,請參閱 SysML v2 語言涵蓋範圍。如需較長的完整模型,請參閱 SysML v2 教學。
在 Holarch 中試試看
Holarch 有 SysML v2 專案(文字表示法與檢視編輯同一個模型)以及 LML 專案。若要將上面的清單當作模型閱讀:
- 建立一個 SysML v2 專案。請參閱 SysML v2 專案入門。
- 在 模型 → 編輯器 中,按一下 + 新增套件 並貼上一份清單。可以剖析的文字會在短暫停頓後套用,問題會就地標示。請參閱 編輯器。
- 開啟 圖 清單以查看檢視。請參閱 檢視參考資料。
SysML v1 模型。SysML v2 專案可以直接匯入 SysML 1.x 模型:在 模型 → 匯入和匯出 中,拖放一個 XMI 檔案(來自 Cameo Systems Modeler 或 MagicDraw、Enterprise Architect、Rhapsody 或 Papyrus),或一個 Cameo 或 MagicDraw 的 .mdzip 專案。Holarch 會將它轉換為 SysML v2 文字、檢查文字,並在任何內容變更之前顯示轉換報告,將每個元素標示為已轉換、已近似或已省略,並附上原因。圖的版面配置不會被轉換,因此請將結果視為進行上述重新思考的起點,而不是已完成的遷移。請參閱 匯入 SysML v1 模型。
LML 專案也能匯入 SysML 1.x XMI,並能將模型再匯出為 SysML 1.6 XMI 或 Papyrus .uml 檔案;在 Papyrus 中編輯過的檔案可以匯入回同一個專案,並依 XMI id 就地更新項目。請參閱 匯入 UML/SysML 模型 以及 與 Papyrus 往返交換。
下一步
- SysML v2 教學:以文字表示法逐步建立一個小型系統。
- SysML v2 工具:選擇之前要檢查什麼:適用於任何候選工具的檢查清單與測試模型。
- Holarch 中的 SysML v2 專案:文字、檢視與工程頁面都在同一個模型上。
- SysML v2 語言涵蓋範圍:引擎支援的內容及其已知缺口。
- 交換 SysML v2 模型:文字、JSON 與 Systems Modeling API 儲存庫。