0

0

VSCode调试扩展:开发自定义调试器适配器的完整流程

夜晨

夜晨

发布时间:2025-10-26 21:08:01

|

958人浏览过

|

来源于php中文网

原创

首先理解 Debug Adapter Protocol(DAP),它是 VSCode 与调试器通信的 JSON-RPC 协议,包含请求、响应和事件三类消息;接着使用 yo code 生成扩展骨架,在 package.json 中注册调试类型 my-debugger,并声明 launch 配置;然后实现 Debug Adapter,通过继承 vscode-debugadapter 提供的 DebugSession 类,重写 launchRequest 和 setBreakPointsRequest 等方法处理调试逻辑;最后在 extension.ts 中注册 DebugAdapterDescriptorFactory,使 VSCode 能启动适配器进程;完成上述步骤后,F5 即可启用调试功能。

vscode调试扩展:开发自定义调试器适配器的完整流程

开发自定义调试器适配器(Debug Adapter)让 VSCode 能够支持任意语言或运行时的调试功能。整个流程涉及协议理解、适配器实现、扩展注册和调试通信。以下是完整开发流程,帮助你从零构建一个可用的调试扩展。

理解 Debug Adapter Protocol (DAP)

VSCode 通过 Debug Adapter Protocol (DAP) 与调试器通信。DAP 是基于 JSON-RPC 的通用协议,定义了编辑器与调试后端之间的消息格式。核心概念包括:

  • 客户端:VSCode(发送请求,接收事件)
  • 服务端:你的 Debug Adapter(响应请求,发送事件)
  • 消息类型:request(如 launch、attach)、response、event(如输出、断点命中)

你需要实现一个程序,能监听来自 VSCode 的 DAP 请求,并按协议返回正确响应。

创建 VSCode 扩展并注册调试支持

使用 vscode-generator-code 快速生成扩展骨架:

yo code

选择“New Extension (TypeScript)”或“New Debug Adapter extension”。生成后,重点关注以下文件:

  • package.json:声明调试类型和支持的命令
  • src/extension.ts:扩展入口,注册调试适配器

package.json 中添加调试贡献点:

"contributes": { "debuggers": [ { "type": "my-debugger", "label": "My Debugger", "languages": ["mylang"], "configurationAttributes": { "launch": { "required": ["program"], "properties": { "program": { "type": "string", "description": "The program to debug" } } } }, "adapterExecutableCommand": "my-debug-adapter" } ] }

这告诉 VSCode 支持名为 my-debugger 的调试类型。

实现 Debug Adapter 程序

Debug Adapter 可以是独立进程或内联脚本。常见方式是用 Node.js 编写并作为子进程启动。

ImgGood
ImgGood

免费在线AI照片编辑器

下载

关键步骤:

  • 使用 vscode-debugadapter 模块简化实现
  • 继承 DebugSession 类,重写核心方法
  • 处理 launchRequestattachRequest
  • 管理断点、变量、调用等状态

示例代码片段(TypeScript):

import { DebugSession, LoggingDebugSession } from 'vscode-debugadapter'; import { DebugProtocol } from 'vscode-debugprotocol';

class MyDebugAdapter extends LoggingDebugSession { protected launchRequest(response: DebugProtocol.LaunchResponse, args: any) { // 启动目标程序,建立通信 this.sendResponse(response); // 模拟程序启动成功 this.fireEvent({ type: 'event', event: 'initialized' }); }

protected setBreakPointsRequest(response: DebugProtocol.SetBreakpointsResponse, args: any) { // 处理断点设置 const breakpoints = args.breakpoints.map(() => ({ verified: true, line: args.line })); response.body = { breakpoints }; this.sendResponse(response); } }

// 启动适配器 DebugSession.run(MyDebugAdapter);

编译后生成 debugAdapter.js,供扩展调用。

连接扩展与适配器

extension.ts 中注册适配器启动逻辑:

import * as vscode from 'vscode'; import * as net from 'net'; import * as path from 'path';

export function activate(context: vscode.ExtensionContext) { const factory = new DebugAdapterExecutableFactory(context); context.subscriptions.push( vscode.debug.registerDebugAdapterDescriptorFactory('my-debugger', factory) ); }

class DebugAdapterExecutableFactory implements vscode.DebugAdapterDescriptorFactory { createDebugAdapterDescriptor(session: vscode.DebugSession): vscode.ProviderResult<vscode.DebugAdapterDescriptor> { return new vscode.DebugAdapterExecutable( 'node', [path.join(__dirname, '../out/debugAdapter.js')], {} ); } }

这样,当用户启动调试会话时,VSCode 会自动运行你的适配器脚本。

基本上就这些。完成之后,按下 F5 启动调试,VSCode 将通过 DAP 与你的适配器通信,实现断点、变量查看、单步执行等功能。建议结合 vscode-debugadapter 提供的日志功能排查问题,逐步扩展对复杂调试操作的支持。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

49

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

196

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

65

2026.03.13

json数据格式
json数据格式

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

82

2025.09.10

string转int
string转int

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

1051

2023.08.02

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
go语言零基础开发内容管理系统
go语言零基础开发内容管理系统

共34课时 | 2.7万人学习

第二十三期_前端开发
第二十三期_前端开发

共98课时 | 8.4万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号