文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

xterm.js在web端如何实现Terminal

2023-07-04 12:52

关注

这篇文章主要介绍“xterm.js在web端如何实现Terminal”,在日常操作中,相信很多人在xterm.js在web端如何实现Terminal问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”xterm.js在web端如何实现Terminal”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!

xterm 是一个使用 TypeScript 编写的前端终端组件,可以直接在浏览器中实现一个命令行终端应用。Xterm.js 适用于大多数终端应用程序,如 bash,vim 和 tmux,这包括对基于curses的应用程序和鼠标事件的支持。Xterm.js 非常快,它甚至还包括一个GPU加速的渲染器。

在绝大多数的情况下 Xtermjs 通过 websocket 和后端建立通信。我们的每一次输入都需要发送到后端,而后端则需要根据我们的每一次输入给予响应,前端则负责将得到的数据渲染出来。

因为我使用的框架是 React,所以后续的所有功能都是在 React 中实现的。

快速上手

npm install xterm

因为考虑到该功能组件可能会在多个页面用到,因此需要将其单独封装成组件名为 Xterminal

import {memo, useEffect, useRef} from "react";import {Terminal} from "xterm"import type {ITerminalOptions, ITerminalInitOnlyOptions} from "xterm"import "xterm/css/xterm.css"interface Props {    options?: ITerminalOptions & ITerminalInitOnlyOptions,  // 定制化配置参数    onInput: (value: string) => void}const defaultOptions = {    cols: 20,    rows: 10}function Xterminal(props: Props) {    const {onInput} = props    const terminalRef = useRef<null | HTMLDivElement>(null)    useEffect(() => {        const options = {...defaultOptions, ...props.options}        const term = new Terminal(options);        // 打开一个已经初始化好的的终端        term.open(terminalRef.current as HTMLDivElement);        // 向终端中写入数据        term.write('Hello from \x1B[1;3;31mxterm.js\x1B[0m $ ')        term.onData((value) => {            onInput(value)            term.write(value)        })    }, [])    return (        <div className="terminal-container">            <div ref={terminalRef}></div>        </div>    )}export default memo(Xterminal)

现在将该组件引入到 App 中,就能够看到一个初始化好的 web 终端:

xterm.js在web端如何实现Terminal

接下来就是一步步来完成一些细节功能。

首次建立链接

当 webSocket 首次建立链接的时候,后端应该会给我一段默认的数据,这时,我们在组件初始化完成后,需要其呈现出来,而不是随随便便的在 write 一些字符串。

interface Props {    options?: ITerminalOptions & ITerminalInitOnlyOptions,  // 定制化配置参数    code: string | Uint8Array,    onInput: (value: string) => void}const defaultOptions = {    cols: 20,    rows: 10}function Xterminal(props: Props) {    const {code, onInput} = props    const terminalRef = useRef<null | HTMLDivElement>(null)    const options = useMemo(() => {        return {...defaultOptions, ...props.options}    }, [props.options])    const termRef = useRef<Terminal>(new Terminal(options))    useEffect(() => {        // 打开一个已经初始化好的的终端        termRef.current.open(terminalRef.current as HTMLDivElement);        // 向终端中写入数据        termRef.current.onData((value) => {            onInput(value)            termRef.current.write(value)        })    }, [])    // 监听code的变化,然后每次接收到响应的时候就写入    useEffect(() => {        termRef.current.write(code)    }, [code])    return (        <div className="terminal-container">            <div ref={terminalRef}></div>        </div>    )}

注意:由于终端实例要在不同的地方用到,所以我将其放在了Ref中。注意和上面最开始的代码区分。

处理输入逻辑

键盘输入事件,需要用到onData监听函数,它能够监听到我们键盘输入的每一个字符。

useEffect(() => {+   termRef.current.onData((value) => {+        console.log(value)+        termRef.current.write(value)+     })}, [])

而在onData事件中我们还需要来和后端进行交互,所以还需要将输入的value传递给父组件。供父组件进行网络请求。

useEffect(()=>{    term.current.onData((value) => {        onInput(value)        termRef.current.write(value)    })},[])

而父组件的onInput就负责处理和后端的交互。到现在一个简单的 webTerminal 就已经实现了

到此,关于“xterm.js在web端如何实现Terminal”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注编程网网站,小编会继续努力为大家带来更多实用的文章!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     807人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     351人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     314人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     433人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     221人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