Bolt.js 工作流开发：如何获取表单变量并传递到自定义步骤

在 Slack 应用开发中，Bolt.js 框架提供了强大的工作流功能，允许开发者创建包含表单收集和自定义处理的自动化流程。本文将详细介绍如何正确配置工作流表单变量，并将其传递到自定义步骤中进行处理。

工作流变量传递的基本原理

Slack 工作流中的表单收集步骤与自定义步骤之间的变量传递遵循以下机制：

1. 变量类型匹配：表单字段类型必须与自定义步骤的输入参数类型兼容
2. 参数映射：在工作流构建器中通过 {} 下拉菜单显式建立变量引用关系
3. 后端接收：Bolt.js 函数通过 inputs 参数接收前端传递的变量

典型实现步骤

1. 定义函数输入参数

在应用的 manifest.json 文件中，需要明确定义自定义步骤的输入参数：

"functions": {
  "sample_step": {
    "input_parameters": {
      "variable_a": {
        "type": "string",
        "title": "Variable A",
        "is_required": true
      }
    }
  }
}

参数类型支持 string、number、boolean 等基本类型，必须与表单字段类型匹配。

2. 工作流配置

在工作流构建器中：

1. 添加表单收集步骤，配置所需字段（如短文本、下拉菜单等）
2. 添加自定义步骤，在输入参数处点击 {} 图标
3. 从下拉菜单中选择对应的表单变量

3. 后端处理代码

在 Bolt.js 应用中，通过以下方式接收和处理变量：

app.function('sample_step', async ({ inputs }) => {
  // 访问表单变量
  const variableA = inputs.variable_a;
  
  // 处理逻辑...
});

常见问题解决方案

类型不匹配错误

当出现变量传递错误时，首先检查：

1. 表单字段类型是否与输入参数类型兼容
   • 短文本 → string
   • 数字输入 → number
   • 单选按钮 → string
2. 变量名称是否完全匹配（注意大小写）

调试建议

1. 创建全新的测试应用和工作流，排除历史配置干扰
2. 检查 manifest.json 语法是否正确
3. 确保工作流步骤间的变量引用关系正确建立

最佳实践

1. 命名规范：保持变量命名一致，使用下划线命名法
2. 类型验证：在后端代码中添加类型检查逻辑
3. 错误处理：为自定义步骤添加完善的错误处理和日志记录
4. 文档记录：为每个输入参数添加清晰的描述信息

通过以上方法，开发者可以可靠地在 Bolt.js 工作流中实现表单数据到自定义步骤的传递，构建复杂的自动化业务流程。