本篇文章给大家介绍一下vscode中webview的使用方法。有一定的参考价值,有需要的朋友可以参考一下,希望对大家有所帮助。
其实vscode也是基于electron框架的桌面软件,也就是说,你在vscode里看到的所有的界面本就是网页。那在网页里再显示网页怎么做?相信你也想到了,就是iframe。【推荐学习:《vscode教程》】
调试webview在vscode命令面板中,输入open webview developer tools 后可以打开webview的控制台
果然是iframe~
你的插件必须用webview吗?官方英文文档地址:https://code.visualstudio.com/api/extension-guides/webview
vscode官方团队希望插件开发者好好思考如下问题:
这个功能真的需要在vs code中使用吗?作为单独的应用程序或网站会更好吗?使用webview是实现功能的唯一方法吗?您可以改用常规的vs code api吗?创建webviewpanel
const panel = vscode.window.createwebviewpanel( 'webview', "测试webview", vscode.viewcolumn.one);panel.webview.html = `<html><body>你好,我是webview</body></html>`
这样就能创建一个webview,渲染html内容。
看上去使用很简单对不对,但在实际使用webview进行插件开发的过程中,还是遇到了不少坑的:
1号坑:使用本地资源在vscode中的webview无法直接使用相对路径的本地资源。比如下面这段代码,我们引入了一个css,一个js,在body中有一张图片。
直接这样写是无法加载到这些资源的
解决方法1通过一个特殊的协议头vscode-resource:资源文件绝对路径,为了不影响咱们正常进行网页开发,我们可以封装一个方法,从本地文件读取html内容,统一替换所有资源的路径后再赋值给panel.webview.html
function getwebviewcontent(context, templatepath) { const resourcepath = path.join(context.extensionpath, templatepath); const dirpath = path.dirname(resourcepath); let html = fs.readfilesync(resourcepath, 'utf-8'); html = html.replace(/(<link.+?href="|<script.+?src="|<iframe.+?src="|<img.+?src=")(.+?)"/g, (m, $1, $2) => { if($2.indexof("https://")<0)return $1 + vscode.uri.file(path.resolve(dirpath, $2)).with({ scheme: 'vscode-resource' }).tostring() + '"'; else return $1 + $2+'"'; }); return html;}
这样我们在开发网页的时候就正常写相对路径就好了。
注意事项:如果你使用vue或者其他前端框架来进行插件webview的开发,就要注意资源的引入。以上封装的方法只对页面中hardcode的资源进行了替换。
解决方法2使用iframe引入本地路径html,不过vscode的webview对iframe的限制也特别大,几乎就是除了显示网页,和node环境交互就别想了。
2号坑:允许使用javascript默认不支持javascript
解决方法添加option,将enablescritps设置为true,它的默认是false。
3号坑:cookie和localstoragecookie和localstorage可以用,但是!!!
当vscode重启后,就全都清空了,所以等于不能用。
解决方法调用vscode的node环境来保存,这里需要让webview和vscode插件环境进行通讯。
4号坑:webview内容被释放当webview所在的tab pannel进入后台时(比如切到别的tab了),webview里的内容就会被清除,内存占用被释放。再次切回时会重新加载html内容。
解决办法启用retaincontextwhenhidden
消息通讯1、插件发消息,webview接收消息
插件里的jspanel.webview.postmessage({text: '你好,我是插件'});
webview里的jswindow.addeventlistener('message',function(e){ console.log(e.data.text);})
2、webview发消息,插件接收消息
webview里的js//初始化vscode插件api,没什么特别的功能,主要就是postmessagevar vscode = acquirevscodeapi();vscode.postmessage({ text: '你好,我是webview'})
插件里的jspanel.webview.ondidreceivemessage(function(data) { console.log(data.text);});
比如前面提到的cookie和localstorage,就可以封装一下消息通讯,通过插件node环境来保存到本地
var vscode = acquirevscodeapi();function setlocalstorage(k,v){ vscode.postmessage({ command: 'setlocalstorage', key:k, value:v })}
panel.webview.ondidreceivemessage(function(data) { if(data.command == 'setlocalstorage'){ //使用lowdb lowdb.set(data.key,data.value).write(); }});
官方demohttps://github.com/microsoft/vscode-extension-samples/tree/master/webview-sample
https://github.com/microsoft/vscode-extension-samples/tree/master/webview-view-sample
更多编程相关知识,请访问:编程视频!!
以上就是浅谈vscode中webview的使用方法的详细内容。