devbox
花生_TL007
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

教你用纯Java实现一个网页版的Xshell（附源码）

作者：花生_TL007 | 2024-03-07 02:47:37

赞

踩

教你用纯Java实现一个网页版的Xshell（附源码）

点击上方 好好学java ，选择 星标 公众号

  1. 重磅资讯、干货，第一时间送达
  2.  
  3.

今日推荐：今天给大家推荐 6 个 Spring Boot 项目，拿来就可以赚钱！

 个人原创100W+访问量博客：点击前往，查看更多

前言

最近由于项目需求，项目中需要实现一个WebSSH连接终端的功能，由于自己第一次做这类型功能，所以首先上了GitHub找了找有没有现成的轮子可以拿来直接用，当时看到了很多这方面的项目，例如：GateOne、webssh、shellinabox等，这些项目都可以很好地实现webssh的功能。

但是最终并没有采用，原因是在于这些底层大都是python写的，需要依赖很多文件，自己用的时候可以使用这种方案，快捷省事，但是做到项目中供用户使用时，总不能要求用户做到服务器中必须包含这些底层依赖，这显然不太合理，所以我决定自己动手写一个WebSSH的功能，并且作为一个独立的项目开源出来。

github项目开源地址：https://github.com/NoCortY/WebSSH

技术选型

由于webssh需要实时数据交互，所以会选用长连接的WebSocket，为了开发的方便，框架选用SpringBoot，另外还自己了解了Java用户连接ssh的jsch和实现前端shell页面的xterm.js.

所以，最终的技术选型就是 SpringBoot+Websocket+jsch+xterm.js。

导入依赖

  1. <parent>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-parent</artifactId>
  4.     <version>2.1.7.RELEASE</version>
  5.     <relativePath /> <!-- lookup parent from repository -->
  6. </parent>
  7. <dependencies>
  8.     <!-- Web相关 -->
  9.     <dependency>
  10.         <groupId>org.springframework.boot</groupId>
  11.         <artifactId>spring-boot-starter-web</artifactId>
  12.     </dependency>
  13.     <!-- jsch支持 -->
  14.     <dependency>
  15.         <groupId>com.jcraft</groupId>
  16.         <artifactId>jsch</artifactId>
  17.         <version>0.1.54</version>
  18.     </dependency>
  19.     <!-- WebSocket 支持 -->
  20.     <dependency>
  21.         <groupId>org.springframework.boot</groupId>
  22.         <artifactId>spring-boot-starter-websocket</artifactId>
  23.     </dependency>
  24.     <!-- 文件上传解析器 -->
  25.     <dependency>
  26.         <groupId>commons-io</groupId>
  27.         <artifactId>commons-io</artifactId>
  28.         <version>1.4</version>
  29.     </dependency>
  30.     <dependency>
  31.         <groupId>commons-fileupload</groupId>
  32.         <artifactId>commons-fileupload</artifactId>
  33.         <version>1.3.1</version>
  34.     </dependency>
  35. </dependencies>

一个简单的xterm案例

由于xterm是一个冷门技术，所以很多同学并没有这方面的知识支撑，我也是为了实现这个功能所以临时学的，所以在这给大家介绍一下。

xterm.js是一个基于WebSocket的容器，它可以帮助我们在前端实现命令行的样式。就像是我们平常再用SecureCRT或者XShell连接服务器时一样。

下面是官网上的入门案例：

  1. <!doctype html>
  2.  <html>
  3.   <head>
  4.     <link rel="stylesheet" href="node_modules/xterm/css/xterm.css" />
  5.     <script src="node_modules/xterm/lib/xterm.js"></script>
  6.   </head>
  7.   <body>
  8.     <div id="terminal"></div>
  9.     <script>
  10.       var term = new Terminal();
  11.       term.open(document.getElementById('terminal'));
  12.       term.write('Hello from \x1B[1;3;31mxterm.js\x1B[0m $ ')
  13.     </script>
  14.   </body>
  15.  </html>

最终测试，页面就是下面这个样子：

xterm入门

可以看到页面已经出现了类似与shell的样式，那就根据这个继续深入，实现一个webssh。

后端实现

