元素命名
本章节介绍服务编排及其变量、图元、连线的命名要求。
服务编排命名
服务编排本身的名称,参照Java定义方法的命名规则:
- 驼峰命名,首字母小写,不要携带下划线。
- 动宾结构,例如,notifyOrderCompletion,错误样例OrderCompletionNotification。
- 尽量不用缩写,除非是专有名词,例如,invokeCRM,错误样例paymentCbk。
- 应简单明了,表示业务意义,而不是内部实现。例如,createPayment,错误样例InsertAndUpdatePayData。
变量命名
在服务编排流程中,除了系统的输入变量和输出变量,在服务编排流程使用的内部变量:
- 输入变量和输出变量:命名遵循接口设计文档的要求。
- 内部变量:元素命名遵循驼峰命名原则。
- 变量为单数时,命名包含对象名称(如Level1Catalog、Level2Catalog),变量为复数时命名包含集合名称(如Level1CatalogList或者Level2CatalogArray)。
- 数组型变量的下标命名要符合规范,当使用I、J、K等字母来命名时,需要明确变量含义,勿重复使用。
图元命名
服务编排图元的名称,采用动名短语形式,每个单词首字母大写,单词之间有空格。名称一般不要超过五个单词,短语尽可能简明,描述该图元的主要作用。例如Valid Input、Call Device Service。
连接线命名
在服务编排的图元中,除了Decision连接线外,其他图元的连接线采用系统的固定命名。
Decision连接线名称使用英文,采用单词首字母大写,一般不要超过三个单词。采用动名短语,尽可能简明、准确的描述该条件的判断逻辑。