VSCode插件开发之语言服务协议LSP调试技巧

秋明大大_3044

秋明大大_3044

2026-08-27

662人浏览

原创

最有效的办法是让lsp服务器独立运行并输出完整日志:找到入口文件(如out/server.js),用node out/server.js --stdio手动启动,配合模拟初始化请求验证;禁用vscode自动捕获,改用connection.console.log()和process.env.vscode_log_level=3输出可读日志。

vscode插件开发之语言服务协议lsp调试技巧

调试 LSP 插件最有效的办法,不是加断点,而是让服务器进程独立运行并输出完整日志。 VSCode 的 LanguageClient 默认会把语言服务器作为子进程启动并捕获 stdout/stderr,这导致错误被吞掉、堆栈被截断、初始化失败原因难定位——尤其在 onInitialize 阶段出错时,VSCode 往往只显示“Language server crashed”,不告诉你 crash 在哪一行。

如何让 LSP 服务器脱离 VSCode 独立运行

这是排查初始化失败、环境变量缺失、路径错误等问题的第一步。关键不是改客户端代码,而是绕过 LanguageClient 启动逻辑,手动运行服务器。

  • 找到服务器入口文件(通常是 out/server.js 或 dist/server.js),确认它能直接执行:node out/server.js
  • 用 --stdio 模式启动,并重定向输入输出:node out/server.js --stdio &1 2>&1(Linux/macOS)或 node out/server.js --stdio(Windows 下直接运行,观察控制台)
  • 用另一个终端模拟客户端发一条最简初始化请求(可借助 curl 或 nc),验证服务器是否响应:{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"processId":null,"rootPath":null,"capabilities":{}}}
  • 若服务器立即退出,说明 createConnection() 初始化失败——常见原因是未传入 ProposedFeatures.all 或 process.stdin 不可用(比如在非 stdio 模式下误用了 IPC)

为什么 console.log 在 LSP 服务器里不显示

LSP 服务器的标准输出(stdout)是 JSON-RPC 通信通道,所有 console.log 输出都会被当成非法 JSON 消息,导致协议解析失败、连接中断。这不是“没打印”,是“一打就崩”。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • 必须使用 connection.console.log() 或 connection.tracer.log(),它们会走 LSP 定义的 window/logMessage 通知通道
  • 在服务器启动前,可临时加一句 process.env.VSCODE_LOG_LEVEL = '3';(数字越大越详细),让 vscode-languageserver 库自动启用内部 tracer
  • 若用 vscode-languageclient 启动客户端,记得在 clientOptions 中开启日志:outputChannel: window.createOutputChannel('MyLang'),否则日志无处落脚

调试 textDocument/completion 返回空结果

补全没反应,但服务器没报错,大概率是能力声明、触发字符、文档同步三者不匹配,而不是逻辑写错了。

  • 检查 onInitialize 返回的 capabilities.completionProvider 是否包含 triggerCharacters,比如 ['.', ':', '"'];漏掉 . 就不会响应 obj. 这类补全
  • 确认文档已正确加入 TextDocuments 实例:调用 documents.listen(connection) 必须在 connection.listen() 之前,否则 didOpen 事件不会被监听到
  • 在 onCompletion 处理函数开头加 connection.console.log('completion triggered for:', params.textDocument.uri),先确认请求是否真的到达服务器——很多问题其实卡在客户端没发出去
  • 返回的 CompletionItem 数组不能为 null 或 undefined,必须是 [](空数组)才能被客户端识别为“有响应但无建议”

本地调试时 gopls 或 clangd 干扰怎么办

VSCode 可能同时激活多个同类型语言服务器(比如你写了 Go 服务器,但 gopls 也在运行),造成端口冲突、诊断覆盖、补全混杂。这不是 bug,是设计使然——LSP 允许多个服务器共存,但调试时你需要隔离。

  • 在 clientOptions.documentSelector 中避免泛化匹配,例如不用 language: 'go',而用自定义语言 ID:{ scheme: 'file', language: 'mygo' },并在 package.json 的 contributes.languages 里注册该 ID
  • 临时禁用其他 LSP 扩展:在调试期间,关闭 golang.go、clangd 等插件,或在 settings.json 中设 "go.useLanguageServer": false
  • 检查 textDocument/publishDiagnostics 推送的 uri 是否与客户端打开的文件 uri 完全一致(包括大小写、file:// 前缀、末尾斜杠),不一致会导致诊断不显示

真正卡住的往往不是协议细节,而是服务器进程是否真正在跑、日志是否真正在吐、URI 是否真的对得上——这些地方没有魔法,只有路径、权限和协议头里的 Content-Length 字段是否准确。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1215

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2472

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1849

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1707

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2567

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1798

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1222

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1096

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

434

5

热门下载

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

精品课程

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