0

0

VSCode调试器开发指南_自定义运行时支持实现

紅蓮之龍

紅蓮之龍

发布时间:2025-11-27 08:17:02

|

430人浏览过

|

来源于php中文网

原创

答案:通过实现Debug Adapter Protocol(DAP)并编写调试适配器,可在VSCode中为自研脚本引擎等自定义运行时环境添加完整调试支持。具体步骤包括使用yo code初始化扩展项目,在package.json中注册调试类型,编写Debug Adapter处理初始化、启动、断点设置等DAP请求,并通过事件机制与VSCode同步调试状态,最终实现媲美内置调试器的体验。

vscode调试器开发指南_自定义运行时支持实现

想让 VSCode 支持调试你自己的运行时环境?比如一个自研脚本引擎、嵌入式解释器,甚至是一个远程设备上的执行环境?VSCode 本身不直接支持这些,但通过扩展机制,你可以实现完整的调试体验。关键在于理解并实现 Debug Adapter Protocol (DAP) 和编写对应的调试适配器(Debug Adapter)。

理解 VSCode 调试架构

VSCode 的调试功能是模块化的。编辑器本身只负责用户界面(断点、变量查看、调用等),真正的调试逻辑由独立的 Debug Adapter 处理。两者通过标准协议通信:

  • Debug Adapter Protocol (DAP):基于 JSON-RPC 的通信协议,定义了 VSCode(客户端)和 Debug Adapter(服务端)之间的消息格式。
  • Debug Adapter:一个独立进程,负责与实际的运行时(你的目标环境)交互,比如启动程序、设置断点、获取变量值,并将结果通过 DAP 返回给 VSCode。

创建自定义调试扩展

开发流程通常分为三步:注册调试类型、实现 Debug Adapter、连接前端后端

1. 初始化扩展项目

  • 使用 yo code 脚手架,选择 “New Extension (TypeScript)” 或 “New Debug Adapter” 模板。
  • 模板会生成基础文件结构,包括 package.jsonsrc/extension.ts(VSCode 端)和 src/debugAdapter.ts(适配器端)。

2. 配置 package.json

package.jsoncontributes.debuggers 字段中声明你的调试器:

{
  "type": "myruntime",
  "label": "My Custom Runtime",
  "languages": ["mylang"],
  "adapterExecutableCommand": "my-debug-adapter", 
  "variables": { "configFile": "${workspaceFolder}/config.json" },
  "configurationAttributes": {
    "launch": {
      "required": ["program"],
      "properties": {
        "program": {
          "type": "string",
          "description": "The program to debug."
        },
        "host": {
          "type": "string",
          "default": "localhost"
        }
      }
    }
  }
}

这里定义了调试类型名为 myruntime,用户 launch.json 中的 type 必须匹配。如果适配器是独立可执行文件,用 adapterExecutableCommand 指定命令;如果是内联 Node.js 脚本,用 adapterProvider

Ex驾校预约小程序
Ex驾校预约小程序

传统驾校预约方式步骤繁琐,效率低下,随着移动互联网科技和5G的革新,驾校考试领域迫切需要更加简洁、高效的预约方式,便捷人们的生活。因此设计基于微信小程序的驾校预约系统,改进传统驾校预约方式,实现高效的驾校学校预约。 采用腾讯提供的小程序云开发解决方案,无须服务器和域名。驾校预约管理:开始/截止时间/人数均可灵活设置,可以自定义客户预约填写的数据项驾校预约凭证:支持线下到场后校验签到/核销/二维码自

下载

实现 Debug Adapter 核心逻辑

Debug Adapter 是核心,需处理 DAP 请求。常用 vscode-debugadaptervscode-debugprotocol 库简化开发。

主要方法重写示例:

class MyDebugAdapter extends DebugSession {
  protected initializeRequest(
    response: DebugProtocol.InitializeResponse,
    args: DebugProtocol.InitializeRequestArguments
  ): void {
    this.sendResponse(response);
    // 告知客户端支持的能力,如是否支持条件断点
    this.sendEvent(new InitializedEvent());
  }

  protected launchRequest(
    response: DebugProtocol.LaunchResponse,
    args: ILaunchRequestArguments
  ): void {
    // 启动你的运行时,例如 spawn 子进程或连接远程设备
    this.runtime = new MyRuntime(args.program, args.host);
    this.runtime.on('stopOnEntry', () => {
      this.sendEvent(new StoppedEvent('entry', MyDebugAdapter.MAIN_THREAD));
    });
    this.sendResponse(response);
  }

  protected setBreakPointsRequest(
    response: DebugProtocol.SetBreakpointsResponse,
    args: DebugProtocol.SetBreakpointsArguments
  ): void {
    const filePath = this.convertClientPathToDebugger(args.source.path!);
    const actualBreakpoints = args.breakpoints!.map(bp => {
      const hit = this.runtime.setBreakPoint(filePath, bp.line, bp.condition);
      return { verified: hit, line: bp.line };
    });
    response.body = { breakpoints: actualBreakpoints };
    this.sendResponse(response);
  }
}

当运行时触发断点或异常时,适配器需主动发送 StoppedEvent 给 VSCode。当用户单步或继续,VSCode 会发送 continueRequestnextRequest,适配器需转发给运行时。

调试与测试技巧

开发调试适配器本身也需要调试。推荐配置两个 launch 配置:

  • Extension Host:启动一个新 VSCode 实例加载你的扩展,用于测试整体行为。
  • Debug Adapter:以调试模式启动 Debug Adapter 进程,便于排查适配器内部逻辑。

利用日志输出,在适配器中记录 DAP 消息收发,能快速定位问题。确保所有路径转换(工作区路径 ↔ 适配器路径)正确处理。

基本上就这些。实现自定义运行时调试的核心是桥接 VSCode 和你的环境,只要遵循 DAP 规范,就能获得媲美内置调试器的体验。不复杂但容易忽略细节。

相关专题

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

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

415

2023.08.07

json是什么
json是什么

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

533

2023.08.23

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

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

310

2023.10.13

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

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

75

2025.09.10

堆和栈的区别
堆和栈的区别

堆和栈的区别:1、内存分配方式不同;2、大小不同;3、数据访问方式不同;4、数据的生命周期。本专题为大家提供堆和栈的区别的相关的文章、下载、课程内容,供大家免费下载体验。

392

2023.07.18

堆和栈区别
堆和栈区别

堆(Heap)和栈(Stack)是计算机中两种常见的内存分配机制。它们在内存管理的方式、分配方式以及使用场景上有很大的区别。本文将详细介绍堆和栈的特点、区别以及各自的使用场景。php中文网给大家带来了相关的教程以及文章欢迎大家前来学习阅读。

572

2023.08.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

510

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

244

2023.07.28

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
HTML教程
HTML教程

共500课时 | 4.9万人学习

Vue.js 微实战--十天技能课堂
Vue.js 微实战--十天技能课堂

共18课时 | 1.1万人学习

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

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