6
Debugging NodeJS C++ addons using VS Code

之前笔者写了一篇 用NAN写一个nodejs的c++扩展, 实际开发过程中,肯定是有单步调试的需求。这里简单介绍用如何用vscode调试node.js c++扩展。一般要调试某个程序,为了能清晰地看到调试的每一行代码、调用的堆栈信息、变量名和函数名等信息,需要待调试程序地 调试符号 信息。比如我们在使用GCC编译程序的时候,如果加上 -g 选项即可在编译后的程序中保留所有的调试符号信息。假如我们有一个hello_world.c的源文件,我们可以通过gcc -g -o hello_world hello_world.c生成一个带调试信息的hello_world程序。类似的,如果我们想要调试node.js扩展,我们也需要扩展源文件的调试符号信息。

生成带有调试信息的扩展

之前我们通过node-gyp来调用对应的工具来编译项目,想要生成调试符号信息也应该从node-gyp的文档入手,从node-gyp的command options部分可以看到node-gyp支持--debug选项。我们可以通过node-gyp rebuild --debug来生成带有调试信息的node扩展,如果不加--debug表示生成的是一个release扩展。我们在原来项目的package.json文件的scripts部分中增加两个任务,如下:
clipboard.png

执行npm run rebuild会生成一个build/Release目录。执行npm run rebuild:dev会生成一个build/Debug目录。

配置vscode

vscode安装lldb插件

这里我们将用lldb来调试node扩展。这里我们需要在vscode中安装lldb扩展。安装的过程参考vscode-lldb ,这里不再赘述。

配置vscode task

Cmd+Shift+P 输入configure task配置一个任务,该任务会执行npm run rebuild:dev,生成带调试信息的node扩展文件。笔者的配置如下:

{
    "version": "2.0.0",
    "tasks": [
        {
            "type": "npm",
            "script": "rebuild:dev",
            "problemMatcher": []
        }
    ]
}

配置vscode 调试

点击debug按钮之后,下面在launch.json中配置调试node扩展的任务,注意在配置的时候增加一个preLaunchTask任务,该任务就是我们上一步配置的。最终luanch.json配置如下:

{
  "version": "0.2.0",
  "configurations": [{
     "type": "lldb",
     "request": "launch",
     "name": "Launch Program",
     "preLaunchTask": "npm: build:dev",
     "program": "/absolute/path/to/node",
     "args": [
        "/absolute/path/to/your/index.js"
     ]
  }]
}

launch.json可以看到整个调试的过程为:vscode插件调用lldb,启动nodejs去执行/absolute/path/to/your/index.js,在js文件中会调用node扩展,而该部分扩展已经包含了调试信息,故而可以用于调试。

调试node扩展

这里为了调试node扩展,我们写了一个demo用于引用Debug版本的node扩展,如下:

const addon = require('../build/Debug/sum')
console.log(addon.sum(1,2))

clipboard.png

项目地址:https://github.com/warjiang/d...


warjiang
572 声望14 粉丝

« 上一篇
memwatch分析