如何在Matlab中收集嵌套函数的内部变量用于调试

核心实现逻辑 #

完全不需要解析函数源码文件，MATLAB自带的运行时反射接口即可实现参数名、值的自动获取，整体开销极低，几乎不会影响原有计算逻辑的耗时。

具体实现步骤 #

• 第一步：选择更安全的存储载体
  不推荐用全局变量，优先用persistent持久变量或者MATLAB的setappdata/getappdata接口存储收集到的变量结构体，避免全局变量命名冲突，读写速度也更快。
• 第二步：自动获取函数调用链信息
  用dbstack接口直接获取当前函数、父函数的名称，自动生成存储的键名，示例代码：

  % 放在收集工具函数内即可
  stack = dbstack(2); % 跳过工具函数自身的调用栈
  curr_func = stack(1).name;
  parent_func = stack(2).name;
  storage_key = [parent_func '_' curr_func];
  

• 第三步：自动采集输入参数名和值
  用nargin获取输入参数个数，inputname获取每个输入参数的名称，直接读取对应值即可：

  data_struct = getappdata(0, 'debug_collector');
  for idx = 1:nargin
      in_name = inputname(idx);
      % 直接读取调用方工作区的对应变量值
      in_val = evalin('caller', in_name);
      data_struct.(storage_key).(['input_' in_name]) = in_val;
  end
  

• 第四步：自动采集输出参数名和值
  R2021a及以上版本可以直接用outputname接口获取输出参数名，低版本可以通过预定义输出参数映射或者在函数出口遍历输出变量实现：

  for idx = 1:nargout
      out_name = outputname(idx);
      out_val = evalin('caller', out_name);
      data_struct.(storage_key).(['output_' out_name]) = out_val;
  end
  setappdata(0, 'debug_collector', data_struct);
  

优化建议 #

• 可以加一个全局开关变量，调试阶段开启收集，正式运行时直接关闭收集逻辑，零额外开销
• 支持自定义函数过滤规则，不需要收集的函数直接跳过，避免存储冗余数据
• 如果需要收集函数内部的临时变量，可以在需要的位置调用一次工具函数，指定要采集的变量名即可，不需要修改原有逻辑

内容的提问来源于stack exchange，提问作者Chewbaka