VSCode如何使用WebView开发插件界面_VSCode WebView插件界面开发步骤

浅枫大大_3201

浅枫大大_3201

2026-04-04

610人浏览

原创

vscode webview 是隔离沙箱中的独立渲染进程,必须用 vscode-webview:// 协议加载资源,所有静态资源路径需经 webview.aswebviewuri() 转换且限定于 localresourceroots 白名单内;与主进程通信只能通过 postmessage 和 message 事件,并严格校验来源。

vscode如何使用webview开发插件界面_vscode webview插件界面开发步骤

VSCode 的 WebView 不是网页嵌入那么简单,它本质是隔离沙箱里的独立渲染进程,直接写 HTML/CSS/JS 会遇到跨域、API 调用失败、样式丢失、资源加载 404 等问题——关键在于必须用 vscode-webview 协议加载资源,并通过 vscode.postMessage() 和 window.addEventListener('message', ...) 双向通信。

WebView 资源路径必须用 webview.asWebviewUri() 转换

本地文件(如 style.css、script.js)不能直接用相对路径或 file://,否则 404。VSCode 强制要求所有资源 URI 经过 webview.asWebviewUri() 处理,它会生成带签名的 vscode-webview:// 地址。

  • 错误写法:<link href="./style.css" rel="stylesheet">
  • 正确写法:<link href="%24%7Bwebview.asWebviewUri(cssPath)%7D" rel="stylesheet">,其中 cssPath 是 vscode.Uri.file(...) 得到的绝对路径
  • 图片、字体、JSON 数据等静态资源同理,全部要过一遍 asWebviewUri()
  • 注意:该方法只接受 vscode.Uri 对象,传字符串会静默失败

与插件主进程通信必须走 postMessage + message 事件

WebView 里无法直接调用 vscode 模块 API(比如 vscode.window.showInformationMessage),所有交互都得靠消息机制。主进程发消息用 webview.postMessage(),WebView 侧监听 window.addEventListener('message', ...),且必须校验 event.source === window 和 event.origin === vscode.webview.origin。

VSCode
VSCode

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

下载
  • WebView 侧发送请求:vscode.postMessage({ command: 'saveData', data: 'xxx' })
  • 主进程监听:webview.onDidReceiveMessage(message => { ... }, undefined, disposables),推荐用 disposables 自动清理
  • 禁止在 WebView 里用 fetch 直连插件后端或本地文件——没有 CORS 权限,也绕不开沙箱限制
  • 消息体只能是可序列化的 JSON 值(不能传函数、DOM 节点、undefined)

webview.options 必须显式启用脚本和局部资源加载

默认 WebView 是禁用 JS 的,且不允许加载本地资源。不设 enableScripts: true 和 localResourceRoots,页面就是纯静态 HTML,连 console.log 都不会执行。

  • enableScripts: true 是运行 JS 的前提,但开启后必须更严格校验 message 来源
  • localResourceRoots 是白名单目录数组,用于限制 asWebviewUri() 可转换的路径范围,例如:[vscode.Uri.file(path.join(context.extensionPath, 'media'))]
  • 如果漏设 localResourceRoots,即使路径对,asWebviewUri() 返回的 URI 也会被拦截,资源 404
  • 不建议把 context.extensionPath 整个加进去,有安全风险;只放实际需要的子目录

最常被忽略的是 localResourceRoots 的路径粒度和 asWebviewUri() 的调用时机——必须在设置好 webview.options 后再调用,且传入的 vscode.Uri 必须落在白名单路径内,差一层目录都会失败。

相关文章

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

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

下载

相关标签:

vscode

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

相关专题

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

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

2023.08.07

2035

5

json是什么
json是什么

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

2023.08.23

2962

1

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

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

2023.10.13

996

3

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

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

2025.09.10

3339

7

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

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

2023.08.03

1638

5

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

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

2023.09.04

2444

5

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

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

2023.10.24

5924

49

字符串介绍
字符串介绍

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

2023.11.24

5229

6

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

2024.03.22

6954

16

热门下载

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

精品课程

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