ToB企服应用市场:ToB评测及商务社交产业平台
标题:
Terminal Web终端基础（Web IDE 技能探索 二）
[打印本页]
作者:
十念
时间:
2024-9-17 08:24
标题:
Terminal Web终端基础（Web IDE 技能探索 二）
Terminal是web终端技能，雷同cmd命令窗口，Webcontainer 中保举利用的是Xterm.js，这里就不细说Xterm.js 的利用了，我们利用第三方库来实现（原生确实有点难用）。
vue-web-terminal
一个由 Vue 构建的支持多内容格式显示的网页端命令行窗口插件，支持表格、json、代码等多种消息格式，支持自界说消息样式、命令行库、键入搜索提示等，模拟原生终端窗口支持 ← → 光标切换和 ↑ ↓ 历史命令切换。其完善的API、中文文档、拖拽、缩放、实时回显等功能是我选择其的缘故起因之一。
在线体验地址
github 地址
中文文档
npm install vue-web-terminal@3 --save
复制代码
import Terminal from 'vue-web-terminal'
// 3.2.0 及 2.1.13 以后版本需要引入此样式，之前版本无需引入主题样式
import 'vue-web-terminal/lib/theme/dark.css'
// for vue3
const app = createApp(App).use(Terminal)
复制代码
<template>
<terminal name="my-terminal" @exec-cmd="onExecCmd"></terminal>
</template>
<script setup>
function onExecCmd(cmd) {
console.log(cmd);
}
</script>
复制代码
切换主题
主题的核心是导入的style 文件内里自界说的css变量，因此，我们可以通过控制导入的文件实现主题切换：
经太过析观察，两个文件的节点是一样的，无法通过js控制，因此，复制文件到外部文件夹，并添加标识,main.js 中引入外部文件：
function changeTheme() {
document
.querySelector("html")
.setAttribute("t-theme", dark.value ? "dark" : "lignt");
dark.value = !dark.value;
}
复制代码
这样更利于我们自界说主题，直接在原有基础上进行拓展即可。
个性化设置
show-header
是否显示头部
context
上下文内容（Root）
context-suffix
上下文后缀符号（@）
...更多设置项，各人去官网看下，比力简单，就不细说了。
变乱列表
变乱这块我就说一个 exec-cmd：执行自界说命令时触发。success和failed为回调函数，
必须调用两个回调其中之一才会回显
！failed回调参数为一个string，exec-cmd的success回调参数支持多种数据类型，不同数据类型执行逻辑也会不同：
不传任何参数，立即结束本次执行
传入一个消息对象，将会向记录中追加一条消息，并立即结束本次执行
传入一个消息对象数组，将会向记录中追加多条消息，并立即结束本次执行
传入一个TerminalFlash对象，将会进入实时回显处理逻辑，本次执行并不会结束，直到调用finish()
传入一个TerminalAsk对象，将会进入用户询问输入处理逻辑，本次执行并不会结束，直到调用finish()
function onExecCmd(cmdKey, command, success, failed, name) {}
复制代码
function onExecCmd(cmdKey, command, success, failed, name) {
success(); // 什么都不传，直接结束
}
复制代码
function onExecCmd(cmdKey, command, success, failed, name) {
success({ content: "hello world" }); // 传一个消息对象
}
复制代码
function onExecCmd(cmdKey, command, success, failed, name) {
success([{ content: "hello world" }, { content: "hello javascript" }]); // 传一个消息对象数组
}
复制代码
import { TerminalFlash } from "vue-web-terminal";
const flash = new TerminalFlash();
function onExecCmd(cmdKey, command, success, failed, name) {
let count = 0;
success(flash); // 传一个 TerminalFlash
let flashInterval = setInterval(() => {
// 显示数据调用 flag.flush(string)
flash.flush(`This is flash content: ${count}`);
if (++count >= 20) {
clearInterval(flashInterval);
// 结束回显调用 flag.finish()
flash.finish();
}
}, 200);
}
复制代码
import { TerminalFlash, TerminalAsk } from "vue-web-terminal";
const flash = new TerminalFlash();
const asker = new TerminalAsk();
function onExecCmd(cmdKey, command, success, failed, name) {
success(asker); // 传一个 TerminalAsk
// 询问账号
asker.ask({
question: "Please input user name:",
callback: askPassword,
});
function askPassword(value) {
console.log("输入的username ==>", value);
asker.ask({
question: "Please input password: ",
autoReview: true,
isPassword: true,
callback: (pass) => {
// do something
console.log("输入的password ==>", pass);
asker.finish();
},
});
}
}
复制代码
后面两种复杂的情况在构建应用时常用到，各人多练习下。还支持插槽，这块各人自己看下文档，应该也能学会，就不细说了。
Terminal API
API无非就是主动向终端发送消息，具体api 可以看官网哈
TerminalApi.textEditorOpen('my-terminal', {
content: 'This is the preset content',
onClose: (value, options) => {
console.log('Final content: ', value, "options:", options)
}
})
复制代码
在xshell中，可以在终端直接编辑 nginx设置文件，vue-web-terminal 支持调用textEditorOpen方法，打开编辑器：
与WebContainer结合
terminal只是网页端命令行窗口插件，并不具备实际的命令执行能力。当我输入 node -v 的时候，terminal的显示值，还需要通过 success 决定。
因此，需要与webcontainer 结合，使得 terminal的输入，转化为 spawn 的参数，获取到output 输出流后，再回显到 terminal上。
async function onExecCmd(cmdKey, command, success, failed, name) {
// 将命令行拆分为数组
let argus = command.split(" ");
let res = await wcInstance.spawn(argus[0], argus.slice(1));
// 读取流
res.output.pipeTo(
new WritableStream({
write(data) {
success(data);
},
})
);
}
复制代码
这只是一个简单的示例哈，并不是所有的回显都是 success，也并不是所有的回显都是直接显示文本，比方 ls 查看文件列表，利用表格更合适，npm install 利用实时回显flash 更合适。
总结
确实vue-web-terminal利用起来更加方便，封装的API、变乱列表为我们省去了很多麻烦。利用起来也不难，各人多看文档即可学会。但是各人要记住哈，terminal仅是终端展示用，实际的执行能力照旧依靠webContainer，因此，两者的参数传递、数据回显需要做风雅化处理。
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)
Powered by Discuz! X3.4
