StepMessage

简介

引擎用于描述消息在集成流中各个节点之间传递的数据结构。

坐标:com.alibaba.bwif.script.core.StepMessage。

结构说明

属性

类型

说明

id

String

消息的唯一标识,每个节点的输入消息和输出消息ID都不同。

attribute

Map

  • 用途:保存在此次运行时,该节点配置的具体值。

  • 获取内容:脚本中可通过getAttribute()取出内容。

  • 修改内容:节点执行成功后,引擎自动赋值;不支持开发人员对其内容赋值的功能。

payload

Object

  • 用途:消息正文。例如:HTTP请求节点的输出消息,payload内容为对端应用接口的HTTP Response内容。不同类型的节点会产生对应类型的payload,需要详见各种节点的帮助说明。

  • 获取内容:脚本中可通过getPayload()取出内容。

  • 修改内容:节点执行成功后,引擎自动赋值;脚本中不支持对payload赋值;只能通过设置payload节点进行操作。

variable

Map

  • 用途:变量。用于消息在流中传递的过程中,暂存的中间值。

  • 获取内容:脚本中可通过getVariable()取出内容。

  • 修改内容:主要由开发人员在流设计器中指定,需要通过设置变量、删除变量节点进行操作,部分节点在执行时也会使用(例如遍历节点),需详见对应的节点说明。脚本中不支持对variable内容进行修改和删除。

error

StepException

保存错误信息。

构造方式

只能由集成流引擎构造,不支持在脚本中构造。

方法列表

方法

说明

String getTrackId()

是流运行一次的标识,即在调试器中与运行日志的TraceID对应。

String getId()

标识每个节点消息的唯一ID,每经过一个处理节点ID会变化。

Object getPayload()

获取Payload。返回对象为 Object 需要自己转换,例如:HttpRequest request= message.getPayload()。

Map getVariable()

变量为Map类型。

Map getAttribute()

节点的配置属性,记录节点的配置信息,连接器节点连接器的配置参数在这里体现。

StepException getError()

错误信息为上一个节点向下传递,参见 com.alibaba.bwif.script.core.StepException。