指南 · 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 和文本的构造型类;约束单独存放在约束块中 | 需求是带有主体 (subject) 的约束;文本和可检查的条件位于同一个元素中 |
| 验证 | 通过 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 构造都被定义为该库中某项内容的特化。在实践中,这意味着:
- 结构和行为共享同一个基础。部件和动作都是随时间存在的发生项,因此部件可以执行 (perform) 动作或展现 (exhibit) 状态,无需单独的分配层。
- 各工具对模型含义的理解更加一致,因为含义位于规范及其库中,而不是各工具自己的解释中。
- 构造型不再是扩展机制。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 教程用它逐步构建一个完整的模型。文本改变了团队的工作方式:
- 模型可以逐行评审、用 diff 比较,并与其他工程数据一起纳入版本控制。
- 工程师可以快速输入模型,在模型之间复制模式,并用脚本生成模型的部分内容。
- 模型可以像源代码一样检查:未解析的名称、错误的单位和不匹配的端口会在出现的位置报告。
文本表示法并不取代图。它使模型成为主要工件,而图成为模型的视图,如下文所述。
标准库、量和单位
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,即内部块图在 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 视图 |
|---|---|
| 块定义图、包图、需求图 | 带过滤器的一般视图 |
| 内部块图 | 互连视图 |
| 活动图 | 动作流视图 |
| 状态机图 | 状态转换视图 |
| 序列图 | 序列视图 |
| 参数图 | 约束及其绑定的一般视图或互连视图 |
| 用例图 | 用例和参与者的一般视图 |
| 表格和矩阵(在 v1 中因工具而异) | 网格视图 |
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 逐步介绍了这些步骤。
代码清单是如何检查的
本页的每个代码清单都已在加载 SysML v2 标准库的情况下,用 Holarch Language Engine(Holarch 的 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 存储库。