Dagu项目中参数传递机制变更引发的兼容性问题分析

在Dagu工作流引擎的使用过程中，开发者可能会遇到参数传递方式在不同版本间的兼容性问题。本文将以一个典型场景为例，深入剖析参数处理机制的变化及其解决方案。

问题现象

在Dagu 1.12.9版本中，通过jq处理器提取JSON数组参数后，可以直接在后续命令中使用该参数。示例工作流如下：

params: REQUEST_BODY={}
steps:
  - name: get_param_using_jq
    executor:
      type: jq
      config:
        raw: true
    command: '.MyParamArr'
    script: ${REQUEST_BODY}
    output: MY_PARAM_ARR
  - name: print_param
    command: echo $MY_PARAM_ARR

当传入REQUEST_BODY={"MyParamArr":["foo","bar"]}时，1.12.9版本能正确输出数组内容，但在1.16.2版本中会出现输出异常。

技术背景

这个问题本质上涉及三个技术层面：

1. Shell参数扩展：在Unix-like系统中，不带引号的变量扩展会进行单词分割和通配符扩展
2. JSON数组表示：jq处理器输出的数组格式包含空格分隔的元素
3. Dagu执行环境：新版本默认在shell环境下执行命令

根本原因

Dagu 1.16.2版本引入了一项重要变更：所有命令默认在shell环境下执行。这一变化导致：

1. 当MY_PARAM_ARR包含数组值如"foo bar"时
2. 未加引号的$MY_PARAM_ARR会被shell进行单词分割
3. 最终echo命令接收到的是被分割后的多个参数

解决方案

正确的做法是始终对可能包含空格或特殊字符的变量添加双引号：

command: echo "$MY_PARAM_ARR"

这种写法可以保证：

• 数组元素中的空格被正确保留
• 不会发生意外的单词分割
• 与shell的最佳实践保持一致

最佳实践建议

1. 变量引用规范：始终用双引号包裹变量引用
2. 版本升级检查：升级Dagu版本时，检查所有参数传递逻辑
3. 复杂数据处理：对于复杂数据结构，考虑使用base64编码传输
4. 测试验证：在CI/CD流程中加入参数传递的测试用例

总结

这个案例展示了基础设施升级时可能带来的微妙兼容性问题。理解shell的参数扩展机制和Dagu的执行环境变化，可以帮助开发者编写出更健壮的工作流定义。记住：在shell环境中处理可能包含特殊字符的数据时，引号的使用不是可选项，而是必须项。

对于使用Dagu的开发团队，建议建立版本升级检查清单，特别关注参数传递和命令执行方面的变更，以确保工作流定义在不同版本间的行为一致性。