如何在VSCode中远程交互式调试Linux机器上的Perl CGI脚本

1. 远程机器CGI环境调试前置配置 #

• 调整Web服务器（如Apache）配置：找到目标CGI脚本所在目录的配置段，添加Options +ExecCGI +FollowSymLinks，确保AddHandler cgi-script .pl已启用，重启Web服务器生效。
• 安装调试依赖模块：在远程机器执行cpanm Devel::RemoteDebug，确保Perl具备远程调试能力。
• 开放调试端口：如果使用自定义端口（如1234），在远程机器防火墙添加规则允许出站连接该端口，比如iptables -A OUTPUT -p tcp --dport 1234 -j ACCEPT。

2. 修改CGI脚本添加调试触发代码 #

在目标Perl CGI脚本的最开头插入以下代码，让脚本启动后等待VSCode的调试连接：

use Devel::RemoteDebug;
# 替换为你的本地机器IP（远程机器可访问的地址），端口和后续launch.json保持一致
Devel::RemoteDebug->start(host => '192.168.x.x', port => 1234, wait => 1);

如果本地机器不在远程机器的局域网内，可通过SSH反向隧道实现：本地执行ssh -R 1234:localhost:1234 远程用户名@远程IP，此时脚本中的host可设为localhost。

3. 配置VSCode的launch.json #

在远程SSH连接的VSCode工作区中，创建或修改.vscode/launch.json，添加以下调试配置：

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "perl",
            "request": "attach",
            "name": "Attach to Remote CGI",
            "host": "远程Linux机器IP",
            "port": 1234,
            "localRoot": "${workspaceFolder}",
            "remoteRoot": "/var/www/cgi-bin", // 替换为远程CGI脚本所在的绝对路径
            "stopOnEntry": false
        }
    ]
}

• remoteRoot必须填写远程机器上CGI脚本所在目录的绝对路径，确保本地与远程文件路径映射正确。
• port需和脚本中指定的端口完全一致。

4. 启动调试流程 #

• 在VSCode中打开目标CGI脚本，点击行号左侧设置断点。
• 在VSCode调试面板选择Attach to Remote CGI配置，启动调试会话。
• 用浏览器或Postman构造带POST参数的请求，访问该CGI脚本的URL（如http://远程IP/cgi-bin/test.pl）。
• 此时VSCode会触发断点暂停，即可进行交互式调试（查看变量、单步执行、调用栈跟踪等操作）。

关键注意事项 #

• 调试完成后务必移除脚本中的调试代码，避免影响生产环境的脚本运行。
• 确保Web服务器运行用户（如apache、www-data）拥有连接调试端口的权限，必要时调整用户权限或防火墙规则。
• 如果调试连接失败，检查本地与远程的网络连通性、端口是否被占用、路径映射是否正确。

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