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

前言

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

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

技术选型

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

所以&＃xff0c;最终的技术选型就是 SpringBoot&＃43;Websocket&＃43;jsch&＃43;xterm.js。

导入依赖

    org.springframework.boot    spring-boot-starter-parent    2.1.7.RELEASE                     org.springframework.boot        spring-boot-starter-web                    com.jcraft        jsch        0.1.54                    org.springframework.boot        spring-boot-starter-websocket                    commons-io        commons-io        1.4                commons-fileupload        commons-fileupload        1.3.1    

一个简单的xterm案例

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

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

下面是官网上的入门案例&＃xff1a;

html>                   

最终测试&＃xff0c;页面就是下面这个样子&＃xff1a;

xterm入门

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

后端实现

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

WebSocket配置

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

  /**  * &＃64;Description: websocket配置  * &＃64;Author: NoCortY  * &＃64;Date: 2020/3/8  */  &＃64;Configuration  &＃64;EnableWebSocket  public class WebSSHWebSocketConfig implements WebSocketConfigurer{      &＃64;Autowired      WebSSHWebSocketHandler webSSHWebSocketHandler;      &＃64;Override      public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) {          //socket通道          //指定处理器和路径&＃xff0c;并设置跨域          webSocketHandlerRegistry.addHandler(webSSHWebSocketHandler, "/webssh")                  .addInterceptors(new WebSocketInterceptor())                  .setAllowedOrigins("*");      }  }

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

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

拦截器&＃xff1a;

  public class WebSocketInterceptor implements HandshakeInterceptor {      /**       * &＃64;Description: Handler处理前调用       * &＃64;Param: [serverHttpRequest, serverHttpResponse, webSocketHandler, map]       * &＃64;return: boolean       * &＃64;Author: NoCortY       * &＃64;Date: 2020/3/1       */      &＃64;Override      public boolean beforeHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Map map) throws Exception {          if (serverHttpRequest instanceof ServletServerHttpRequest) {              ServletServerHttpRequest request &＃61; (ServletServerHttpRequest) serverHttpRequest;              //生成一个UUID&＃xff0c;这里由于是独立的项目&＃xff0c;没有用户模块&＃xff0c;所以可以用随机的UUID              //但是如果要集成到自己的项目中&＃xff0c;需要将其改为自己识别用户的标识              String uuid &＃61; UUID.randomUUID().toString().replace("-","");              //将uuid放到websocketsession中              map.put(ConstantPool.USER_UUID_KEY, uuid);              return true;          } else {              return false;          }      }      &＃64;Override      public void afterHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Exception e) {      }  }

处理器&＃xff1a;

  /**  * &＃64;Description: WebSSH的WebSocket处理器  * &＃64;Author: NoCortY  * &＃64;Date: 2020/3/8  */  &＃64;Component  public class WebSSHWebSocketHandler implements WebSocketHandler{      &＃64;Autowired      private WebSSHService webSSHService;      private Logger logger &＃61; LoggerFactory.getLogger(WebSSHWebSocketHandler.class);      /**       * &＃64;Description: 用户连接上WebSocket的回调       * &＃64;Param: [webSocketSession]       * &＃64;return: void       * &＃64;Author: Object       * &＃64;Date: 2020/3/8       */      &＃64;Override      public void afterConnectionEstablished(WebSocketSession webSocketSession) throws Exception {          logger.info("用户:{},连接WebSSH", webSocketSession.getAttributes().get(ConstantPool.USER_UUID_KEY));          //调用初始化连接          webSSHService.initConnection(webSocketSession);      }      /**       * &＃64;Description: 收到消息的回调       * &＃64;Param: [webSocketSession, webSocketMessage]       * &＃64;return: void       * &＃64;Author: NoCortY       * &＃64;Date: 2020/3/8       */      &＃64;Override      public void handleMessage(WebSocketSession webSocketSession, WebSocketMessage> webSocketMessage) throws Exception {          if (webSocketMessage instanceof TextMessage) {              logger.info("用户:{},发送命令:{}", webSocketSession.getAttributes().get(ConstantPool.USER_UUID_KEY), webSocketMessage.toString());              //调用service接收消息              webSSHService.recvHandle(((TextMessage) webSocketMessage).getPayload(), webSocketSession);          } else if (webSocketMessage instanceof BinaryMessage) {          } else if (webSocketMessage instanceof PongMessage) {          } else {              System.out.println("Unexpected WebSocket message type: " &＃43; webSocketMessage);          }      }      /**       * &＃64;Description: 出现错误的回调       * &＃64;Param: [webSocketSession, throwable]       * &＃64;return: void       * &＃64;Author: Object       * &＃64;Date: 2020/3/8       */      &＃64;Override      public void handleTransportError(WebSocketSession webSocketSession, Throwable throwable) throws Exception {          logger.error("数据传输错误");      }      /**       * &＃64;Description: 连接关闭的回调       * &＃64;Param: [webSocketSession, closeStatus]       * &＃64;return: void       * &＃64;Author: NoCortY       * &＃64;Date: 2020/3/8       */      &＃64;Override      public void afterConnectionClosed(WebSocketSession webSocketSession, CloseStatus closeStatus) throws Exception {          logger.info("用户:{}断开webssh连接", String.valueOf(webSocketSession.getAttributes().get(ConstantPool.USER_UUID_KEY)));          //调用service关闭连接          webSSHService.close(webSocketSession);      }      &＃64;Override      public boolean supportsPartialMessages() {          return false;      }  }

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

WebSSH的业务逻辑实现(核心)

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

我这里做了一个总结&＃xff1a;

1.首先我们得先连接上终端(初始化连接)

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

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

4.关闭连接

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

  /**   * &＃64;Description: WebSSH的业务逻辑   * &＃64;Author: NoCortY   * &＃64;Date: 2020/3/7   */  public interface WebSSHService {      /**       * &＃64;Description: 初始化ssh连接       * &＃64;Param:       * &＃64;return:       * &＃64;Author: NoCortY       * &＃64;Date: 2020/3/7       */      public void initConnection(WebSocketSession session);      /**       * &＃64;Description: 处理客户段发的数据       * &＃64;Param:       * &＃64;return:       * &＃64;Author: NoCortY       * &＃64;Date: 2020/3/7       */      public void recvHandle(String buffer, WebSocketSession session);      /**       * &＃64;Description: 数据写回前端 for websocket       * &＃64;Param:       * &＃64;return:       * &＃64;Author: NoCortY       * &＃64;Date: 2020/3/7       */      public void sendMessage(WebSocketSession session, byte[] buffer) throws IOException;      /**       * &＃64;Description: 关闭连接       * &＃64;Param:       * &＃64;return:       * &＃64;Author: NoCortY       * &＃64;Date: 2020/3/7       */      public void close(WebSocketSession session);  }

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

1.初始化连接

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

     public void initConnection(WebSocketSession session) {             JSch jSch &＃61; new JSch();             SSHConnectInfo sshConnectInfo &＃61; new SSHConnectInfo();             sshConnectInfo.setjSch(jSch);             sshConnectInfo.setWebSocketSession(session);             String uuid &＃61; String.valueOf(session.getAttributes().get(ConstantPool.USER_UUID_KEY));             //将这个ssh连接信息放入map中             sshMap.put(uuid, sshConnectInfo);     }

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

在这一步骤中&＃xff0c;我们会分为两个分支。

• 第一个分支&＃xff1a;如果客户端发来的是终端的用户名和密码等信息&＃xff0c;那么我们进行终端的连接。
• 第二个分支&＃xff1a;如果客户端发来的是操作终端的命令&＃xff0c;那么我们就直接转发到终端并且获取终端的执行结果。

具体代码实现&＃xff1a;

     public void recvHandle(String buffer, WebSocketSession session) {             ObjectMapper objectMapper &＃61; new ObjectMapper();             WebSSHData webSSHData &＃61; null;             try {                 //转换前端发送的JSON                 webSSHData &＃61; objectMapper.readValue(buffer, WebSSHData.class);             } catch (IOException e) {                 logger.error("Json转换异常");                 logger.error("异常信息:{}", e.getMessage());                 return;             }         //获取刚才设置的随机的uuid             String userId &＃61; String.valueOf(session.getAttributes().get(ConstantPool.USER_UUID_KEY));             if (ConstantPool.WEBSSH_OPERATE_CONNECT.equals(webSSHData.getOperate())) {                 //如果是连接请求                 //找到刚才存储的ssh连接对象                 SSHConnectInfo sshConnectInfo &＃61; (SSHConnectInfo) sshMap.get(userId);                 //启动线程异步处理                 WebSSHData finalWebSSHData &＃61; webSSHData;                 executorService.execute(new Runnable() {                     &＃64;Override                     public void run() {                         try {                             //连接到终端                             connectToSSH(sshConnectInfo, finalWebSSHData, session);                         } catch (JSchException | IOException e) {                             logger.error("webssh连接异常");                             logger.error("异常信息:{}", e.getMessage());                             close(session);                         }                     }                 });             } else if (ConstantPool.WEBSSH_OPERATE_COMMAND.equals(webSSHData.getOperate())) {                 //如果是发送命令的请求                 String command &＃61; webSSHData.getCommand();                 SSHConnectInfo sshConnectInfo &＃61; (SSHConnectInfo) sshMap.get(userId);                 if (sshConnectInfo !&＃61; null) {                     try {                         //发送命令到终端                         transToSSH(sshConnectInfo.getChannel(), command);                     } catch (IOException e) {                         logger.error("webssh连接异常");                         logger.error("异常信息:{}", e.getMessage());                         close(session);                     }                 }             } else {                 logger.error("不支持的操作");                 close(session);             }     }

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

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

4.关闭连接

     public void close(WebSocketSession session) {         //获取随机生成的uuid             String userId &＃61; String.valueOf(session.getAttributes().get(ConstantPool.USER_UUID_KEY));             SSHConnectInfo sshConnectInfo &＃61; (SSHConnectInfo) sshMap.get(userId);             if (sshConnectInfo !&＃61; null) {                 //断开连接                 if (sshConnectInfo.getChannel() !&＃61; null) sshConnectInfo.getChannel().disconnect();                 //map中移除该ssh连接信息                 sshMap.remove(userId);             }     }

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

前端实现

前端工作主要分为这么几个步骤&＃xff1a;

1. 页面的实现
2. 连接WebSocket并完成数据的接收并回写
3. 数据的发送

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

页面实现

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

  html>          WebSSH            

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

  openTerminal( {      //这里的内容可以写死&＃xff0c;但是要整合到项目中时&＃xff0c;需要通过参数的方式传入&＃xff0c;可以动态连接某个终端。          operate:&＃39;connect&＃39;,          host: &＃39;ip地址&＃39;,          port: &＃39;端口号&＃39;,          username: &＃39;用户名&＃39;,          password: &＃39;密码&＃39;      });      function openTerminal(options){          var client &＃61; new WSSHClient();          var term &＃61; new Terminal({              cols: 97,              rows: 37,              cursorBlink: true, // 光标闪烁              cursorStyle: "block", // 光标样式  null | &＃39;block&＃39; | &＃39;underline&＃39; | &＃39;bar&＃39;              scrollback: 800, //回滚              tabStopWidth: 8, //制表宽度              screenKeys: true          });          term.on(&＃39;data&＃39;, function (data) {              //键盘输入时的回调函数              client.sendClientData(data);          });          term.open(document.getElementById(&＃39;terminal&＃39;));          //在页面上显示连接中...          term.write(&＃39;Connecting...&＃39;);          //执行连接操作          client.connect({              onError: function (error) {                  //连接失败回调                  term.write(&＃39;Error: &＃39; &＃43; error &＃43; &＃39;&＃39;);              },              onConnect: function () {                  //连接成功回调                  client.sendInitData(options);              },              onClose: function () {                  //连接关闭回调                  term.write("connection closed");              },              onData: function (data) {                  //收到数据时回调                  term.write(data);              }          });      }

效果展示

连接

连接

连接成功

连接成功

命令操作

ls命令&＃xff1a;

ls命令

vim编辑器:

vim编辑器

top命令&＃xff1a;

top命令

结语

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

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

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

喜欢可以给个Star哦~