Dagu项目中参数传递与Shell变量引用的注意事项

在Dagu工作流引擎的使用过程中，参数传递和变量引用是一个常见但容易出错的操作。本文将通过一个实际案例，分析不同版本间行为差异的原因，并提供最佳实践建议。

问题现象分析

在Dagu 1.12.9版本中，以下工作流定义能够正常运行：

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
    depends:
      - get_param_using_jq

但当升级到1.16.2版本后，同样的工作流会出现输出异常。这种版本间的行为差异主要源于Dagu对Shell命令执行方式的改进。

技术背景解析

Shell变量引用的重要性

在Shell脚本中，变量引用时的引号使用对结果有重大影响。当变量包含空格或特殊字符时，不加引号的变量扩展会导致单词分割和通配符扩展，这通常不是我们期望的行为。

Dagu执行环境的演变

早期版本的Dagu在处理命令时可能采用了更简单的执行方式，而新版本为了增强功能性和安全性，默认在Shell环境中执行命令。这种改变使得Shell的变量扩展规则完全生效，从而暴露了原有工作流定义中的潜在问题。

解决方案与最佳实践

正确的变量引用方式

修正后的工作流应该如下：

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"
    depends:
      - get_param_using_jq

关键修改点是在echo命令中对变量$MY_PARAM_ARR添加了双引号。

通用建议

1. 始终引用变量：在Shell命令中使用变量时，应该养成添加双引号的习惯
2. 测试跨版本兼容性：升级Dagu版本后，应该全面测试现有工作流
3. 理解执行环境：明确知道命令是在何种环境下执行的，这有助于预测行为
4. 处理复杂数据结构：当处理JSON等复杂数据结构时，考虑使用jq等工具进行精确提取

总结

Dagu作为工作流引擎，在不同版本间的行为改进可能会影响现有工作流的执行。理解Shell环境下的变量引用规则，并采用防御性编程方法，可以确保工作流在不同版本间的稳定运行。对于从旧版本迁移的用户，建议全面检查工作流定义，特别是涉及变量引用的部分，确保符合Shell最佳实践。