由于xterm只要只是实现了前端的样式，并不能真正地实现与服务器交互，与服务器交互主要还是靠我们Java后端来进行控制的，所以我们从后端开始，使用jsch+websocket实现这部分内容。

WebSocket配置

由于消息实时推送到前端需要用到WebSocket，不了解WebSocket的同学可以先去自行了解一下，这里就不过多介绍了，我们直接开始进行WebSocket的配置。

  1.   /**
  2.   * @Description: websocket配置
  3.   * @Author: NoCortY
  4.   * @Date: 2020/3/8
  5.   */
  6.   @Configuration
  7.   @EnableWebSocket
  8.   public class WebSSHWebSocketConfig implements WebSocketConfigurer{
  9.       @Autowired
  10.       WebSSHWebSocketHandler webSSHWebSocketHandler;
  11.       @Override
  12.       public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) {
  13.           //socket通道
  14.           //指定处理器和路径，并设置跨域
  15.           webSocketHandlerRegistry.addHandler(webSSHWebSocketHandler, "/webssh")
  16.                   .addInterceptors(new WebSocketInterceptor())
  17.                   .setAllowedOrigins("*");
  18.       }
  19.   }

处理器(Handler)和拦截器(Interceptor)的实现

刚才我们完成了WebSocket的配置，并指定了一个处理器和拦截器。所以接下来就是处理器和拦截器的实现。

拦截器：

  1.   public class WebSocketInterceptor implements HandshakeInterceptor {
  2.       /**
  3.        * @Description: Handler处理前调用
  4.        * @Param: [serverHttpRequest, serverHttpResponse, webSocketHandler, map]
  5.        * @return: boolean
  6.        * @Author: NoCortY
  7.        * @Date: 2020/3/1
  8.        */
  9.       @Override
  10.       public boolean beforeHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Map<String, Object> map) throws Exception {
  11.           if (serverHttpRequest instanceof ServletServerHttpRequest) {
  12.               ServletServerHttpRequest request = (ServletServerHttpRequest) serverHttpRequest;
  13.               //生成一个UUID，这里由于是独立的项目，没有用户模块，所以可以用随机的UUID
  14.               //但是如果要集成到自己的项目中，需要将其改为自己识别用户的标识
  15.               String uuid = UUID.randomUUID().toString().replace("-","");
  16.               //将uuid放到websocketsession中
  17.               map.put(ConstantPool.USER_UUID_KEY, uuid);
  18.               return true;
  19.           } else {
  20.               return false;
  21.           }
  22.       }
  23.  
  24.       @Override
  25.       public void afterHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Exception e) {
  26.  
  27.       }
  28.   }

处理器：

  1.   /**
  2.   * @Description: WebSSH的WebSocket处理器
  3.   * @Author: NoCortY
  4.   * @Date: 2020/3/8
  5.   */
  6.   @Component
  7.   public class WebSSHWebSocketHandler implements WebSocketHandler{
  8.       @Autowired
  9.       private WebSSHService webSSHService;
  10.       private Logger logger = LoggerFactory.getLogger(WebSSHWebSocketHandler.class);
  11.  
  12.       /**
  13.        * @Description: 用户连接上WebSocket的回调
  14.        * @Param: [webSocketSession]
  15.        * @return: void
  16.        * @Author: Object
  17.        * @Date: 2020/3/8
  18.        */
  19.       @Override
  20.       public void afterConnectionEstablished(WebSocketSession webSocketSession) throws Exception {
  21.           logger.info("用户:{},连接WebSSH", webSocketSession.getAttributes().get(ConstantPool.USER_UUID_KEY));
  22.           //调用初始化连接
  23.           webSSHService.initConnection(webSocketSession);
  24.       }
  25.  
  26.       /**
  27.        * @Description: 收到消息的回调
  28.        * @Param: [webSocketSession, webSocketMessage]
  29.        * @return: void
  30.        * @Author: NoCortY
  31.        * @Date: 2020/3/8
  32.        */
  33.       @Override
  34.       public void handleMessage(WebSocketSession webSocketSession, WebSocketMessage<?> webSocketMessage) throws Exception {
  35.           if (webSocketMessage instanceof TextMessage) {
  36.               logger.info("用户:{},发送命令:{}", webSocketSession.getAttributes().get(ConstantPool.USER_UUID_KEY), webSocketMessage.toString());
  37.               //调用service接收消息
  38.               webSSHService.recvHandle(((TextMessage) webSocketMessage).getPayload(), webSocketSession);
  39.           } else if (webSocketMessage instanceof BinaryMessage) {
  40.  
  41.           } else if (webSocketMessage instanceof PongMessage) {
  42.  
  43.           } else {
  44.               System.out.println("Unexpected WebSocket message type: " + webSocketMessage);
  45.           }
  46.       }
  47.  
  48.       /**
  49.        * @Description: 出现错误的回调
  50.        * @Param: [webSocketSession, throwable]
  51.        * @return: void
  52.        * @Author: Object
  53.        * @Date: 2020/3/8
  54.        */
  55.       @Override
  56.       public void handleTransportError(WebSocketSession webSocketSession, Throwable throwable) throws Exception {
  57.           logger.error("数据传输错误");
  58.       }
  59.  
  60.       /**
  61.        * @Description: 连接关闭的回调
  62.        * @Param: [webSocketSession, closeStatus]
  63.        * @return: void
  64.        * @Author: NoCortY
  65.        * @Date: 2020/3/8
  66.        */
  67.       @Override
  68.       public void afterConnectionClosed(WebSocketSession webSocketSession, CloseStatus closeStatus) throws Exception {
  69.           logger.info("用户:{}断开webssh连接", String.valueOf(webSocketSession.getAttributes().get(ConstantPool.USER_UUID_KEY)));
  70.           //调用service关闭连接
  71.           webSSHService.close(webSocketSession);
  72.       }
  73.  
  74.       @Override
  75.       public boolean supportsPartialMessages() {
  76.           return false;
  77.       }
  78.   }

