VSCode如何开发Notebook类型插件_VSCode Notebook类型插件开发总结

星杰同学_1685

星杰同学_1685

2026-04-05

161人浏览

原创

VSCode Notebook 插件的核心载体是 Notebook API,需注册 NotebookProvider 并实现 resolveNotebookContent、saveNotebook 等方法,返回结构化 NotebookData;必须在 package.json 中声明 "notebooks" 字段,且 cell language 需提前注册。

vscode如何开发notebook类型插件_vscode notebook类型插件开发总结

什么是 VSCode Notebook 插件的核心载体

VSCode 的 Notebook 功能不是靠传统 WebView 或 WebviewPanel 实现的,而是依赖一套专用的 Notebook API:你需要注册一个 NotebookProvider,并实现 resolveNotebookContent、saveNotebook 等关键方法。它不渲染 HTML,而是把 notebook 文件(如 .ipynb)解析为结构化的 NotebookData —— 包含 cells 数组,每个 cell 有 kind(Markup / Code)、source 和可选的 language。

  • NotebookProvider 必须在 package.json 中通过 "notebooks" 字段声明,否则 VSCode 根本不会加载你的 provider
  • 不支持直接操作 DOM;cell 渲染由 VSCode 内置编辑器负责,你只提供数据和执行逻辑
  • 所有 cell 的 language id 必须提前在 contributes.languages 中注册,否则代码 cell 无法高亮或触发语法检查

如何让自定义 Notebook 支持运行单元格

运行能力不是自动附带的,必须显式注册 NotebookKernel 并关联到你的 notebook 类型。VSCode 不会帮你执行代码 —— 你得自己启动进程、通信、返回输出。

  • 在 activate 阶段调用 vscode.notebooks.registerNotebookKernel,传入 kernel 对象,其中 executeCell 是必填方法
  • executeCell 接收 cell 和 notebook,你需要:
    • 判断 cell.kind === vscode.NotebookCellKind.Code
    • 提取 cell.source,发给后端(比如子进程、HTTP 服务、WS 连接)
    • 用 controller.updateNotebookCellOutput 返回 notebookCellOutputItem(如 text/plain、application/json)
  • 常见错误:忘记调用 controller.clearOutput 导致旧输出残留;或返回的 MIME type 不被 VSCode 内置渲染器识别(例如用 text/html 但没配 outputMimeTypes)

为什么保存后打开内容变空或格式错乱

VSCode 默认把 notebook 当作二进制文件处理,如果你的 saveNotebook 方法只是简单写字符串,很可能被当作 UTF-8 BOM 污染或换行符不一致导致解析失败。

VSCode
VSCode

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

下载
  • saveNotebook 必须返回 Uint8Array,而不是 string;推荐用 new TextEncoder().encode(jsonString)
  • resolveNotebookContent 返回的 NotebookData 中,cells 的 source 字段必须是 string 数组(每行一项),不能是单个字符串(即使带 \n)
  • 如果你用 JSON 序列化 cell 输出(比如 stdout),确保 outputItems 的 mime 和 data 类型匹配;data 是 Uint8Array,不是 base64 或 string
  • Windows 下尤其要注意:VSCode 期望换行符为 \n,不是 \r\n;用 split(/\r?\n/) 处理输入,再用 .join('\n') 组装

调试 Notebook 插件时最常卡住的三个点

Notebook 插件的生命周期比普通插件更隐晦,控制台日志容易丢失,很多行为只有在真实 notebook 文件打开后才触发。

  • 启动调试前务必确认:工作区已打开一个匹配 fileNamePattern 的文件(如 *.mybook),否则 resolveNotebookContent 根本不会被调用
  • console.log 在 executeCell 里可能不显示——改用 vscode.window.showInformationMessage 或写入临时文件验证执行流
  • 修改 package.json 的 notebooks 配置后,必须完全重启 VSCode(仅重载扩展无效),因为 notebook 类型注册发生在主进程初始化阶段

Notebook 插件的本质是“数据协议 + 执行契约”,不是 UI 开发。多数问题出在数据结构不符合约定,而不是逻辑写错了。

相关文章

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

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

下载

相关标签:

vscode

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

相关专题

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

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

2023.08.07

2235

5

json是什么
json是什么

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

2023.08.23

3562

1

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

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

2023.10.13

1196

3

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

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

2025.09.10

4099

7

string转int
string转int

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

2023.08.02

6979

3

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1838

5

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2944

5

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

2023.10.24

6244

49

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2023.11.24

6129

6

热门下载

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

精品课程

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