springboot初始化⼀个常量map_教你⽤纯Java实现⼀个⽹页
版的Xshell(附源码)
前⾔
最近由于项⽬需求,项⽬中需要实现⼀个WebSSH连接终端的功能,由于⾃⼰第⼀次做这类型功能,所以⾸先上了GitHub了有没有现成的轮⼦可以拿来直接⽤,当时看到了很多这⽅⾯的项⽬,例如:GateOne、webssh、shellinabox等,这些项⽬都可以很好地实现webssh的功能。
但是最终并没有采⽤,原因是在于这些底层⼤都是python写的,需要依赖很多⽂件,⾃⼰⽤的时候可以使⽤这种⽅案,快捷省事,但是做到项⽬中供⽤户使⽤时,总不能要求⽤户做到服务器中必须包含这些底层依赖,这显然不太合理,所以我决定⾃⼰动⼿写⼀个WebSSH的功能,并且作为⼀个独⽴的项⽬开源出来。
技术选型
由于webssh需要实时数据交互,所以会选⽤长连接的WebSocket,为了开发的⽅便,框架选⽤SpringBoot,另外还⾃⼰了解了Java⽤户连接ssh的jsch和实现前端shell页⾯的xterm.js.
所以,最终的技术选型就是 SpringBoot+Websocket+jsch+xterm.js。
导⼊依赖
<parent>
⼀个简单的xterm案例
由于xterm是⼀个冷门技术,所以很多同学并没有这⽅⾯的知识⽀撑,我也是为了实现这个功能所以临时学的,所以在这给⼤家介绍⼀下。
xterm.js是⼀个基于WebSocket的容器,它可以帮助我们在前端实现命令⾏的样式。就像是我们平常再⽤SecureCRT或者XShell连接服务器时⼀样。
下⾯是官⽹上的⼊门案例:
html>
最终测试,页⾯就是下⾯这个样⼦:
xterm⼊门
可以看到页⾯已经出现了类似与shell的样式,那就根据这个继续深⼊,实现⼀个webssh。
后端实现
由于xterm只要只是实现了前端的样式,并不能真正地实现与服务器交互,与服务器交互主要还是靠我们Java后端来进⾏控制的,所以我们从后端开始,使⽤jsch+websocket实现这部分内容。
WebSocket配置
由于消息实时推送到前端需要⽤到WebSocket,不了解WebSocket的同学可以先去⾃⾏了解⼀下,这⾥就不过多介绍了,我们直接开始进⾏WebSocket的配置。
/**
* @Description: websocket配置
* @Author: NoCortY
* @Date: 2020/3/8
*/
处理器(Handler)和(Interceptor)的实现
刚才我们完成了WebSocket的配置,并指定了⼀个处理器和。所以接下来就是处理器和的实现。
public
springboot结构
处理器:
/**
* @Description: WebSSH的WebSocket处理器
* @Author: NoCortY
* @Date: 2020/3/8
*/
需要注意的是,我在中加⼊的⽤户标识是使⽤了随机的UUID,这是因为作为⼀个独⽴的websocket项⽬,没有⽤户模块,如果需要将这个项⽬集成到⾃⼰的项⽬中,需要修改这部分代码,将其改为⾃⼰项⽬中识别⼀个⽤户所⽤的⽤户标识。
WebSSH的业务逻辑实现(核⼼)
刚才我们实现了websocket的配置,都是⼀些死代码,实现了接⼝再根据⾃⾝需求即可实现,现在我们将进⾏后端主要业务逻辑的实现,在实现这个逻辑之前,我们先来想想,WebSSH,我们主要想要呈现⼀个什么效果。
我这⾥做了⼀个总结:
1.⾸先我们得先连接上终端(初始化连接)
2.其次我们的服务端需要处理来⾃前端的消息(接收并处理前端消息)
3.我们需要将终端返回的消息回写到前端(数据回写前端)
4.关闭连接
根据这四个需求,我们先定义⼀个接⼝,这样可以让需求明了起来。
* @Description: WebSSH的业务逻辑
* @Author: NoCortY
* @Date: 2020/3/7
*/
现在我们可以根据这个接⼝去实现我们定义的功能了。
1.初始化连接
由于我们的底层是依赖jsch实现的,所以这⾥是需要使⽤jsch去建⽴连接的。⽽所谓初始化连接,实际上就是将我们所需要的连接信息,保存在⼀个Map中,这⾥并不进⾏任何的真实连接操作。为什么这⾥不直接进⾏连接?因为这⾥前端只是连接上了WebSocket,但是我们还需要前端给我们发来linux终端的⽤户名和密码,没有这些信息,我们是⽆法进⾏连接的。
public void initConnection(WebSocketSession session) {
2.处理客户端发送的数据
在这⼀步骤中,我们会分为两个分⽀。
第⼀个分⽀:如果客户端发来的是终端的⽤户名和密码等信息,那么我们进⾏终端的连接。
第⼆个分⽀:如果客户端发来的是操作终端的命令,那么我们就直接转发到终端并且获取终端的执⾏结果。
具体代码实现:
public void recvHandle(String buffer, WebSocketSession session) {
3.数据通过websocket发送到前端
public void sendMessage(WebSocketSession session, byte[] buffer) throws IOException {
4.关闭连接
public void close(WebSocketSession session) {
⾄此,我们的整个后端实现就结束了,由于篇幅有限,这⾥将⼀些操作封装成了⽅法,就不做过多展⽰了,重点讲逻辑实现的思路吧。接下来我们将进⾏前端的实现。
前端实现
前端⼯作主要分为这么⼏个步骤:
1. 页⾯的实现
2. 连接WebSocket并完成数据的接收并回写
3. 数据的发送
所以我们⼀步⼀步来实现它。
页⾯实现
页⾯的实现很简单,我们只不过需要在⼀整个屏幕上都显⽰终端那种⼤⿊屏幕,所以我们并不⽤写什么样式,只需要创建⼀个div,之后将terminal实例通过xterm放到这个div中,就可以实现了。
连接WebSocket并完成数据的发送、接收、回写
openTerminal( {
//这⾥的内容可以写死,但是要整合到项⽬中时,需要通过参数的⽅式传⼊,可以动态连接某个终端。          operate:'connect',
host: 'ip地址',
port: '端⼝号',
username: '⽤户名',
password: '密码'
});
function openTerminal(options){
var client = new WSSHClient();
var term = new Terminal({
cols: 97,
rows: 37,
cursorBlink: true, // 光标闪烁
cursorStyle: "block", // 光标样式  null | 'block' | 'underline' | 'bar'
scrollback: 800, //回滚
tabStopWidth: 8, //制表宽度
screenKeys: true
});
<('data', function (data) {
//键盘输⼊时的回调函数
client.sendClientData(data);
});
term.ElementById('terminal'));
//在页⾯上显⽰连接中...
term.write('');
//执⾏连接操作
onError: function (error) {
//连接失败回调
term.write('Error: ' + error + '\r\n');
},
onConnect: function () {
//连接成功回调
client.sendInitData(options);
},
onClose: function () {
//连接关闭回调
term.write("\rconnection closed");
},
onData: function (data) {
/
/收到数据时回调
term.write(data);
}
});
}
效果展⽰
连接
连接成功
连接成功命令操作
ls命令:

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。