需要注意的是，我在拦截器中加入的用户标识是使用了随机的UUID，这是因为作为一个独立的websocket项目，没有用户模块，如果需要将这个项目集成到自己的项目中，需要修改这部分代码，将其改为自己项目中识别一个用户所用的用户标识。

WebSSH的业务逻辑实现（核心）

刚才我们实现了websocket的配置，都是一些死代码，实现了接口再根据自身需求即可实现，现在我们将进行后端主要业务逻辑的实现，在实现这个逻辑之前，我们先来想想，WebSSH，我们主要想要呈现一个什么效果。

我这里做了一个总结：

1.首先我们得先连接上终端（初始化连接）

2.其次我们的服务端需要处理来自前端的消息（接收并处理前端消息）

3.我们需要将终端返回的消息回写到前端（数据回写前端）

4.关闭连接

根据这四个需求，我们先定义一个接口，这样可以让需求明了起来。

  1.   /**
  2.    * @Description: WebSSH的业务逻辑
  3.    * @Author: NoCortY
  4.    * @Date: 2020/3/7
  5.    */
  6.   public interface WebSSHService {
  7.       /**
  8.        * @Description: 初始化ssh连接
  9.        * @Param:
  10.        * @return:
  11.        * @Author: NoCortY
  12.        * @Date: 2020/3/7
  13.        */
  14.       public void initConnection(WebSocketSession session);
  15.  
  16.       /**
  17.        * @Description: 处理客户段发的数据
  18.        * @Param:
  19.        * @return:
  20.        * @Author: NoCortY
  21.        * @Date: 2020/3/7
  22.        */
  23.       public void recvHandle(String buffer, WebSocketSession session);
  24.  
  25.       /**
  26.        * @Description: 数据写回前端 for websocket
  27.        * @Param:
  28.        * @return:
  29.        * @Author: NoCortY
  30.        * @Date: 2020/3/7
  31.        */
  32.       public void sendMessage(WebSocketSession session, byte[] buffer) throws IOException;
  33.  
  34.       /**
  35.        * @Description: 关闭连接
  36.        * @Param:
  37.        * @return:
  38.        * @Author: NoCortY
  39.        * @Date: 2020/3/7
  40.        */
  41.       public void close(WebSocketSession session);
  42.   }

现在我们可以根据这个接口去实现我们定义的功能了。

1.初始化连接

