讲师中心 微信公众号
AI工具推荐 视频效率加速

VSCode调试协议剖析_自定义调试器适配器开发

星婷大大_8520

星婷大大_8520

发布时间:2025-11-19 15:46:02

|

739人浏览过

|

来源于php中文网

原创

DAP是VSCode调试核心协议,通过JSON-RPC实现编辑器与调试适配器通信。文章解析其机制并指导用Node.js实现支持launch和continue的简单适配器,涵盖消息解析、响应发送、事件上报及插件注册流程。

vscode调试协议剖析_自定义调试器适配器开发

VSCode 的调试功能强大,背后依赖的是 Debug Adapter Protocol(DAP),即调试适配器协议。要开发自定义调试器并集成到 VSCode 中,理解 DAP 是关键。本文剖析该协议机制,并指导如何实现一个简单的自定义调试适配器。

什么是 Debug Adapter Protocol (DAP)

DAP 是一种基于 JSON 的通信协议,运行在 VSCode 编辑器(前端)与 调试适配器(后端)之间。它的设计目标是解耦编辑器和具体语言的调试逻辑,使得任意语言只要提供符合 DAP 规范的调试适配器,就能在 VSCode 中获得完整的调试支持。

通信通常通过标准输入输出(stdin/stdout)进行,使用带有 Content-Length 头的 JSON-RPC 消息格式。例如:

Content-Length: 134\r\n\r\n{"type":"request","command":"launch","arguments":{"program":"app.js"},"seq":1,"command":"launch"}

VSCode 发送请求,调试适配器接收并返回响应或发送事件(如断点命中、线程启动等)。

调试会话的生命周期

一次调试会话从用户点击“启动调试”开始,VSCode 根据 launch.json 配置启动调试适配器进程,并建立通信通道。

主要流程如下:

  • VSCode 启动调试适配器可执行文件(比如用 Node.js 或 Python 写的脚本)
  • 双方通过 stdin/stdout 交换初始化消息(initialize)
  • VSCode 发送 launch 或 attach 请求,启动目标程序
  • 适配器控制被调试程序,遇到事件时主动发送 stopped、output 等事件
  • 用户操作(继续、单步、查看变量)触发新的 request,适配器响应
  • 程序结束或用户停止,适配器退出,会话终止

实现一个简单调试适配器

以 Node.js 为例,编写一个最简调试适配器,支持 launch 和基本 continue 操作。

步骤 1:创建基础结构

前端开发
前端开发

ys-agent 前端(frontend/)功能迭代的工程规范守门 skill。当任何 agent 接到 ys-agent 前端相关任务时——新增页面、新增组件、加 API、加 Pinia store、改路由、写 mock、调整布局、修改样式、对接后端接口、迁移 demo 代码、做主题、加权限、写公共组件、做数据可视化、做表单、做弹窗、做表格、做搜索过滤、调 Element Plus 用法、做响应式、做性能优化,或仅仅是在 frontend/ 目录下编辑任何 .vue / .ts / .scss / .c

下载

新建文件 debugAdapter.js,监听 stdin 输入:

const readline = require('readline'); let seq = 0; const rl = readline.createInterface({ input: process.stdin, output: process.stdout }); rl.on('line', line => { if (line.startsWith('Content-Length')) { // 解析带长度头的消息 const match = line.match(/Content-Length: (\d+)/); if (match) { const len = parseInt(match[1]); // 下一行是空行,再下一行是 JSON rl.once('line', () => { rl.once('line', jsonLine => { handleMessage(JSON.parse(jsonLine)); }); }); } } });

步骤 2:处理 initialize 请求

function handleMessage(msg) { switch (msg.command) { case 'initialize': sendResponse(msg.seq, { supportsConfigurationDoneRequest: true, supportsEvaluateForHovers: true }); break; case 'launch': handleLaunch(msg); break; case 'continue': handleContinue(msg); break; case 'disconnect': process.exit(0); } } function sendResponse(seq, body) { const resp = { type: 'response', seq: ++seq, request_seq: seq, command: msg.command, success: true, body }; sendRaw(JSON.stringify(resp)); } function sendRaw(jsonStr) { process.stdout.write(`Content-Length: ${Buffer.byteLength(jsonStr)}\r\n\r\n${jsonStr}`); }

步骤 3:模拟 launch 与事件上报

function handleLaunch(req) { sendEvent('initialized'); // 通知 VSCode 可以设置断点了 sendResponse(req.seq, {}); } function sendEvent(event, body) { const msg = { type: 'event', event, seq: ++seq, body }; sendRaw(JSON.stringify(msg)); }

当收到 launch 后,发送 initialized 事件,VSCode 接着会发送 setBreakpoints 请求(需实现),但本例略去。

注册适配器到 VSCode

修改 package.json 插件配置:

"contributes": { "debuggers": [{ "type": "my-debug", "label": "My Debugger", "programs": { "adapter": "./out/debugAdapter.js" }, "configurationAttributes": { "launch": { "required": ["program"], "properties": { "program": { "type": "string", "description": "The program to debug" } } } }, "initialConfigurations": [ { "name": "Launch Program", "type": "my-debug", "request": "launch", "program": "${workspaceFolder}/app.js" } ] }] }

安装插件后,即可选择 “my-debug” 类型启动调试。

基本上就这些。真正实用的适配器需要对接实际解释器或运行时(如 V8、GDB、Python 的 pdb),解析源码映射、管理调用栈、变量作用域等。但核心通信模型不变 —— 实现 DAP 协议规定的 request、response、event 交互。

热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2195

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3462

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1156

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

3999

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

6779

2023.08.02

switch语句用法
switch语句用法

switch语句用法:1、Switch语句只能用于整数类型,枚举类型和String类型,不能用于浮点数类型和布尔类型;2、每个case语句后面必须跟着一个break语句,以防止执行其他case的代码块,没有break语句,将会继续执行下一个case的代码块;3、可以在一个case语句中匹配多个值,使用逗号分隔;4、Switch语句中的default代码块是可选的等等。

1071

2023.09.21

Java switch的用法
Java switch的用法

Java中的switch语句用于根据不同的条件执行不同的代码块。想了解更多switch的相关内容,可以阅读本专题下面的文章。

1437

2024.03.13

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

1975

2023.11.27

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

40

2026.10.28

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn