SpringBoot使用JSch操作Linux

• 推荐使用Hutool的Jsch工具包（它用的连接池的技术）
  

一、SSH远程连接服务器

• SSH更多见：http://t.csdnimg.cn/PrsNv
  
• 推荐连接工具：FinalShell、Xshell、secureCRT、PuTTY
  （https://zhuanlan.zhihu.com/p/659276574）
  

1、SSH（Secure Shell）主要有两大功能

1、远程命令执行：SSH允许用户在远程主机上执行命令。用户可以通过SSH连接到远程主机，然后在命令行界面输入命令，就像直接在远程主机的控制台上操作一样。这是SSH最常用的功能，它使得用户可以方便地管理和维护远程主机。
2、安全的文件传输：SSH提供了SFTP（SSH File Transfer Protocol）和SCP（Secure Copy）两种文件传输协议，用于在本地主机和远程主机之间安全地传输文件。这两种协议都使用SSH的安全机制，可以保护文件在传输过程中的安全性和完整性。
3、除了这两大功能，SSH还有一些其他的功能，例如端口转发和动态端口转发（也称为SOCKS代理），它们可以用来建立安全的网络连接，或者绕过网络限制。
二、JNA、Process和JSch

• JNA
  

JNA主要用于在Java程序中调用本地库的函数，而不是用于远程连接到其他系统。如果你的Java程序正在Linux系统上运行，你可以使用JNA来调用Linux的本地库函数，包括那些可以获取文件和文件夹路径的函数。然而，如果你的Java程序正在一个系统（如Windows）上运行，你不能使用JNA来连接到另一个系统（如Linux）。

• JSch
  

如果你需要从一个运行在Windows上的Java程序连接到一个Linux系统，你可能需要使用其他的工具或库。例如，你可以使用SSH（安全壳层）来远程连接到Linux系统，然后执行命令来获取文件和文件夹的路径。在Java中，有一些库可以帮助你使用SSH，如JSch和Apache MINA SSHD。
简单理解JNA、Process和JSch

• JNA（Java Native Access）和Process类都是Java中与本地系统交互的工具。JNA允许Java代码直接调用本地（C/C++）库的函数，而Process类则允许Java代码启动和控制操作系统的进程，例如执行shell命令。(JNA和Process是Java调用系统（Windows、Linux等）的本地函数，或者三方程序)
  
• JSch是一个Java库，它提供了SSH（Secure Shell）的Java实现，允许Java程序通过SSH协议连接到远程系统（如Linux）。一旦连接成功，你可以通过JSch执行远程命令，上传和下载文件，就像直接在远程系统上操作一样。(JSch则是Java连接系统（Windows、Linux等）的工具，比如连接上Linux后，相当于直接操作Linux一样)
  

三、Java使用SSH的包

3.1、JSch和Apache MINA SSHD

JSch和Apache MINA SSHD都是优秀的SSH库，它们各有优点，选择哪一个主要取决于你的具体需求。
JSch是一个成熟且广泛使用的库，它提供了SSH2的完整实现，包括SFTP，SCP，端口转发等功能。JSch的API相对简单，易于使用，而且JSch的社区活跃，有大量的教程和示例代码可供参考。
Apache MINA SSHD则是一个更现代的库，它基于Apache MINA，一个高性能的网络应用框架。MINA SSHD提供了SSH2的完整实现，包括SFTP，SCP，端口转发等功能。MINA SSHD的API设计更现代，更符合Java的编程习惯，而且MINA SSHD支持异步非阻塞IO，对于需要处理大量并发连接的应用来说，可能会有更好的性能。
总的来说，如果你需要一个简单易用，社区支持好的SSH库，JSch可能是一个不错的选择。如果你需要一个设计现代，支持异步非阻塞IO的SSH库，或者你已经在使用Apache MINA，那么MINA SSHD可能更适合你。
3.2、JSch的四种认证机制：

• 密码（本文使用）：这是最常见的身份验证方式，用户需要提供用户名和密码来进行身份验证。
  
• 公钥：在这种方式中，用户需要提供一个私钥，JSch会使用这个私钥来进行身份验证。这种方式通常比基于密码的身份验证更安全，因为私钥通常比密码更难被猜测或者破解。
  
• 键盘交互：这种方式允许服务器发送一个或多个提问给客户端，客户端需要回答这些问题来进行身份验证。这种方式可以用来实现一些复杂的身份验证流程，例如一次性密码，或者多因素身份验证。
  
