可视化编排服务方法

更新时间:
复制 MD 格式

服务方法可以通过可视化的方式对服务进行逻辑编排。在服务编排过程中,您可以进行数据源能力的调用。编排完成后可以被前端页面调用,实现前端页面和后端服务的打通。本文介绍如何通过可视化的方式编排服务方法。

前提条件

  • 当前应用为轻应用。

  • 当前应用已添加依赖数据源,或当前应用有关联的限界上下文,且限界上下文中有已定义的应用服务。

  • 当前应用的版本状态处于开发中,尚未发布。

  • 当前账号具有应用开发权限。

编排服务方法

  1. 在服务编排页面,单击目标服务方法或目标服务方法右侧操作列下的编排服务方法。

  2. 在新打开的编排服务方法画布中,您可以通过以下两种方式选择目标流程节点和目标方法调用节点:

    • 方式一:

      1. 在画布右侧的逻辑流中单击1图标。画布中央已有默认的开始节点和结束节点,左侧面板列出可用的流程节点类型。

    • 方式二:

      1. 单击画布左侧的流程节点或方法调用节点页签。流程节点页签包含以下类别:调用(服务调用)、分支(If)、循环(ForEach、While、Break、Continue)、语句(变量赋值、打印日志、自定义脚本、结束节点)和异常(异常抛出)。

    说明
    • 画布中已经默认添加好开始节点和结束节点。

    • 本文以方式一的方式描述如何编排服务方法。

    您可以单击服务方法编排页面左上角的1图标,在服务方法下拉列表中选择目标服务方法。下拉列表中展示当前应用已定义的所有服务方法。

  3. 在选择节点对话框中的流程节点页签,您可以参考以下步骤配置流程节点:

    可切换至方法调用节点页签查看可用节点列表。

    关于节点的详细说明,请参见服务编排设计器内节点说明。

    说明

    以下枚举的配置项都支持新增变量:

    • 结束节点节点的流程出参变量赋值。

    • ForEach节点的集合变量。

    • 变量赋值节点的变量赋值。

    • If节点和设置表达式对话框中的插入变量。

    • 异常抛出节点的异常字段赋值。

    • 方法调用节点的返回值。

    • 可选:单击服务调用,在服务调用面板,完成节点名称、描述(可选填)、数据源、请求参数和返回值设置。其中接口路径支持配置请求方法(如GET)和路径。该区域提供Query参数和Header参数页签,可通过添加参数按钮新增参数条目。

      数据源下拉列表如果没有可选项,您可单击新增服务调用,在关联数据源面板,关联目标数据源,具体操作,请参见关联和管理依赖数据源。

      表达式支持在设置表达式对话框中设置。对话框左侧可展开插入函数和插入变量(包含入参变量、中间变量、静态变量三类),右侧为表达式编辑区域,支持算术运算符和比较运算符。

    • 可选:单击If,在If面板完成节点名称、描述(可选填)分支和分支条件设置(分支条件配置方式支持结构化和表达式),单击保存。面板中可通过添加分支新增条件分支,每个分支包含分支名称和节点编码字段,并提供删除分支操作和默认分支配置。

    • 可选:单击ForEach,在ForEach面板完成节点名称、集合变量和条目变量设置,单击保存。

      说明

      在逻辑编排节点的参数配置面板,系统将节点名称自动生成为相应逻辑编排节点的名称,且支持修改。

      ForEach面板包含遍历目标区域(集合变量下拉选择)和遍历条目区域(条目变量输入框)。

    • 可选:单击While,在While面板完成节点名称、描述(可选填)和条件配置方式(支持结构化和表达式两种方式)设置,单击保存。选择表达式方式时,面板提供包含插入变量和插入函数按钮的表达式编辑区域。

      说明

      表达式返回值需为Boolean类型。当表达式值为true时,循环内流程将重复执行。

    • 可选:单击变量赋值,在变量赋值面板完成节点名称和赋值设置,单击保存。赋值设置区域提供添加按钮,赋值列表包含赋值目标、操作、赋值方式和操作列。

      您可以按以下方式配置赋值设置。在编排画布中选中变量赋值节点后,右侧自动展开配置面板,通过添加按钮新增赋值条目,设置赋值目标和赋值方式。

      说明
      • 变量赋值节点支持调整赋值顺序。

      • 入参和中间变量都支持在赋值节点赋值。

    • 可选:单击打印日志,在打印日志面板完成节点名称、描述(可选填)和日志内容设置。日志内容使用表达式编辑器输入,支持通过插入变量和插入函数按钮引用变量和内置函数。

    • 可选:单击自定义脚本,在自定义脚本面板完成节点名称、描述(可选填)和自定义脚本设置。脚本编写规则及说明请单击点击此处。自定义脚本设置区域提供 Groovy 代码编辑器,默认包含脚本模板,可通过编辑代码按钮进入编辑。

    • 可选:单击异常抛出,在异常抛出面板完成节点名称、描述(可选填)和异常处理(条件配置方式支持结构化和表达式两种方式,你可以按需选择)设置。异常处理区域包含触发条件表达式编辑器,下方的异常字段区域可设置code和message字段的赋值方式。

  4. 在选择节点对话框中的方法调用节点页签,您可以参考以下步骤配置流程节点。

    说明
    • 您可调用依赖限界上下文中的应用服务方法,以及轻应用内用户自定义的服务方法及系统内置的服务方法。节点名称将默认为服务方法名称,您需要在调用节点内对入参赋值,并为方法输出绑定变量。

    • 对应用服务方法调用的节点中,您还能通过绑定变量的方式获取该服务调用返回值中的code、message信息。

    1. 单击目标应用服务方法,展开目标域下的服务方法列表,选择目标方法即可添加至编排流程。

    2. 在方法调用面板,设置显示名称、描述(可选填)、入参赋值、结果输出,在服务方法下拉列表中选择目标服务方法。

      说明
      • 在方法调用配置面板,系统将显示名称自动生成为相应方法的名称,且支持修改。

      • 方法调用节点的入参和出参都支持新增变量。

      • 如果出参在client层增加了response,在对话框中会增加错误信息输出配置项。

      • 如果入参的类型为:

        • 基本类型:支持通过值、变量、表达式赋值。

        • 集合类型:支持通过变量、表达式赋值。

        • 对象类型:支持通过变量、表达式赋值。

      • 新增服务调用节点的结果输出中默认只有output。

    3. 单击保存。

  5. 单击画布左侧变量管理页签,单击新增中间变量。

  6. 在新增变量对话框中,完成变量名称、变量类型和描述(非必填)设置后,单击确定。其中前两项为必填项,且类型通过下拉列表选择。

    说明

    在未创建结构对象时,新增变量的变量类型无法选择对象类型。

    在变量管理区域,您可以查看所创建的中间变量。

    • 您可以单击目标变量右侧1图标、1图标或1图标,编辑、复制或删除变量。将鼠标悬停在目标变量上时,右侧显示对应的操作图标。

    • 单击目标变量,在变量管理区域下侧,查看变量信息。

      如果变量的变量类型为集合类型或对象类型,您可以单击详情,在详情对话框中,查看变量的详细信息。详情对话框中展示变量的字段列表,包含参数名称、编码、类型和描述列。

  7. 可选:单击流程图中的目标节点,单击1图标或1图标,编辑或删除该节点信息。

  8. 单击画布右上角保存。