由于我们的底层是依赖jsch实现的，所以这里是需要使用jsch去建立连接的。而所谓初始化连接，实际上就是将我们所需要的连接信息，保存在一个Map中，这里并不进行任何的真实连接操作。为什么这里不直接进行连接？因为这里前端只是连接上了WebSocket，但是我们还需要前端给我们发来linux终端的用户名和密码，没有这些信息，我们是无法进行连接的。

  1.      public void initConnection(WebSocketSession session) {
  2.              JSch jSch = new JSch();
  3.              SSHConnectInfo sshConnectInfo = new SSHConnectInfo();
  4.              sshConnectInfo.setjSch(jSch);
  5.              sshConnectInfo.setWebSocketSession(session);
  6.              String uuid = String.valueOf(session.getAttributes().get(ConstantPool.USER_UUID_KEY));
  7.              //将这个ssh连接信息放入map中
  8.              sshMap.put(uuid, sshConnectInfo);
  9.      }

2.处理客户端发送的数据

在这一步骤中，我们会分为两个分支。

  • 第一个分支：如果客户端发来的是终端的用户名和密码等信息，那么我们进行终端的连接。

  • 第二个分支：如果客户端发来的是操作终端的命令，那么我们就直接转发到终端并且获取终端的执行结果。

具体代码实现：

  1.      public void recvHandle(String buffer, WebSocketSession session) {
  2.              ObjectMapper objectMapper = new ObjectMapper();
  3.              WebSSHData webSSHData = null;
  4.              try {
  5.                  //转换前端发送的JSON
  6.                  webSSHData = objectMapper.readValue(buffer, WebSSHData.class);
  7.              } catch (IOException e) {
  8.                  logger.error("Json转换异常");
  9.                  logger.error("异常信息:{}", e.getMessage());
  10.                  return;
  11.              }
  12.          //获取刚才设置的随机的uuid
  13.              String userId = String.valueOf(session.getAttributes().get(ConstantPool.USER_UUID_KEY));
  14.              if (ConstantPool.WEBSSH_OPERATE_CONNECT.equals(webSSHData.getOperate())) {
  15.                  //如果是连接请求
  16.                  //找到刚才存储的ssh连接对象
  17.                  SSHConnectInfo sshConnectInfo = (SSHConnectInfo) sshMap.get(userId);
  18.                  //启动线程异步处理
  19.                  WebSSHData finalWebSSHData = webSSHData;
  20.                  executorService.execute(new Runnable() {
  21.                      @Override
  22.                      public void run() {
  23.                          try {
  24.                              //连接到终端
  25.                              connectToSSH(sshConnectInfo, finalWebSSHData, session);
  26.                          } catch (JSchException | IOException e) {
  27.                              logger.error("webssh连接异常");
  28.                              logger.error("异常信息:{}", e.getMessage());
  29.                              close(session);
  30.                          }
  31.                      }
  32.                  });
  33.              } else if (ConstantPool.WEBSSH_OPERATE_COMMAND.equals(webSSHData.getOperate())) {
  34.                  //如果是发送命令的请求
  35.                  String command = webSSHData.getCommand();
  36.                  SSHConnectInfo sshConnectInfo = (SSHConnectInfo) sshMap.get(userId);
  37.                  if (sshConnectInfo != null) {
  38.                      try {
  39.                          //发送命令到终端
  40.                          transToSSH(sshConnectInfo.getChannel(), command);
  41.                      } catch (IOException e) {
  42.                          logger.error("webssh连接异常");
  43.                          logger.error("异常信息:{}", e.getMessage());
  44.                          close(session);
  45.                      }
  46.                  }
  47.              } else {
  48.                  logger.error("不支持的操作");
  49.                  close(session);
  50.              }
  51.      }

3.数据通过websocket发送到前端

  1.      public void sendMessage(WebSocketSession session, byte[] buffer) throws IOException {
  2.              session.sendMessage(new TextMessage(buffer));
  3.      }

4.关闭连接

  1.      public void close(WebSocketSession session) {
  2.          //获取随机生成的uuid
  3.              String userId = String.valueOf(session.getAttributes().get(ConstantPool.USER_UUID_KEY));
  4.              SSHConnectInfo sshConnectInfo = (SSHConnectInfo) sshMap.get(userId);
  5.              if (sshConnectInfo != null) {
  6.                  //断开连接
  7.                  if (sshConnectInfo.getChannel() != null) sshConnectInfo.getChannel().disconnect();
  8.                  //map中移除该ssh连接信息
  9.                  sshMap.remove(userId);
  10.              }
  11.      }