• GSSAPI：GSSAPI是一种用于安全通信的API，它支持各种不同的身份验证机制，例如Kerberos。JSch可以使用GSSAPI来进行身份验证，但这需要额外的库支持。
  

四、JSch实现登录Linux，远程命令执行、SFTP下载和上传文件

4.1、导包Jsch

• 官方的包上次更新18年（本文使用）
  

1.     // jsch包
2.     implementation 'com.jcraft:jsch:0.1.55'

复制代码

• 长期维护的jsch：https://github.com/mwiede/jsch
  

4.2、Jsch工具类

1. package com.cc.jschdemo.utils;
3. import com.jcraft.jsch.*;
4. import lombok.Data;
5. import org.apache.commons.lang3.StringUtils;
6. import org.springframework.http.HttpHeaders;
7. import org.springframework.stereotype.Component;
9. import javax.annotation.PreDestroy;
10. import javax.servlet.ServletOutputStream;
11. import javax.servlet.http.HttpServletResponse;
12. import java.io.*;
13. import java.net.URLEncoder;
14. import java.nio.charset.StandardCharsets;
15. import java.util.*;
17. /**
18. * <p>JSch工具类</p>
19. * <li>交给spring管理：每个使用的地方都是单例，都是单独的这个类。（new 也可以）</li>
20. *
21. * <li>所有方法都没有关闭（连接、会话），需要使用方自己关闭</li>
22. *
23. * @author CC
24. * @since 2023/11/8
25. */
26. @Data
27. @Component
28. public class JSchUtil {
30.     //缓存session会话
31.     private Session session;
33.     //通道：执行命令
34.     private ChannelExec channelExec;
35.     //通道：SFTP
36.     private ChannelSftp channelSftp;
37.     //通道：执行复杂Shell命令
38.     private ChannelShell channelShell;
41.     //登陆Linux服务器
42.     public void loginLinux(String username, String password, String host, Integer port) {
43.         try {
44.             //每次都会重新初始化session
45.             if (Objects.isNull(session) || !session.isConnected()) {
46.                 JSch jsch = new JSch();
47.                 session = jsch.getSession(username, host, port);
48.                 session.setPassword(password);
50.                 // 配置Session参数
51.                 Properties config = new Properties();
52.                 // 不进行公钥的检查
53.                 config.put("StrictHostKeyChecking", "no");
54.                 session.setConfig(config);
55.                 // 设置连接超时时间（s/秒）
56.                 session.setTimeout(300);
57.             }
58.             if (!session.isConnected()) {
59.                 // 连接到远程服务器
60.                 session.connect();
61.             }
62.         }catch(Exception e){
63.             throw new RuntimeException("连接Linux失败：" + e.getMessage());
64.         }
65.     }
67.     //执行命令：可以多次执行，然后必须调用关闭接口
68.     public String executeCommand(String command) {
69.         StringBuilder result = new StringBuilder();
70.         BufferedReader buf = null;
71.         try {
72.             //每次执行都创建新的通道
73.             channelExec = (ChannelExec) session.openChannel("exec");
74.             channelExec.setCommand(command);
76.             //正确的流中没有数据就走错误流中去拿。
77.             InputStream in = channelExec.getInputStream();
78.             InputStream errStream = channelExec.getErrStream();
79.             channelExec.connect();
81.             buf = new BufferedReader(new InputStreamReader(in));
82.             String msg;
83.             while ((msg = buf.readLine()) != null) {
84.                 result.append(msg);
85.             }
87.             if (StringUtils.isBlank(result.toString())) {
88.                 buf = new BufferedReader(new InputStreamReader(errStream));
89.                 String msgErr;
90.                 while ((msgErr = buf.readLine()) != null) {
91.                     result.append(msgErr);
92.                 }
93.             }
94.         }catch(Exception e){
95.             throw new RuntimeException("关闭连接失败（执行命令）：" + e.getMessage());
96.         }finally {
97.             if (Objects.nonNull(buf)) {
98.                 try {
99.                     buf.close();
100.                 }catch(Exception e){
101.                     e.printStackTrace();
102.                 }
103.             }
104.         }
105.         return result.toString();
106.     }
108.     /**
109.      * 执行复杂shell命令
110.      *
111.      * @param cmds 多条命令
112.      * @return 执行结果
113.      * @throws Exception 连接异常
114.      */
115.     public String execCmdByShell(List<String> cmds) {
117.         String result = "";
118.         try {
119.             channelShell = (ChannelShell) session.openChannel("shell");
121.             InputStream inputStream = channelShell.getInputStream();
122.             channelShell.setPty(true);
123.             channelShell.connect();
124.             OutputStream outputStream = channelShell.getOutputStream();
125.             PrintWriter printWriter = new PrintWriter(outputStream);
126.             for (String cmd : cmds) {
127.                 printWriter.println(cmd);
128.             }
129.             printWriter.flush();
130.             byte[] tmp = new byte[1024];
131.             while (true) {
132.                 while (inputStream.available() > 0) {
133.                     int i = inputStream.read(tmp, 0, 1024);
134.                     if (i < 0) {
135.                         break;
136.                     }
137.                     String s = new String(tmp, 0, i);
138.                     if (s.contains("--More--")) {
139.                         outputStream.write((" ").getBytes());
140.                         outputStream.flush();
141.                     }
142.                     System.out.println(s);
143.                 }
144.                 if (channelShell.isClosed()) {
145.                     System.out.println("exit-status:" + channelShell.getExitStatus());
146.                     break;
147.                 }
148.                 //间隔1s后再执行
149.                 try {
150.                     Thread.sleep(1000);
151.                 } catch (Exception e) {
152.                     e.printStackTrace();
153.                 }
154.             }
155.             outputStream.close();
156.             inputStream.close();
157.         }catch(Exception e){
158.             e.printStackTrace();
159.         }
161.         return result;
162.     }
164.     //下载除了云服务器的文件（你自己的服务器）：因为云服务器，像阿里云服务器下载文件好像是一段一段给你的，不是一起给你。
165.     public void downloadOtherFile(String remoteFileAbsolutePath, String fileName, HttpServletResponse response) {
166.         try {
167.             channelSftp = (ChannelSftp) session.openChannel("sftp");
168.             channelSftp.connect();
170.             //获取输入流
171.             InputStream inputStream = channelSftp.get(remoteFileAbsolutePath);
172.             //直接下载到本地文件
173. //            channelSftp.get(remoteFileAbsolutePath, "D:\\Develop\\Test\\studio-3t-x64.zip");
175.             response.setCharacterEncoding(StandardCharsets.UTF_8.name());
176.             response.setContentType("application/octet-stream;charset=".concat(StandardCharsets.UTF_8.name()));
177.             response.setHeader(HttpHeaders.ACCESS_CONTROL_EXPOSE_HEADERS, HttpHeaders.CONTENT_DISPOSITION);
178.             response.setHeader(HttpHeaders.CONTENT_DISPOSITION,
179.                     "attachment; filename=".concat(
180.                             URLEncoder.encode(fileName, StandardCharsets.UTF_8.name())
181.                     ));
182.             ServletOutputStream out = response.getOutputStream();
184.             // 从InputStream输入流读取数据 并写入到ServletOutputStream输出流
185.             byte[] buffer = new byte[4096];
186.             int bytesRead;
187.             while ((bytesRead = inputStream.read(buffer)) != -1) {
188.                 out.write(buffer, 0, bytesRead);
189.             }
190.             out.flush();
191.             out.close();
192.         }catch(Exception e){
193.             throw new RuntimeException("关闭连接失败（下载文件）：" + e.getMessage());
194.         }
195.     }
197.     //下载云服务器的文件（因为云服务器传文件是一段一段的，所以不能直接像操作我们的服务器一样直接下载）（阿里云为例）
198.     public void downloadCloudServerFile(String remoteFileAbsolutePath, String fileName, HttpServletResponse response) {
199.         try {
200.             channelSftp = (ChannelSftp) session.openChannel("sftp");
201.             channelSftp.connect();
203.             //获取输入流
204.             InputStream inputStream = channelSftp.get(remoteFileAbsolutePath);
206.             //阿里云应该是断点续传，后面研究……
208.         }catch(Exception e){
209.             throw new RuntimeException("关闭连接失败（下载文件）：" + e.getMessage());
210.         }
211.     }
213.     //ls命令：获取文件夹的信息
214.     public String ls(String path){
215.         StringBuilder sb = new StringBuilder();
216.         try {
217.             channelSftp = (ChannelSftp) session.openChannel("sftp");
218.             channelSftp.connect();
220.             Vector ls = channelSftp.ls(path);
221.             Iterator iterator = ls.iterator();
222.             while (iterator.hasNext()) {
223.                 Object next = iterator.next();
224.                 System.out.println(next);
225.                 sb.append(next);
226.             }
227.         } catch (Exception e){
228.             throw new RuntimeException(e.getMessage());
229.         }
230.         return sb.toString();
231.     }
233.     //关闭通道：释放资源
234.     private void closeChannel(){
235.         //不为空，且已经连接：关闭
236.         if (Objects.nonNull(channelExec)) {
237.             channelExec.disconnect();
238.         }
239.         if (Objects.nonNull(channelSftp)) {
240.             channelSftp.disconnect();
241.         }
242.         if (Objects.nonNull(channelShell)) {
243.             channelShell.disconnect();
244.         }
245.     }
247.     /** 关闭通道、关闭会话：释放资源
248.      * spring销毁前，关闭 所有会话 及 所有通道
249.      */
250.     @PreDestroy
251.     public void closeAll(){
252.         System.out.println("我被销毁了。。。。。。。。。。。。。。。。。。。。。。");
254.         this.closeChannel();
256.         if (Objects.nonNull(session) && session.isConnected()) {
257.             session.disconnect();
258.         }
259.     }
261. }

