VSCode 远程调试

支持的语言

语言	依赖插件	开发镜像依赖
Java	Debugger for Java	N/A
Go	Go	dlv
Python	Python	debugpy
PHP	PHP Debug	xdebug
Node.js	N/A	N/A
Ruby	Ruby	ruby-debug-ide

插件配置

Java

Java开发工具包的路径可以通过VS Code设置（工作区/用户设置）中的java.home设置来指定。 如果未指定，它将在以下顺序中搜索，直到一个 JDK 满足当前的最低要求，插件jdk 配置，请参阅Setting the JDK。

• JDK_HOME环境变量
• JAVA_HOME环境变量
• 在当前系统路径上

Go

该扩展使用了一些由Go社区开发的命令行工具，特别是go、gopls和dlv必须安装，以便该扩展能够正常工作。 有关扩展所依赖的工具的完整列表，请参阅Tools documentation。

In order to locate these command-line tools, the extension searches GOPATH/bin and directories specified in the PATH environment variable (or Path on Windows) with which the VS Code process has started. 如果没有找到这些工具，该插件将提示你安装缺少的工具，并在右下角显示"⚠️ Analysis Tools Missing"警告。 请通过响应警告通知或手动运行 "Go: Install/Update Tools " 命令来安装它们。

调试流程

1. 选择您想要调试的工作负载
2. 右键点击workload并选择 Dev Config，编辑您的调试配置
3. 然后右键再次点击此工作负载并选择 Remote Debug
4. Nocalhost 会在第一次debug时，自动下载依赖插件
5. Nocalhost 将自动进入 DevMode 并开始远程调试

配置内容

不同的开发人员的开发环境是不同的。 你应该根据实际情况来配置远程调试的配置。

配置示例

Java

Nocalhost Configs

name: java-remote-debugging

serviceType: deployment

containers:

- name: ""

dev:

...

command:

debug:

- ./debug.sh

debug:

remoteDebugPort: 5005

...

Maven Example

The shell command for Maven example:

jdk >= 1.8 and springBoot >=2.2.1.RELEASE

mvn spring-boot:run -Dspring-boot.run.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005"

For jdk <=1.7 you should replace -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 with -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005

For lower version of the springBoot you should replace -Drun.jvmArguments with -Dspring-boot.run.jvmArguments

Gradle Example

The startup command for Gradle example:

Gradle's debug.sh

./gradlew bootRun --debug-jvm --no-daemon

Python

Nocalhost Configs

name: python-remote-debugging

serviceType: deployment

containers:

- name: ""

dev:

...

command:

debug:

- ./debug.sh

debug:

remoteDebugPort: 9009

...

VSCode

debug.sh

#! /bin/sh

pip3 install --no-cache-dir -r ./requirements.txt

export DEBUG_DEV=0

export FLASK_DEBUG=0

export FLASK_ENV=development

flask run --host=0.0.0.0 --port=9999

Jetbrains

debug.sh

#! /bin/sh

pip3 install --no-cache-dir -r ./requirements.txt

python -m debugpy --listen 9009 --wait-for-client productpage.py 9080

How does it Works?

Nocalhost using pydevd to debug Python application.

Python 远程调试原理

Go

Nocalhost Configs

name: go-remote-debugging

serviceType: deployment

containers:

- name: ""

dev:

...

command:

debug:

- ./debug.sh

debug:

remoteDebugPort: 9009

...

debug.sh

#! /bin/sh

export GOPROXY=https://goproxy.cn

dlv --headless --log --listen :9009 --api-version 2 --accept-multiclient debug app.go

PHP

Nocalhost Configs

name: php-remote-debugging

serviceType: deployment

containers:

- name: ""

dev:

...

command:

debug:

- ./debug.sh

debug:

remoteDebugPort: 9003

...

debug.sh

#！/bin/sh

php -t ./ -S 0.0.0.0:9999;

How does it works?

Nocalhost using Xdebug to debug PHP applications.

PHP 远程调试原理

Node.js

Nocalhost Configs

name: nodejs-remote-debugging

serviceType: deployment

containers:

- name: ""

dev:

...

command:

debug:

- ./debug.sh

debug:

remoteDebugPort: 9229

...

debug.sh

#！/bin/sh

npm install

node --inspect=0.0.0.0:9229 ./index.js

Ruby

Nocalhost Configs

name: nodejs-remote-debugging

serviceType: deployment

containers:

- name: ""

dev:

...

command:

debug:

- ./debug.sh

debug:

remoteDebugPort: 9001

...

debug.sh

#！/bin/sh

rdebug-ide -h 0.0.0.0 -p 9001 -- details.rb 9080

IDE 中的调试配置

VSCode debug 配置

调试结束后，Nocalhost会自动配置vscode的 launch.json，下次你可以用快捷键F5直接启动调试。

Debug 参数

debug支持自定义参数启动，你只需要在launch.json中的configurations下添加参数，当debug启动时，插件将把参数传递给调试器。

如果你需要在调试 Node.js 应用程序时启用诊断输出, 你只需要更改以下配置。

launch.json

{

"version": "0.2.0",

"configurations": [

{

"type": "nocalhost",

"request": "attach",

"name": "Nocalhost Debug",

"trace": true

}

]

}

支持的调试参数

• Java: Debugger for Java
• Go: Go
• Python: Python
• PHP: PHP Debug
• Node.js: VSCode
• Ruby: Ruby

FAQ

Java 调试器停在java.lang.reflect.Method.class 文件的 return ma.invoke(obj, args)。

执行命令 Java: Clean the Java language server workspace