云计算、AI、云原生、大数据等一站式技术学习平台

网站首页 > 教程文章 正文

如何在Spring Boot中连接SSH请求?

jxf315 2025-03-28 17:51:34 教程文章 18 ℃

SSH是一种远程的网络通信协议,主要的作用就是通过一种不安全的方式链接到远程的计算机上对远程机器进行操作,这里所谓的不安全是指这种方式很容易就被攻击了,所以一般不建议非安全网络环境来通过SSH进行服务器的连接操作。但是在正常的服务管理的场景中,我们都是通过SSH协议进行连接的,下面我们就来看看如何在Spring Boot中来实现SSH来实现与远程服务的交互。

引入相关依赖

老生常谈,第一步就是在SpringBoot项目中引入SSH链接所需要的连接配置,这里我们使用的是JSch(Java Secure Channel),它是一个轻量级的Java链接库,可以用来执行SSH连接、命令执行、文件上传/下载等操作,当然我们还可以通过其他的方式来进行连接。


    
    
        org.springframework.boot
        spring-boot-starter-web
    

    
    
        com.jcraft
        jsch
        0.1.55
    

创建SSH连接工具类

依赖配置完成之后,为了能够复用链接,我们可以将对SSH的操作封装到一个工具类中,这样我们就可以对相关链接操作进行复用。如下所示,我们创建一个SSHUtils类。

import com.jcraft.jsch.*;

import java.io.InputStream;
import java.util.Properties;

public class SSHUtils {

    private String host;
    private String user;
    private String password;
    private int port = 22;  // 默认SSH端口

    // 构造方法,初始化连接信息
    public SSHUtils(String host, String user, String password) {
        this.host = host;
        this.user = user;
        this.password = password;
    }

    // 创建并返回SSH会话
    private Session getSession() throws JSchException {
        JSch jsch = new JSch();
        Session session = jsch.getSession(user, host, port);
        session.setPassword(password);

        // 设置为不检查主机密钥
        session.setConfig("StrictHostKeyChecking", "no");

        // 建立连接
        session.connect();
        return session;
    }

    // 执行SSH命令
    public String executeCommand(String command) throws JSchException, Exception {
        Session session = getSession();
        Channel channel = session.openChannel("exec");
        ((ChannelExec) channel).setCommand(command);
        channel.setInputStream(null);

        // 获取执行结果
        InputStream in = channel.getInputStream();
        channel.connect();

        StringBuilder output = new StringBuilder();
        byte[] buffer = new byte[1024];
        while (true) {
            while (in.available() > 0) {
                int i = in.read(buffer, 0, 1024);
                if (i < 0) break;
                output.append(new String(buffer, 0, i));
            }
            if (channel.isClosed()) {
                break;
            }
            Thread.sleep(100);
        }
        channel.disconnect();
        session.disconnect();
        return output.toString();
    }

    // 获取SSH会话状态
    public boolean isConnected(Session session) {
        return session.isConnected();
    }
}

使用SSH连接工具

完成之后,可以在服务层中通过SSHUtils类来连接远程服务器并执行相关命令,如下所示,我们可以创建一个服务来调用SSHUtils,通过SSH连接到远程机器执行命令。

import org.springframework.stereotype.Service;

@Service
public class SSHService {

    private final String host = "your-remote-server.com";  // 远程主机
    private final String user = "your-username";            // 用户名
    private final String password = "your-password";        // 密码

    private final SSHUtils sshUtils;

    public SSHService() {
        sshUtils = new SSHUtils(host, user, password);
    }

    public String executeRemoteCommand(String command) {
        try {
            return sshUtils.executeCommand(command);
        } catch (Exception e) {
            e.printStackTrace();
            return "Error executing SSH command: " + e.getMessage();
        }
    }
}

接下来就是在Controller中来调用这个服务来实现远程服务器的连接以及命令的执行操作。

@RestController
public class SSHController {

    @Autowired
    private SSHService sshService;

    @GetMapping("/execute")
    public String executeCommand(@RequestParam String command) {
        return sshService.executeRemoteCommand(command);
    }
}

高级用法:上传和下载文件

当然除了简单的执行命令的操作,我们还可以通过JSch来实现文件的上传下载操作,如下所示。

文件上传

public void uploadFile(String localFile, String remoteFile) throws JSchException, SftpException {
    Session session = getSession();
    Channel channel = session.openChannel("sftp");
    channel.connect();
    ChannelSftp sftpChannel = (ChannelSftp) channel;

    sftpChannel.put(localFile, remoteFile);  // 上传文件
    sftpChannel.exit();
    session.disconnect();
}

文件下载

public void downloadFile(String remoteFile, String localFile) throws JSchException, SftpException {
    Session session = getSession();
    Channel channel = session.openChannel("sftp");
    channel.connect();
    ChannelSftp sftpChannel = (ChannelSftp) channel;

    sftpChannel.get(remoteFile, localFile);  // 下载文件
    sftpChannel.exit();
    session.disconnect();
}

通过这种方式,可以在Spring Boot应用中实现对远程文件的上传和下载操作。

当然在实际使用场景中,我们还需要考虑到远程操作的异常处理,使用SSH连接池等操作来提高程序的健壮性。

总结

本文介绍了如何在Spring Boot应用中通过JSch库连接远程SSH服务器,执行远程命令,以及上传/下载文件。通过封装SSH连接的功能,我们可以很容易的地在Spring Boot应用中集成SSH协议,进行远程管理和自动化操作。而对于实际操作中的一些复杂场景,我们可以更具实际场景的使用来进行优化管理。有兴趣想要深入了解的读者可以在评论区留言我们一起讨论。

Tags:

最近发表
标签列表