打印日志

打印日志 用于在流程运行时输出一段日志内容。它适合记录关键步骤、打印变量值、标记流程进度，帮助你在调试和排查问题时快速定位执行状态。

指令标识：Comment
指令类型：通用指令
指令描述：该指令用于在测试执行过程中打印日志信息，便于调试和监控。

先选使用方式

工作流支持「可视化编排」和「代码编排」两种创建方式。打印日志 在两种方式里都能用，核心业务参数一致，区别主要是你通过界面配置，还是通过 Python 脚本配置。

方式	怎么用	适合人群
可视化编排（推荐先学）	拖入「打印日志」节点，在右侧表单填写日志内容	大多数用户，零代码，适合快速搭建和调试
代码编排（Python）	在脚本中调用 `bots.comment(message="流程开始")`	熟悉代码、需要复用脚本或批量生成流程的用户

第一次使用建议先用可视化编排跑通，再迁移到 Python 代码编排。下方「参数说明」同时给出界面字段和代码参数名，方便两种方式对应。

什么时候用？

需要在流程关键步骤打印运行状态，例如「开始登录」「表单提交完成」。
需要输出变量值、中间结果，辅助确认数据是否正确。
需要在异常处理或分支流程中留下诊断信息。
需要用日志标记流程分界点，提高长流程的可读性。

使用前确认

「日志内容」不能为空，建议写清楚当前步骤和关键变量。
如需输出变量值，确认变量已经在前置节点中赋值。
日志内容里出现 ${variableName} 这类变量引用时，建议确认变量名拼写正确。

可视化编排：从 0 到跑通

下面用一个常见场景演示：在后台表单提交前打印当前步骤日志。按 4 步即可跑起来：

在工作流画布中添加 打印日志 指令。
在 日志内容 中填写要输出的文本，例如：

准备提交商品信息表单

如需后续引用这段日志内容，在 将结果保存至 中填写变量名，例如 logMessage。
点击运行，查看控制台或运行日志中是否出现该内容。

参数说明

输入参数

界面名称	代码属性名	类型	必填	默认值	说明
日志内容	`message`	String	是	-	要打印输出的日志内容信息，不能为空，例如 `这是一条测试日志`。

输出参数

界面名称	代码属性名	类型	必填	说明
将结果保存至	`outKey`	String	否	保存打印日志内容的输出变量名。

成功标准

节点正常执行，没有提示日志内容为空。
控制台或运行日志中能看到配置的日志内容。
如果配置了「将结果保存至」，对应变量中保存了日志内容。

运行后你会看到（以上面场景为例）：

日志中出现 准备提交商品信息表单。
如果设置 outKey="logMessage"，后续节点可以引用该变量。

失败排查

现象 / 报错原文	可能原因	处理建议
日志内容为空或未输出	`message` 未填写，或变量引用结果为空	检查「日志内容」是否填写；确认变量已赋值
日志内容不是预期值	引用变量名写错或前置节点输出不正确	核对 `${variableName}` 的变量名和前置节点结果
后续节点拿不到日志内容	未配置「将结果保存至」	在输出参数中填写 `outKey` 变量名
多行内容显示不符合预期	换行符或特殊字符未按预期解析	简化日志内容，或拆成多个「打印日志」节点输出

Python 代码编排

代码编排以 Python 为主。运行上下文由代码编排模板创建，示例里只需要关注业务指令本身。

# 打印一条流程日志
bots.comment(message="准备提交商品信息表单")

如果后续流程需要复用日志内容，可以保存到变量：

bots.comment(
    message="表单校验完成",
    outKey="logMessage",
)

可视化表单里的「日志内容」「将结果保存至」分别对应代码里的 message、outKey。

如果你想在工作流中通过节点动态编排指令，可使用执行指令（XML）节点。

常见问题

Q1：日志内容是否支持变量引用？

A：支持。可以在日志内容中使用 ${variableName} 的方式引用变量值。

Q2：日志会输出到哪里？

A：执行该指令后，系统会在控制台和运行日志中输出指定日志内容；如果配置了输出变量，也会将内容保存到变量中。

Q3：日志内容是否可以为空？

A：不可以。message 是必填参数，不能为 空 或 null。

Q4：如何在日志中输出多行内容？

A：可以在日志内容中使用换行符或特殊字符，也可以多次调用打印日志指令输出多条日志。