复制代码

4.2、使用Jsch工具类：执行命令

4.2.1、执行简单命令

1. package com.cc.jschdemo.web.controller;
3. import com.cc.jschdemo.utils.JSchUtil;
4. import com.jcraft.jsch.ChannelExec;
5. import org.springframework.web.bind.annotation.GetMapping;
6. import org.springframework.web.bind.annotation.RequestMapping;
7. import org.springframework.web.bind.annotation.RequestParam;
8. import org.springframework.web.bind.annotation.RestController;
10. import javax.annotation.Resource;
11. import java.io.InputStream;
12. import java.util.Arrays;
14. /**
15. * <p></p>
16. *
17. * @author CC
18. * @since 2023/11/8
19. */
20. @RestController
21. @RequestMapping("/jsch")
22. public class JSchController {
24.     @Resource
25.     private JSchUtil jSchUtil;
27.     /** <p>执行命令<p>
28.      **/
29.     @GetMapping
30.     public String executeCommand() {
31.         //登陆（默认只连接5分钟，5分钟后销毁）
32.         jSchUtil.loginLinux("服务器账号", "服务器密码", "服务器IP", 服务器端口);
33.         //一、执行命令
34.         String mkdir = jSchUtil.executeCommand("mkdir ccc");
35.         String docker = jSchUtil.executeCommand("docker");
36.         String dockerPs = jSchUtil.executeCommand("docker ps");
38.         System.out.println(mkdir);
39.         System.out.println(docker);
40.         System.out.println(dockerPs);
42.         //执行完，关闭连接
43.         jSchUtil.closeAll();
45.         return docker;
46.     }
47. }

