VS Code远程调试Java Web应用时无法加载源码/调试符号

环境配置 #

• Java版本：java 8.0.352-zulu
• 远程机器：运行启用JPDA的Tomcat 7（端口8000）
• 本地机器：搭载VS Code的macOS，通过SSH隧道调试
• 构建工具：maven 3.8.1
• IDE：VS Code v1.96.4
• 调试配置：VS Code + Debugger for Java扩展v0.58.1

已执行步骤 #

1. 配置maven-compiler-plugin确保编译类包含调试符号：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
                <debug>true</debug>
                <debugLevel>lines,vars,source</debugLevel>
            </configuration>
        </plugin>
    </plugins>
</build>

2. 远程机器启用Tomcat远程调试：

$ export JPDA_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000"
$ su - user001 -c "$CATALINA_HOME/bin/catalina.sh jpda run"

3. 建立SSH隧道转发调试端口：

% ssh -L 8000:localhost:8000 user001@remote-server-ip

4. 配置VS Code的launch.json：

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "java",
      "request": "attach",
      "name": "Attach to Local Tunnel",
      "hostName": "localhost",
      "port": 8000,
      "sourcePaths": [
        "/absolute/path/to/my/source/code/src/main/java"
      ]
    }
  ]
}

5. 验证远程.class文件包含调试符号：

$ javap -v $CATALINA_HOME/webapps/myapp/WEB-INF/classes/com/myapp/reporting/ReportServiceImpl.class | grep "LineNumberTable"

执行后确认LineNumberTable存在。
6. 启动VS Code调试会话，成功连接并触发断点。

问题现象 #

调试器成功连接，断点能触发，但VS Code无法加载对应的源文件。

已尝试但无效的操作 #

• 重启VS Code，删除.vscode设置并重新创建launch.json
• 重新构建并部署含调试符号的Web应用至Tomcat
• 用netstat -tulnp | grep 8000确认远程端口开放
• 用nc -vz localhost 8000验证本地SSH隧道正常

解决方案建议 #

1. 检查sourcePaths路径的准确性与完整性 #

• 确认sourcePaths中的路径是本地源码的绝对路径，且包含所有需要调试的源码目录（比如src/main/resources下的配置类若需调试也需添加）。
• 尝试使用相对路径（相对于VS Code工作区根目录）替代绝对路径，例如：

  "sourcePaths": [
    "${workspaceFolder}/src/main/java"
  ]
  

2. 配置classPaths关联远程类文件 #

在launch.json中添加classPaths字段，指向本地编译后的class文件目录（或远程部署的classes目录的本地副本），帮助调试器关联源码与类文件：

{
  "type": "java",
  "request": "attach",
  "name": "Attach to Local Tunnel",
  "hostName": "localhost",
  "port": 8000,
  "sourcePaths": [
    "${workspaceFolder}/src/main/java"
  ],
  "classPaths": [
    "${workspaceFolder}/target/classes",
    "/path/to/local/copy/of/remote/webapps/myapp/WEB-INF/classes"
  ]
}

3. 确保源码与远程部署类版本完全一致 #

• 本地源码和远程Tomcat上的.class文件必须完全匹配，哪怕是空格、注释的改动都可能导致行号不匹配，调试器无法映射源码。
• 重新构建时执行mvn clean install，清理残留的旧class文件后再部署到远程Tomcat。

4. 调整VS Code Java调试扩展设置 #

• 打开VS Code设置，搜索Java > Debug > Source Lookup: Use Java Debug Server，切换该选项的开启/关闭状态后重启调试会话。
• 检查Java > Debug > Show Inferred Breakpoints是否开启，确保断点是明确设置在源码行上，而非推断断点。

5. 手动指定源码映射 #

断点触发后，若VS Code弹出“找不到源文件”提示，点击“编辑源查找路径”，手动添加本地源码目录，或直接选择对应的源文件进行临时映射，验证是否能正常加载。

6. 补充JPDA启动参数的源码路径 #

修改远程Tomcat的JPDA参数，添加源码路径配置（可选，作为本地sourcePaths的补充验证）：

export JPDA_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000,sourcepath=/path/to/remote/source/code"

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