调试服务方法

  1. 在服务方法页面,单击目标服务方法右侧操作列下的编排服务方法。

  2. 在新打开的编排服务方法画布中,将鼠标移动至1(置灰)图标附近:

    • 如果提示请先修复校验错误再使用调试,请您按照画布下侧校验结果区域的提示,进行相应的编排修改后再使用调试功能。

    • 在新打开的编排服务方法画布中,将鼠标移动至1(高亮)图标附近,如果提示对当前流程进行验证调试,且画布下侧校验结果区域提示校验通过。单击1图标对服务方法进行调试。若存在校验错误,底部校验结果区域展示错误列表,包含问题类型、位置和详细信息列,需修复所有错误后方可使用调试功能。

      1. 在发起调试对话框中,在调试环境下拉列表中选择目标调试环境,mock场景默认值为不使用,在输入数据和期望返回数据(可选填)中完成相关配置后,单击确定。两者均为 JSON 格式的代码编辑器。

      2. 如果您想新增mock场景,请单击1图标,在设置mock场景对话框中,您可以按以下方式完成相关配置项设置,完成后单击保存。对话框左侧为场景列表,可通过添加场景新增。右侧配置mock场景名称,并切换模拟数据或模拟调用返回页签添加数据条目。

  3. 完成调试后,单击画布右上角的保存。

    您也可以回滚历史服务编排版本。单击画布右上角1图标,选择目标历史版本后,单击回滚(如果无需回滚,单击返回编辑即可)。右侧修改历史面板列出所有历史版本及修改时间,当前版本标记为当前版本。