本人免費整理了Java高級資料，涵蓋了Java、Redis、MongoDB、MySQL、Zookeeper、Spring Cloud、Dubbo高併發分佈式等教程，一共30G，須要本身領取。
傳送門：https://mp.weixin.qq.com/s/osB-BOl6W-ZLTSttTkqMPQ
前言css
最近因爲項目需求，項目中須要實現一個WebSSH鏈接終端的功能，因爲本身第一次作這類型功能，因此首先上了GitHub找了找有沒有現成的輪子能夠拿來直接用，當時看到了不少這方面的項目，例如：GateOne、webssh、shellinabox等，這些項目均可以很好地實現webssh的功能。html
可是最終並無採用，緣由是在於這些底層大都是python寫的，須要依賴不少文件，本身用的時候可使用這種方案，快捷省事，可是作到項目中供用戶使用時，總不能要求用戶作到服務器中必須包含這些底層依賴，這顯然不太合理，因此我決定本身動手寫一個WebSSH的功能，而且做爲一個獨立的項目開源出來。前端
github項目開源地址：https://github.com/NoCortY/WebSSHnode
技術選型
因爲webssh須要實時數據交互，因此會選用長鏈接的WebSocket，爲了開發的方便，框架選用SpringBoot，另外還本身瞭解了Java用戶鏈接ssh的jsch和實現前端shell頁面的xterm.js.python
因此，最終的技術選型就是 SpringBoot+Websocket+jsch+xterm.js。jquery
導入依賴
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.7.RELEASE</version> <relativePath /> <!-- lookup parent from repository --> </parent> <dependencies> <!-- Web相關 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- jsch支持 --> <dependency> <groupId>com.jcraft</groupId> <artifactId>jsch</artifactId> <version>0.1.54</version> </dependency> <!-- WebSocket 支持 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> <!-- 文件上傳解析器 --> <dependency> <groupId>commons-io</groupId> <artifactId>commons-io</artifactId> <version>1.4</version> </dependency> <dependency> <groupId>commons-fileupload</groupId> <artifactId>commons-fileupload</artifactId> <version>1.3.1</version> </dependency> </dependencies>
一個簡單的 xterm 案例
因爲xterm是一個冷門技術，因此不少同窗並無這方面的知識支撐，我也是爲了實現這個功能因此臨時學的，因此在這給你們介紹一下。linux
xterm.js是一個基於WebSocket的容器，它能夠幫助咱們在前端實現命令行的樣式。就像是咱們日常再用SecureCRT或者XShell鏈接服務器時同樣。git
下面是官網上的入門案例：github
<!doctype html>
<html>
<head>
<link rel="stylesheet" href="node_modules/xterm/css/xterm.css" />
<script src="node_modules/xterm/lib/xterm.js"></script>
</head>
<body>
<div id="terminal"></div>
<script>
var term = new Terminal();
term.open(document.getElementById('terminal'));
term.write('Hello from \x1B[1;3;31mxterm.js\x1B[0m $ ')
</script>
</body>
</html>
最終測試，頁面就是下面這個樣子：web
xterm入門
能夠看到頁面已經出現了相似與shell的樣式，那就根據這個繼續深刻，實現一個webssh。
後端實現
因爲xterm只要只是實現了前端的樣式，並不能真正地實現與服務器交互，與服務器交互主要仍是靠咱們Java後端來進行控制的，因此咱們從後端開始，使用jsch+websocket實現這部份內容。
WebSocket配置
因爲消息實時推送到前端須要用到WebSocket，不瞭解WebSocket的同窗能夠先去自行了解一下，這裏就不過多介紹了，咱們直接開始進行WebSocket的配置。
/**
* @Description: websocket配置
* @Author: NoCortY
* @Date: 2020/3/8
*/
@Configuration
@EnableWebSocket
public class WebSSHWebSocketConfig implements WebSocketConfigurer{
@Autowired
WebSSHWebSocketHandler webSSHWebSocketHandler;
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) {
//socket通道
//指定處理器和路徑，並設置跨域
webSocketHandlerRegistry.addHandler(webSSHWebSocketHandler, "/webssh")
.addInterceptors(new WebSocketInterceptor())
.setAllowedOrigins("*");
}
}
處理器(Handler)和攔截器(Interceptor)的實現
剛纔咱們完成了WebSocket的配置，並指定了一個處理器和攔截器。因此接下來就是處理器和攔截器的實現。
攔截器：
public class WebSocketInterceptor implements HandshakeInterceptor {
/**
* @Description: Handler處理前調用
* @Param: [serverHttpRequest, serverHttpResponse, webSocketHandler, map]
* @return: boolean
* @Author: NoCortY
* @Date: 2020/3/1
*/
@Override
public boolean beforeHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Map<String, Object> 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: WebSSH的WebSocket處理器
* @Author: NoCortY
* @Date: 2020/3/8
*/
@Component
public class WebSSHWebSocketHandler implements WebSocketHandler{
@Autowired
private WebSSHService webSSHService;
private Logger logger = LoggerFactory.getLogger(WebSSHWebSocketHandler.class);
/**
* @Description: 用戶鏈接上WebSocket的回調
* @Param: [webSocketSession]
* @return: void
* @Author: Object
* @Date: 2020/3/8
*/
@Override
public void afterConnectionEstablished(WebSocketSession webSocketSession) throws Exception {
logger.info("用戶:{},鏈接WebSSH", webSocketSession.getAttributes().get(ConstantPool.USER_UUID_KEY));
//調用初始化鏈接
webSSHService.initConnection(webSocketSession);
}
/**
* @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;
}
}
須要注意的是，我在攔截器中加入的用戶標識是使用了隨機的UUID，這是由於做爲一個獨立的websocket項目，沒有用戶模塊，若是須要將這個項目集成到本身的項目中，須要修改這部分代碼，將其改成本身項目中識別一個用戶所用的用戶標識。
WebSSH的業務邏輯實現（核心）
剛纔咱們實現了websocket的配置，都是一些死代碼，實現了接口再根據自身需求便可實現，如今咱們將進行後端主要業務邏輯的實現，在實現這個邏輯以前，咱們先來想一想，WebSSH，咱們主要想要呈現一個什麼效果。
我這裏作了一個總結：
1.首先咱們得先鏈接上終端（初始化鏈接）
2.其次咱們的服務端須要處理來自前端的消息（接收並處理前端消息）
3.咱們須要將終端返回的消息回寫到前端（數據回寫前端）
4.關閉鏈接
根據這四個需求，咱們先定義一個接口，這樣可讓需求明瞭起來。
/**
* @Description: WebSSH的業務邏輯
* @Author: NoCortY
* @Date: 2020/3/7
*/
public interface WebSSHService {
/**
* @Description: 初始化ssh鏈接
* @Param:
* @return:
* @Author: NoCortY
* @Date: 2020/3/7
*/
public void initConnection(WebSocketSession session);
/**
* @Description: 處理客戶段發的數據
* @Param:
* @return:
* @Author: NoCortY
* @Date: 2020/3/7
*/
public void recvHandle(String buffer, WebSocketSession session);
/**
* @Description: 數據寫回前端 for websocket
* @Param:
* @return:
* @Author: NoCortY
* @Date: 2020/3/7
*/
public void sendMessage(WebSocketSession session, byte[] buffer) throws IOException;
/**
* @Description: 關閉鏈接
* @Param:
* @return:
* @Author: NoCortY
* @Date: 2020/3/7
*/
public void close(WebSocketSession session);
}
如今咱們能夠根據這個接口去實現咱們定義的功能了。
1.初始化鏈接
因爲咱們的底層是依賴jsch實現的，因此這裏是須要使用jsch去創建鏈接的。而所謂初始化鏈接，實際上就是將咱們所須要的鏈接信息，保存在一個Map中，這裏並不進行任何的真實鏈接操做。爲何這裏不直接進行鏈接？由於這裏前端只是鏈接上了WebSocket，可是咱們還須要前端給咱們發來linux終端的用戶名和密碼，沒有這些信息，咱們是沒法進行鏈接的。
public void initConnection(WebSocketSession session) {
JSch jSch = new JSch();
SSHConnectInfo sshConnectInfo = new SSHConnectInfo();
sshConnectInfo.setjSch(jSch);
sshConnectInfo.setWebSocketSession(session);
String uuid = String.valueOf(session.getAttributes().get(ConstantPool.USER_UUID_KEY));
//將這個ssh鏈接信息放入map中
sshMap.put(uuid, sshConnectInfo);
}
2.處理客戶端發送的數據
在這一步驟中，咱們會分爲兩個分支。
- 第一個分支：若是客戶端發來的是終端的用戶名和密碼等信息，那麼咱們進行終端的鏈接。
- 第二個分支：若是客戶端發來的是操做終端的命令，那麼咱們就直接轉發到終端而且獲取終端的執行結果。
具體代碼實現：
public void recvHandle(String buffer, WebSocketSession session) {
ObjectMapper objectMapper = new ObjectMapper();
WebSSHData webSSHData = null;
try {
//轉換前端發送的JSON
webSSHData = objectMapper.readValue(buffer, WebSSHData.class);
} catch (IOException e) {
logger.error("Json轉換異常");
logger.error("異常信息:{}", e.getMessage());
return;
}
//獲取剛纔設置的隨機的uuid
String userId = String.valueOf(session.getAttributes().get(ConstantPool.USER_UUID_KEY));
if (ConstantPool.WEBSSH_OPERATE_CONNECT.equals(webSSHData.getOperate())) {
//若是是鏈接請求
//找到剛纔存儲的ssh鏈接對象
SSHConnectInfo sshConnectInfo = (SSHConnectInfo) sshMap.get(userId);
//啓動線程異步處理
WebSSHData finalWebSSHData = webSSHData;
executorService.execute(new Runnable() {
@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 = webSSHData.getCommand();
SSHConnectInfo sshConnectInfo = (SSHConnectInfo) sshMap.get(userId);
if (sshConnectInfo != 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 = String.valueOf(session.getAttributes().get(ConstantPool.USER_UUID_KEY));
SSHConnectInfo sshConnectInfo = (SSHConnectInfo) sshMap.get(userId);
if (sshConnectInfo != null) {
//斷開鏈接
if (sshConnectInfo.getChannel() != null) sshConnectInfo.getChannel().disconnect();
//map中移除該ssh鏈接信息
sshMap.remove(userId);
}
}
至此，咱們的整個後端實現就結束了，因爲篇幅有限，這裏將一些操做封裝成了方法，就不作過多展現了，重點講邏輯實現的思路吧。接下來咱們將進行前端的實現。
前端實現
前端工做主要分爲這麼幾個步驟：
- 頁面的實現
- 鏈接WebSocket並完成數據的接收並回寫
- 數據的發送
因此咱們一步一步來實現它。
頁面實現
頁面的實現很簡單，咱們只不過須要在一整個屏幕上都顯示終端那種大黑屏幕，因此咱們並不用寫什麼樣式，只須要建立一個div，以後將terminal實例經過xterm放到這個div中，就能夠實現了。
<!doctype html> <html> <head> <title>WebSSH</title> <link rel="stylesheet" href="../css/xterm.css" /> </head> <body> <div id="terminal" style="width: 100%;height: 100%"></div> <script src="../lib/jquery-3.4.1/jquery-3.4.1.min.js"></script> <script src="../js/xterm.js" charset="utf-8"></script> <script src="../js/webssh.js" charset="utf-8"></script> <script src="../js/base64.js" charset="utf-8"></script> </body> </html>
鏈接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
});
term.on('data', function (data) {
//鍵盤輸入時的回調函數
client.sendClientData(data);
});
term.open(document.getElementById('terminal'));
//在頁面上顯示鏈接中...
term.write('Connecting...');
//執行鏈接操做
client.connect({
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命令：
ls命令
vim編輯器:
vim編輯器
top命令：
top命令
結語
這樣咱們就完成了一個webssh項目的實現，沒有依賴其它任何的組件，後端徹底使用Java實現，因爲用了SpringBoot，很是容易部署。
可是，咱們還能夠對這個項目進行擴展，好比新增上傳或下載文件，就像Xftp同樣，能夠很方便地拖拽式上傳下載文件。