java实现ssh_使用纯Java实现一个WebSSH项目

发布于:2021-10-01 06:19:42


技术选型


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


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


导入依赖



一个简单的xterm案例


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


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


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



最终测试,页面就是下面这个样子:



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


后端实现


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


1.WebSocket配置


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



2.处理器(Handler)和拦*(Interceptor)的实现


刚才我们完成了WebSocket的配置,并指定了一个处理器和拦*鳌K越酉吕淳褪谴砥骱屠菇*鞯氖迪帧


拦*鳎


public class WebSocketInterceptor implements HandshakeInterceptor {


/**


* @Description: Handler处理前调用


* [@Param](https://my.oschina.net/u/2303379): [serverHttpRequest, serverHttpResponse, webSocketHandler, map]


* [@return](https://my.oschina.net/u/556800): boolean


* [@Author](https://my.oschina.net/arthor): NoCortY


* [@Date](https://my.oschina.net/u/2504391): 2020/3/1


*/


@Override


public boolean beforeHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Map map) throws Exception {


if (serverHttpRequest instanceof ServletServerHttpRequest) {


ServletServerHttpRequest request = (ServletServerHttpRequest) serverHttpRequest;


//生成一个UUID,这里由于是独立的项目,没有用户模块,所以可以用随机的UUID


//但是如果要集成到自己的项目中,需要将其改为自己识别用户的标识


String uuid = UUID.randomUUID().toString().replace("-","");


//将uuid放到websocketsession中


map.put(ConstantPool.USER_UUID_KEY, uuid);


return true;


} else {


return false;


}


}


@Override


public void afterHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Exception e) {


}


}


处理器:



/**


* @Description: 收到消息的回调


* @Param: [webSocketSession, webSocketMessage]


* @return: void


* @Author: NoCortY


* @Date: 2020/3/8


*/


@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: " + webSocketMessage);


}


}


/**


* @Description: 出现错误的回调


* @Param: [webSocketSession, throwable]


* @return: void


* @Author: Object


* @Date: 2020/3/8


*/


@Override


public void handleTransportError(WebSocketSession webSocketSession, Throwable throwable) throws Exception {


logger.error("数据传输错误");


}


/**


* @Description: 连接关闭的回调


* @Param: [webSocketSession, closeStatus]


* @return: void


* @Author: NoCortY


* @Date: 2020/3/8


*/


@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);


}


@Override


public boolean supportsPartialMessages() {


return false;


}


}


需要注意的是,我在拦*髦屑尤氲挠没П晔妒鞘褂昧怂婊腢UID,这是因为作为一个独立的websocket项目,没有用户模块,如果需要将这个项目集成到自己的项目中,需要修改这部分代码,将其改为自己项目中识别一个用户所用的用户标识。


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


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


我这里做了一个总结:


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


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


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


关闭连接


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



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


1.初始化连接


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



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


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


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


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


具体代码实现:



数据通过websocket发送到前端



关闭连接



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


前端实现


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


页面的实现


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


数据的发送


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


页面实现


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



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



效果展示


连接



连接成功



命令操作


ls命令:



vim编辑器:



top命令:



结语


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


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







相关资源:SSH2用户名密码验证

相关推荐

最新更新

猜你喜欢