至此，我们的整个后端实现就结束了，由于篇幅有限，这里将一些操作封装成了方法，就不做过多展示了，重点讲逻辑实现的思路吧。接下来我们将进行前端的实现。

前端实现

前端工作主要分为这么几个步骤：

  1. 页面的实现

  2. 连接WebSocket并完成数据的接收并回写

  3. 数据的发送

所以我们一步一步来实现它。

页面实现

页面的实现很简单，我们只不过需要在一整个屏幕上都显示终端那种大黑屏幕，所以我们并不用写什么样式，只需要创建一个div，之后将terminal实例通过xterm放到这个div中，就可以实现了。

  1.   <!doctype html>
  2.   <html>
  3.   <head>
  4.       <title>WebSSH</title>
  5.       <link rel="stylesheet" href="../css/xterm.css" />
  6.   </head>
  7.   <body>
  8.   <div id="terminal" style="width: 100%;height: 100%"></div>
  9.  
  10.   <script src="../lib/jquery-3.4.1/jquery-3.4.1.min.js"></script>
  11.   <script src="../js/xterm.js" charset="utf-8"></script>
  12.   <script src="../js/webssh.js" charset="utf-8"></script>
  13.   <script src="../js/base64.js" charset="utf-8"></script>
  14.   </body>
  15.   </html>

连接WebSocket并完成数据的发送、接收、回写

  1.   openTerminal( {
  2.       //这里的内容可以写死，但是要整合到项目中时，需要通过参数的方式传入，可以动态连接某个终端。
  3.           operate:'connect',
  4.           host: 'ip地址',
  5.           port: '端口号',
  6.           username: '用户名',
  7.           password: '密码'
  8.       });
  9.       function openTerminal(options){
  10.           var client = new WSSHClient();
  11.           var term = new Terminal({
  12.               cols: 97,
  13.               rows: 37,
  14.               cursorBlink: true, // 光标闪烁
  15.               cursorStyle: "block", // 光标样式  null | 'block' | 'underline' | 'bar'
  16.               scrollback: 800, //回滚
  17.               tabStopWidth: 8, //制表宽度
  18.               screenKeys: true
  19.           });
  20.  
  21.           term.on('data', function (data) {
  22.               //键盘输入时的回调函数
  23.               client.sendClientData(data);
  24.           });
  25.           term.open(document.getElementById('terminal'));
  26.           //在页面上显示连接中...
  27.           term.write('Connecting...');
  28.           //执行连接操作
  29.           client.connect({
  30.               onError: function (error) {
  31.                   //连接失败回调
  32.                   term.write('Error: ' + error + '\r\n');
  33.               },
  34.               onConnect: function () {
  35.                   //连接成功回调
  36.                   client.sendInitData(options);
  37.               },
  38.               onClose: function () {
  39.                   //连接关闭回调
  40.                   term.write("\rconnection closed");
  41.               },
  42.               onData: function (data) {
  43.                   //收到数据时回调
  44.                   term.write(data);
  45.               }
  46.           });
  47.       }

效果展示

连接

连接

连接成功

连接成功

命令操作

ls命令：

ls命令

vim编辑器:

vim编辑器

top命令：

top命令

结语

这样我们就完成了一个webssh项目的实现，没有依赖其它任何的组件，后端完全使用Java实现，由于用了SpringBoot，非常容易部署。

但是，我们还可以对这个项目进行扩展，比如新增上传或下载文件，就像Xftp一样，可以很方便地拖拽式上传下载文件。

这个项目之后我会持续更新，上述功能也会慢慢实现，Github：https://github.com/NoCortY/WebSSH

喜欢可以给个Star哦~

  1. 推荐文章
  2.  
  1. 原创电子书历时整整一年总结的 Java 面试 + Java 后端技术学习指南，这是本人这几年及校招的总结，各种高频面试题已经全部进行总结，按照章节复习即可，已经拿到了大厂offer。
  2. 原创思维导图扫码或者微信搜 程序员的技术圈子 回复 面试 领取原创电子书和思维导图。
声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/花生_TL007/article/detail/203122
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号