SpringBoot使用JSch操作Linux的方法
更新時間：2023年11月29日 14:36:00 作者：C_C_菜園
JSch是一個Java庫，它提供了SSH（Secure?Shell）的Java實現(xiàn)，允許Java程序通過SSH協(xié)議連接到遠(yuǎn)程系統(tǒng)（如Linux），這篇文章主要介紹了SpringBoot使用JSch操作Linux,需要的朋友可以參考下
推薦使用Hutool的Jsch工具包（它用的連接池的技術(shù)）
一、SSH遠(yuǎn)程連接服務(wù)器
SSH更多見：http://t.csdnimg.cn/PrsNv
推薦連接工具：FinalShell、Xshell、secureCRT、PuTTY
（http://m.fzitv.net/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實現(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)點，選擇哪一個主要取決于你的具體需求。
JSch是一個成熟且廣泛使用的庫，它提供了SSH2的完整實現(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的完整實現(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ī)制：
- 密碼（本文使用）：這是最常見的身份驗證方式，用戶需要提供用戶名和密碼來進(jìn)行身份驗證。
- 公鑰：在這種方式中，用戶需要提供一個私鑰，JSch會使用這個私鑰來進(jìn)行身份驗證。這種方式通常比基于密碼的身份驗證更安全，因為私鑰通常比密碼更難被猜測或者破解。
- 鍵盤交互：這種方式允許服務(wù)器發(fā)送一個或多個提問給客戶端，客戶端需要回答這些問題來進(jìn)行身份驗證。這種方式可以用來實現(xiàn)一些復(fù)雜的身份驗證流程，例如一次性密碼，或者多因素身份驗證。
- GSSAPI：GSSAPI是一種用于安全通信的API，它支持各種不同的身份驗證機(jī)制，例如Kerberos。JSch可以使用GSSAPI來進(jìn)行身份驗證，但這需要額外的庫支持。
四、JSch實現(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管理：每個使用的地方都是單例，都是單獨的這個類。（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ù)器）：因為云服務(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ù)器的文件（因為云服務(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)該是斷點續(xù)傳，后面研究……
}catch(Exception e){
throw new RuntimeException("關(guān)閉連接失敗（下載文件）：" + 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://m.fzitv.net/article/178581.htm
五、Hutool工具封裝的JSch（推薦）
Hutool使用的是JSch連接池，推薦使用……
六、總結(jié)
參考：
http://m.fzitv.net/article/264152.htm
http://m.fzitv.net/article/264148.htm
到此這篇關(guān)于SpringBoot使用JSch操作Linux的文章就介紹到這了,更多相關(guān)SpringBoot使用JSch內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
在本篇文章里小編給大家整理的是關(guān)于java中獲取類資源的方法總結(jié)，需要的朋友們可以學(xué)習(xí)參考下。2020-02-02
本文介紹了SpringBoot項目創(chuàng)建的五種主流方式,包括IDEA+Spring官方腳手架、Spring官網(wǎng)下載壓縮包、IDEA+阿里云腳手架、阿里云官網(wǎng)下載壓縮包和普通MavenJava項目改造為SpringBoot項目,每種方式都有其適用場景、操作步驟、優(yōu)點和缺點,并總結(jié)了五種方式的對比2026-01-01
方法引用可以認(rèn)為是Lambda表達(dá)式的一種特殊形式，Lambda表達(dá)式可以讓開發(fā)者自定義抽象方法的實現(xiàn)代碼，方法引用則可以讓開發(fā)者直接引用已存在的實現(xiàn)方法，作為Lambda表達(dá)式的Lambda體(參數(shù)列表得一致),需要的朋友可以參考下2023-05-05
tomcat報錯：Wrapper cannot find servlet class ...問題解決
這篇文章主要介紹了tomcat報錯：Wrapper cannot find servlet class ...問題解決的相關(guān)資料,需要的朋友可以參考下2016-11-11
本篇文章主要介紹了Java代碼性能優(yōu)化的35個方法，具有很好的參考價值，下面跟著小編一起來看下吧2017-02-02
Spring提供了兩種方式實現(xiàn)定時任務(wù),一種是注解,還有一種就是接口了,這篇文章主要為大家介紹了這兩種方法的具體實現(xiàn)方法,需要的可以參考下2024-12-12
Word中的替換功能以查找指定文本然后替換為新的文本，可單個替換或全部替換。本文將用Java語言實現(xiàn)Word中的文本、圖片替換功能，需要的可以參考一下2022-06-06
Java數(shù)據(jù)結(jié)構(gòu)之雙向鏈表圖解
這篇文章主要為大家詳細(xì)介紹了Java數(shù)據(jù)結(jié)構(gòu)之雙向鏈表，文中圖解分析的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-05-05
Spring Boot 和 Spring 到底有啥區(qū)別你知道嗎
Spring Boot框架的核心就是自動配置，只要存在相應(yīng)的jar包，Spring就幫我們自動配置。接下來通過本文給大家介紹Spring與Spring boot的區(qū)別介紹，非常不錯，需要的朋友參考下吧2021-08-08
springboot項目中讀取.env文件參數(shù)值的兩種主流實現(xiàn)方式
在Spring Boot項目中,.env文件并非Spring Boot原生支持的配置格式,但可以通過第三方庫或自定義讀取邏輯來加載.env文件中的參數(shù),下面我們就來看看具體實現(xiàn)方法吧2025-12-12