SpringBoot使用JSch操作Linux的方法
推薦使用Hutool的Jsch工具包(它用的連接池的技術(shù))
一、SSH遠(yuǎn)程連接服務(wù)器
SSH更多見:http://t.csdnimg.cn/PrsNv
推薦連接工具:FinalShell、Xshell、secureCRT、PuTTY
(http://www.dbjr.com.cn/article/232575.htm)
1、SSH(Secure Shell)主要有兩大功能
- 1、遠(yuǎn)程命令執(zhí)行:SSH允許用戶在遠(yuǎn)程主機(jī)上執(zhí)行命令。用戶可以通過SSH連接到遠(yuǎn)程主機(jī),然后在命令行界面輸入命令,就像直接在遠(yuǎn)程主機(jī)的控制臺上操作一樣。這是SSH最常用的功能,它使得用戶可以方便地管理和維護(hù)遠(yuǎn)程主機(jī)。
- 2、安全的文件傳輸:SSH提供了SFTP(SSH File Transfer Protocol)和SCP(Secure Copy)兩種文件傳輸協(xié)議,用于在本地主機(jī)和遠(yuǎn)程主機(jī)之間安全地傳輸文件。這兩種協(xié)議都使用SSH的安全機(jī)制,可以保護(hù)文件在傳輸過程中的安全性和完整性。
- 3、除了這兩大功能,SSH還有一些其他的功能,例如端口轉(zhuǎn)發(fā)和動態(tài)端口轉(zhuǎn)發(fā)(也稱為SOCKS代理),它們可以用來建立安全的網(wǎng)絡(luò)連接,或者繞過網(wǎng)絡(luò)限制。
二、JNA、Process和JSchJNA
JNA主要用于在Java程序中調(diào)用本地庫的函數(shù),而不是用于遠(yuǎn)程連接到其他系統(tǒng)。如果你的Java程序正在Linux系統(tǒng)上運(yùn)行,你可以使用JNA來調(diào)用Linux的本地庫函數(shù),包括那些可以獲取文件和文件夾路徑的函數(shù)。然而,如果你的Java程序正在一個系統(tǒng)(如Windows)上運(yùn)行,你不能使用JNA來連接到另一個系統(tǒng)(如Linux)。
- JSch
如果你需要從一個運(yùn)行在Windows上的Java程序連接到一個Linux系統(tǒng),你可能需要使用其他的工具或庫。例如,你可以使用SSH(安全殼層)來遠(yuǎn)程連接到Linux系統(tǒng),然后執(zhí)行命令來獲取文件和文件夾的路徑。在Java中,有一些庫可以幫助你使用SSH,如JSch和Apache MINA SSHD。
簡單理解JNA、Process和JSch
- JNA
(Java Native Access)和Process類都是Java中與本地系統(tǒng)交互的工具。JNA允許Java代碼直接調(diào)用本地(C/C++)庫的函數(shù),而Process類則允許Java代碼啟動和控制操作系統(tǒng)的進(jìn)程,例如執(zhí)行shell命令。(JNA和Process是Java調(diào)用系統(tǒng)(Windows、Linux等)的本地函數(shù),或者三方程序)
JSch是一個Java庫,它提供了SSH(Secure Shell)的Java實(shí)現(xiàn),允許Java程序通過SSH協(xié)議連接到遠(yuǎn)程系統(tǒng)(如Linux)。一旦連接成功,你可以通過JSch執(zhí)行遠(yuǎn)程命令,上傳和下載文件,就像直接在遠(yuǎn)程系統(tǒng)上操作一樣。(JSch則是Java連接系統(tǒng)(Windows、Linux等)的工具,比如連接上Linux后,相當(dāng)于直接操作Linux一樣)
三、Java使用SSH的包
3.1、JSch和Apache MINA SSHD
JSch和Apache MINA SSHD都是優(yōu)秀的SSH庫,它們各有優(yōu)點(diǎn),選擇哪一個主要取決于你的具體需求。
JSch是一個成熟且廣泛使用的庫,它提供了SSH2的完整實(shí)現(xiàn),包括SFTP,SCP,端口轉(zhuǎn)發(fā)等功能。JSch的API相對簡單,易于使用,而且JSch的社區(qū)活躍,有大量的教程和示例代碼可供參考。
Apache MINA SSHD則是一個更現(xiàn)代的庫,它基于Apache MINA,一個高性能的網(wǎng)絡(luò)應(yīng)用框架。MINA SSHD提供了SSH2的完整實(shí)現(xiàn),包括SFTP,SCP,端口轉(zhuǎn)發(fā)等功能。MINA SSHD的API設(shè)計更現(xiàn)代,更符合Java的編程習(xí)慣,而且MINA SSHD支持異步非阻塞IO,對于需要處理大量并發(fā)連接的應(yīng)用來說,可能會有更好的性能。
總的來說,如果你需要一個簡單易用,社區(qū)支持好的SSH庫,JSch可能是一個不錯的選擇。如果你需要一個設(shè)計現(xiàn)代,支持異步非阻塞IO的SSH庫,或者你已經(jīng)在使用Apache MINA,那么MINA SSHD可能更適合你。
3.2、JSch的四種認(rèn)證機(jī)制:
- 密碼(本文使用):這是最常見的身份驗(yàn)證方式,用戶需要提供用戶名和密碼來進(jìn)行身份驗(yàn)證。
- 公鑰:在這種方式中,用戶需要提供一個私鑰,JSch會使用這個私鑰來進(jìn)行身份驗(yàn)證。這種方式通常比基于密碼的身份驗(yàn)證更安全,因?yàn)樗借€通常比密碼更難被猜測或者破解。
- 鍵盤交互:這種方式允許服務(wù)器發(fā)送一個或多個提問給客戶端,客戶端需要回答這些問題來進(jìn)行身份驗(yàn)證。這種方式可以用來實(shí)現(xiàn)一些復(fù)雜的身份驗(yàn)證流程,例如一次性密碼,或者多因素身份驗(yàn)證。
- GSSAPI:GSSAPI是一種用于安全通信的API,它支持各種不同的身份驗(yàn)證機(jī)制,例如Kerberos。JSch可以使用GSSAPI來進(jìn)行身份驗(yàn)證,但這需要額外的庫支持。
四、JSch實(shí)現(xiàn)登錄Linux,遠(yuǎn)程命令執(zhí)行、SFTP下載和上傳文件
4.1、導(dǎo)包Jsch官方的包上次更新18年(本文使用)
// jsch包 implementation 'com.jcraft:jsch:0.1.55'
長期維護(hù)的jsch:https://github.com/mwiede/jsch
4.2、Jsch工具類
package com.cc.jschdemo.utils; import com.jcraft.jsch.*; import lombok.Data; import org.apache.commons.lang3.StringUtils; import org.springframework.http.HttpHeaders; import org.springframework.stereotype.Component; import javax.annotation.PreDestroy; import javax.servlet.ServletOutputStream; import javax.servlet.http.HttpServletResponse; import java.io.*; import java.net.URLEncoder; import java.nio.charset.StandardCharsets; import java.util.*; /** * <p>JSch工具類</p> * <li>交給spring管理:每個使用的地方都是單例,都是單獨(dú)的這個類。(new 也可以)</li> * * <li>所有方法都沒有關(guān)閉(連接、會話),需要使用方自己關(guān)閉</li> * * @author CC * @since 2023/11/8 */ @Data @Component public class JSchUtil { //緩存session會話 private Session session; //通道:執(zhí)行命令 private ChannelExec channelExec; //通道:SFTP private ChannelSftp channelSftp; //通道:執(zhí)行復(fù)雜Shell命令 private ChannelShell channelShell; //登陸Linux服務(wù)器 public void loginLinux(String username, String password, String host, Integer port) { try { //每次都會重新初始化session if (Objects.isNull(session) || !session.isConnected()) { JSch jsch = new JSch(); session = jsch.getSession(username, host, port); session.setPassword(password); // 配置Session參數(shù) Properties config = new Properties(); // 不進(jìn)行公鑰的檢查 config.put("StrictHostKeyChecking", "no"); session.setConfig(config); // 設(shè)置連接超時時間(s/秒) session.setTimeout(300); } if (!session.isConnected()) { // 連接到遠(yuǎn)程服務(wù)器 session.connect(); } }catch(Exception e){ throw new RuntimeException("連接Linux失?。? + e.getMessage()); } } //執(zhí)行命令:可以多次執(zhí)行,然后必須調(diào)用關(guān)閉接口 public String executeCommand(String command) { StringBuilder result = new StringBuilder(); BufferedReader buf = null; try { //每次執(zhí)行都創(chuàng)建新的通道 channelExec = (ChannelExec) session.openChannel("exec"); channelExec.setCommand(command); //正確的流中沒有數(shù)據(jù)就走錯誤流中去拿。 InputStream in = channelExec.getInputStream(); InputStream errStream = channelExec.getErrStream(); channelExec.connect(); buf = new BufferedReader(new InputStreamReader(in)); String msg; while ((msg = buf.readLine()) != null) { result.append(msg); } if (StringUtils.isBlank(result.toString())) { buf = new BufferedReader(new InputStreamReader(errStream)); String msgErr; while ((msgErr = buf.readLine()) != null) { result.append(msgErr); } } }catch(Exception e){ throw new RuntimeException("關(guān)閉連接失?。▓?zhí)行命令):" + e.getMessage()); }finally { if (Objects.nonNull(buf)) { try { buf.close(); }catch(Exception e){ e.printStackTrace(); } } } return result.toString(); } /** * 執(zhí)行復(fù)雜shell命令 * * @param cmds 多條命令 * @return 執(zhí)行結(jié)果 * @throws Exception 連接異常 */ public String execCmdByShell(List<String> cmds) { String result = ""; try { channelShell = (ChannelShell) session.openChannel("shell"); InputStream inputStream = channelShell.getInputStream(); channelShell.setPty(true); channelShell.connect(); OutputStream outputStream = channelShell.getOutputStream(); PrintWriter printWriter = new PrintWriter(outputStream); for (String cmd : cmds) { printWriter.println(cmd); } printWriter.flush(); byte[] tmp = new byte[1024]; while (true) { while (inputStream.available() > 0) { int i = inputStream.read(tmp, 0, 1024); if (i < 0) { break; } String s = new String(tmp, 0, i); if (s.contains("--More--")) { outputStream.write((" ").getBytes()); outputStream.flush(); } System.out.println(s); } if (channelShell.isClosed()) { System.out.println("exit-status:" + channelShell.getExitStatus()); break; } //間隔1s后再執(zhí)行 try { Thread.sleep(1000); } catch (Exception e) { e.printStackTrace(); } } outputStream.close(); inputStream.close(); }catch(Exception e){ e.printStackTrace(); } return result; } //下載除了云服務(wù)器的文件(你自己的服務(wù)器):因?yàn)樵品?wù)器,像阿里云服務(wù)器下載文件好像是一段一段給你的,不是一起給你。 public void downloadOtherFile(String remoteFileAbsolutePath, String fileName, HttpServletResponse response) { try { channelSftp = (ChannelSftp) session.openChannel("sftp"); channelSftp.connect(); //獲取輸入流 InputStream inputStream = channelSftp.get(remoteFileAbsolutePath); //直接下載到本地文件 // channelSftp.get(remoteFileAbsolutePath, "D:\\Develop\\Test\\studio-3t-x64.zip"); response.setCharacterEncoding(StandardCharsets.UTF_8.name()); response.setContentType("application/octet-stream;charset=".concat(StandardCharsets.UTF_8.name())); response.setHeader(HttpHeaders.ACCESS_CONTROL_EXPOSE_HEADERS, HttpHeaders.CONTENT_DISPOSITION); response.setHeader(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=".concat( URLEncoder.encode(fileName, StandardCharsets.UTF_8.name()) )); ServletOutputStream out = response.getOutputStream(); // 從InputStream輸入流讀取數(shù)據(jù) 并寫入到ServletOutputStream輸出流 byte[] buffer = new byte[4096]; int bytesRead; while ((bytesRead = inputStream.read(buffer)) != -1) { out.write(buffer, 0, bytesRead); } out.flush(); out.close(); }catch(Exception e){ throw new RuntimeException("關(guān)閉連接失敗(下載文件):" + e.getMessage()); } } //下載云服務(wù)器的文件(因?yàn)樵品?wù)器傳文件是一段一段的,所以不能直接像操作我們的服務(wù)器一樣直接下載)(阿里云為例) public void downloadCloudServerFile(String remoteFileAbsolutePath, String fileName, HttpServletResponse response) { try { channelSftp = (ChannelSftp) session.openChannel("sftp"); channelSftp.connect(); //獲取輸入流 InputStream inputStream = channelSftp.get(remoteFileAbsolutePath); //阿里云應(yīng)該是斷點(diǎn)續(xù)傳,后面研究…… }catch(Exception e){ throw new RuntimeException("關(guān)閉連接失?。ㄏ螺d文件):" + e.getMessage()); } } //ls命令:獲取文件夾的信息 public String ls(String path){ StringBuilder sb = new StringBuilder(); try { channelSftp = (ChannelSftp) session.openChannel("sftp"); channelSftp.connect(); Vector ls = channelSftp.ls(path); Iterator iterator = ls.iterator(); while (iterator.hasNext()) { Object next = iterator.next(); System.out.println(next); sb.append(next); } } catch (Exception e){ throw new RuntimeException(e.getMessage()); } return sb.toString(); } //關(guān)閉通道:釋放資源 private void closeChannel(){ //不為空,且已經(jīng)連接:關(guān)閉 if (Objects.nonNull(channelExec)) { channelExec.disconnect(); } if (Objects.nonNull(channelSftp)) { channelSftp.disconnect(); } if (Objects.nonNull(channelShell)) { channelShell.disconnect(); } } /** 關(guān)閉通道、關(guān)閉會話:釋放資源 * spring銷毀前,關(guān)閉 所有會話 及 所有通道 */ @PreDestroy public void closeAll(){ System.out.println("我被銷毀了。。。。。。。。。。。。。。。。。。。。。。"); this.closeChannel(); if (Objects.nonNull(session) && session.isConnected()) { session.disconnect(); } } }
4.2、使用Jsch工具類:執(zhí)行命令
4.2.1、執(zhí)行簡單命令
package com.cc.jschdemo.web.controller; import com.cc.jschdemo.utils.JSchUtil; import com.jcraft.jsch.ChannelExec; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; import javax.annotation.Resource; import java.io.InputStream; import java.util.Arrays; /** * <p></p> * * @author CC * @since 2023/11/8 */ @RestController @RequestMapping("/jsch") public class JSchController { @Resource private JSchUtil jSchUtil; /** <p>執(zhí)行命令<p> **/ @GetMapping public String executeCommand() { //登陸(默認(rèn)只連接5分鐘,5分鐘后銷毀) jSchUtil.loginLinux("服務(wù)器賬號", "服務(wù)器密碼", "服務(wù)器IP", 服務(wù)器端口); //一、執(zhí)行命令 String mkdir = jSchUtil.executeCommand("mkdir ccc"); String docker = jSchUtil.executeCommand("docker"); String dockerPs = jSchUtil.executeCommand("docker ps"); System.out.println(mkdir); System.out.println(docker); System.out.println(dockerPs); //執(zhí)行完,關(guān)閉連接 jSchUtil.closeAll(); return docker; } }
結(jié)果:多了一個文件夾
4.2.2、執(zhí)行復(fù)雜的shell命令
/** <p>執(zhí)行命令<p> **/ @PostMapping public String execCmdByShell() { //登陸(默認(rèn)只連接5分鐘,5分鐘后銷毀) jSchUtil.loginLinux("服務(wù)器賬號", "服務(wù)器密碼", "服務(wù)器IP", 服務(wù)器端口); //二、執(zhí)行shell腳本(可以改造成傳入的shell腳步) jSchUtil.execCmdByShell(Arrays.asList("cd /", "ll" , "cd cc/", "mkdir ccccc222", "ll")); //執(zhí)行完,關(guān)閉連接 jSchUtil.closeAll(); return "docker"; }
結(jié)果
4.3、使用Jsch工具類:下載文件
4.3.1、普通服務(wù)器下載
//下載普通服務(wù)器的文件 @PutMapping public void downloadOtherFile(HttpServletResponse response) { //登陸(默認(rèn)只連接5分鐘,5分鐘后銷毀) jSchUtil.loginLinux("服務(wù)器賬號", "服務(wù)器密碼", "服務(wù)器IP", 服務(wù)器端口); //下載文件 jSchUtil.downloadOtherFile( "/dev/libbb/studio-3t-x64.zip", "studio-3t-x64.zip", response ); //執(zhí)行完,關(guān)閉連接 jSchUtil.closeAll(); }
4.3.2、阿里云服務(wù)器下載
http://www.dbjr.com.cn/article/178581.htm
五、Hutool工具封裝的JSch(推薦)
Hutool使用的是JSch連接池,推薦使用……
六、總結(jié)
參考:
http://www.dbjr.com.cn/article/264152.htm
http://www.dbjr.com.cn/article/264148.htm
到此這篇關(guān)于SpringBoot使用JSch操作Linux的文章就介紹到這了,更多相關(guān)SpringBoot使用JSch內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
一文搞懂Spring中@Autowired和@Resource的區(qū)別
@Autowired?和?@Resource?都是?Spring/Spring?Boot?項(xiàng)目中,用來進(jìn)行依賴注入的注解。它們都提供了將依賴對象注入到當(dāng)前對象的功能,但二者卻有眾多不同,并且這也是常見的面試題之一,所以我們今天就來盤它2022-08-08Java Lambda表達(dá)式和函數(shù)式接口實(shí)例分析
這篇文章主要介紹了Java Lambda表達(dá)式和函數(shù)式接口,結(jié)合實(shí)例形式分析了Java8 Lambda表達(dá)式和函數(shù)式接口相關(guān)原理、用法及操作注意事項(xiàng),需要的朋友可以參考下2019-09-09java根據(jù)開始時間結(jié)束時間計算中間間隔日期的實(shí)例代碼
這篇文章主要介紹了java根據(jù)開始時間結(jié)束時間計算中間間隔日期的實(shí)例代碼,需要的朋友可以參考下2019-05-05springboot2.0和springcloud Finchley版項(xiàng)目搭建(包含eureka,gateWay,F(xiàn)re
這篇文章主要介紹了springboot2.0和springcloud Finchley版項(xiàng)目搭建(包含eureka,gateWay,F(xiàn)reign,Hystrix),小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2019-05-05SpringBoot生成jar/war包的布局應(yīng)用
在 Spring Boot 中,"布局應(yīng)用"(Application Layout)指的是打包生成的可執(zhí)行 jar 或 war 文件中的內(nèi)容組織結(jié)構(gòu),本文給大家介紹了SpringBoot生成jar/war包的布局應(yīng)用,需要的朋友可以參考下2024-02-02攜程Apollo(阿波羅)安裝部署以及java整合實(shí)現(xiàn)
這篇文章主要介紹了攜程Apollo(阿波羅)安裝部署以及java整合實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-08-08SpringMVC Restful api接口實(shí)現(xiàn)的代碼
本篇文章主要介紹了SpringMVC Restful api接口實(shí)現(xiàn)的代碼,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-09-09