Terminal Web终端基础（Web IDE 技能探索 二）

        Terminal是web终端技能，雷同cmd命令窗口，Webcontainer 中保举利用的是Xterm.js，这里就不细说Xterm.js 的利用了，我们利用第三方库来实现（原生确实有点难用）。

 vue-web-terminal

        一个由 Vue 构建的支持多内容格式显示的网页端命令行窗口插件，支持表格、json、代码等多种消息格式，支持自界说消息样式、命令行库、键入搜索提示等，模拟原生终端窗口支持 ← → 光标切换和 ↑ ↓ 历史命令切换。其完善的API、中文文档、拖拽、缩放、实时回显等功能是我选择其的缘故起因之一。
在线体验地址
github 地址
中文文档

1. npm install vue-web-terminal@3 --save

复制代码

1. import Terminal from 'vue-web-terminal'
2. //  3.2.0 及 2.1.13 以后版本需要引入此样式，之前版本无需引入主题样式
3. import 'vue-web-terminal/lib/theme/dark.css'
5. // for vue3
6. const app = createApp(App).use(Terminal)

复制代码

1. <template>
2.   <terminal name="my-terminal" @exec-cmd="onExecCmd"></terminal>
3. </template>
5. <script setup>
6. function onExecCmd(cmd) {
7.   console.log(cmd);
8. }
9. </script>

复制代码

切换主题

        主题的核心是导入的style 文件内里自界说的css变量，因此，我们可以通过控制导入的文件实现主题切换：

 

        经太过析观察，两个文件的节点是一样的，无法通过js控制，因此，复制文件到外部文件夹，并添加标识,main.js 中引入外部文件： 

1. function changeTheme() {
2.   document
3.     .querySelector("html")
4.     .setAttribute("t-theme", dark.value ? "dark" : "lignt");
6.   dark.value = !dark.value;
7. }

复制代码

        这样更利于我们自界说主题，直接在原有基础上进行拓展即可。
个性化设置

show-header 是否显示头部
context 上下文内容（Root）
context-suffix 上下文后缀符号（@）

...更多设置项，各人去官网看下，比力简单，就不细说了。
变乱列表

        变乱这块我就说一个 exec-cmd：执行自界说命令时触发。success和failed为回调函数，必须调用两个回调其中之一才会回显！failed回调参数为一个string，exec-cmd的success回调参数支持多种数据类型，不同数据类型执行逻辑也会不同：

• 不传任何参数，立即结束本次执行
  
• 传入一个消息对象，将会向记录中追加一条消息，并立即结束本次执行
  
• 传入一个消息对象数组，将会向记录中追加多条消息，并立即结束本次执行
  
• 传入一个TerminalFlash对象，将会进入实时回显处理逻辑，本次执行并不会结束，直到调用finish()
  
• 传入一个TerminalAsk对象，将会进入用户询问输入处理逻辑，本次执行并不会结束，直到调用finish()
  

1. function onExecCmd(cmdKey, command, success, failed, name) {}

复制代码

1. function onExecCmd(cmdKey, command, success, failed, name) {
2.   success(); // 什么都不传，直接结束
3. }

复制代码

1. function onExecCmd(cmdKey, command, success, failed, name) {
2.   success({ content: "hello world" }); // 传一个消息对象
3. }

复制代码

1. function onExecCmd(cmdKey, command, success, failed, name) {
2.   success([{ content: "hello world" }, { content: "hello javascript" }]); // 传一个消息对象数组
3. }

复制代码

1. import { TerminalFlash } from "vue-web-terminal";
2. const flash = new TerminalFlash();
3. function onExecCmd(cmdKey, command, success, failed, name) {
4.   let count = 0;
5.   success(flash); // 传一个 TerminalFlash
7.   let flashInterval = setInterval(() => {
8.     //  显示数据调用 flag.flush(string)
9.     flash.flush(`This is flash content: ${count}`);
11.     if (++count >= 20) {
12.       clearInterval(flashInterval);
13.       //  结束回显调用 flag.finish()
14.       flash.finish();
15.     }
16.   }, 200);
17. }

复制代码

1. import { TerminalFlash, TerminalAsk } from "vue-web-terminal";
2. const flash = new TerminalFlash();
3. const asker = new TerminalAsk();
4. function onExecCmd(cmdKey, command, success, failed, name) {
5.   success(asker); // 传一个 TerminalAsk
6.   // 询问账号
7.   asker.ask({
8.     question: "Please input user name:",
9.     callback: askPassword,
10.   });
12.   function askPassword(value) {
13.     console.log("输入的username ==>", value);
14.     asker.ask({
15.       question: "Please input password: ",
16.       autoReview: true,
17.       isPassword: true,
18.       callback: (pass) => {
19.         //    do something
20.         console.log("输入的password ==>", pass);
21.         asker.finish();
22.       },
23.     });
24.   }
25. }

复制代码

         后面两种复杂的情况在构建应用时常用到，各人多练习下。还支持插槽，这块各人自己看下文档，应该也能学会，就不细说了。
Terminal API

        API无非就是主动向终端发送消息，具体api 可以看官网哈

1. TerminalApi.textEditorOpen('my-terminal', {
2.     content: 'This is the preset content',
3.     onClose: (value, options) => {
4.         console.log('Final content: ', value, "options:", options)
5.     }
6. })

复制代码

        在xshell中，可以在终端直接编辑 nginx设置文件，vue-web-terminal 支持调用textEditorOpen方法，打开编辑器：

 与WebContainer结合

        terminal只是网页端命令行窗口插件，并不具备实际的命令执行能力。当我输入 node -v 的时候，terminal的显示值，还需要通过 success 决定。

        因此，需要与webcontainer 结合，使得 terminal的输入，转化为 spawn 的参数，获取到output 输出流后，再回显到 terminal上。

1. async function onExecCmd(cmdKey, command, success, failed, name) {
2.   // 将命令行拆分为数组
3.   let argus = command.split(" ");
5.   let res = await wcInstance.spawn(argus[0], argus.slice(1));
7.   // 读取流
8.   res.output.pipeTo(
9.     new WritableStream({
10.       write(data) {
11.         success(data);
12.       },
13.     })
14.   );
15. }

复制代码

         这只是一个简单的示例哈，并不是所有的回显都是 success，也并不是所有的回显都是直接显示文本，比方 ls 查看文件列表，利用表格更合适，npm install 利用实时回显flash 更合适。 
总结

        确实vue-web-terminal利用起来更加方便，封装的API、变乱列表为我们省去了很多麻烦。利用起来也不难，各人多看文档即可学会。但是各人要记住哈，terminal仅是终端展示用，实际的执行能力照旧依靠webContainer，因此，两者的参数传递、数据回显需要做风雅化处理。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。