复制代码

• 结果：
  
• 多了一个文件夹
  
  

4.2.1、执行复杂的shell命令

1.    /** <p>执行命令<p>
2.      **/
3.     @PostMapping
4.     public String execCmdByShell() {
5.         //登陆（默认只连接5分钟，5分钟后销毁）
6.         jSchUtil.loginLinux("服务器账号", "服务器密码", "服务器IP", 服务器端口);
7.         //二、执行shell脚本（可以改造成传入的shell脚步）
8.         jSchUtil.execCmdByShell(Arrays.asList("cd /", "ll" , "cd cc/", "mkdir ccccc222", "ll"));
9.         //执行完，关闭连接
10.         jSchUtil.closeAll();
12.         return "docker";
13.     }

复制代码

• 结果
  

4.3、使用Jsch工具类：下载文件

4.3.1、普通服务器下载

1.     //下载普通服务器的文件
2.     @PutMapping
3.     public void downloadOtherFile(HttpServletResponse response) {
4.         //登陆（默认只连接5分钟，5分钟后销毁）
5.         jSchUtil.loginLinux("root", "pwd@20180808", "172.16.0.16", 22);
6.         //下载文件
7.         jSchUtil.downloadOtherFile(
8.                 "/dev/libbb/studio-3t-x64.zip",
9.                 "studio-3t-x64.zip",
10.                 response
11.         );
12.         //执行完，关闭连接
13.         jSchUtil.closeAll();
14.     }

复制代码

4.3.2、阿里云服务器下载

• 博主很懒，没留下什么……
  

五、Hutool工具封装的JSch（推荐）

• Hutool使用的是JSch连接池，推荐使用……
  
• 博主比较懒，还没实现……
  

六、总结

参考：
https://www.jb51.net/article/264152.htm
https://www.jb51.net/article/264148.htm

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！