SimpleSSH 使用教程

项目介绍

SimpleSSH 是一个 Java 库，旨在帮助用户在远程 UNIX 主机上运行命令、执行文件上传和下载操作。该项目支持基于密码和免密码认证方式，使得用户可以方便地与远程主机进行交互。

项目快速启动

环境准备

• JDK 8 或更高版本
• Maven

添加依赖

在你的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>com.rationaleemotions</groupId>
    <artifactId>simple-ssh</artifactId>
    <version>1.0.2</version>
</dependency>

创建 SSH 对象

以下是一个简单的示例，展示如何创建一个 SSH 对象并连接到远程主机：

import com.rationaleemotions.simple.ssh.ExecutionBuilder;
import com.rationaleemotions.simple.ssh.SshKnowHow;
import com.rationaleemotions.simple.ssh.SSHUser;

public class SimpleSSHExample {
    public static void main(String[] args) {
        SSHUser sshUser = new SSHUser.Builder()
            .forUser("service_account")
            .withPasswordAs("my_password")
            .build();

        SshKnowHow ssh = new ExecutionBuilder()
            .connectTo("myUnixBox")
            .includeHostKeyChecks(false)
            .usingUserInfo(sshUser)
            .build();

        ExecResults results = ssh.executeCommand("whoami");
        System.out.println(results.getOutput());
    }
}

应用案例和最佳实践

案例一：文件上传

以下是一个示例，展示如何使用 SimpleSSH 上传文件到远程主机：

import com.rationaleemotions.simple.ssh.ExecutionBuilder;
import com.rationaleemotions.simple.ssh.SshKnowHow;
import com.rationaleemotions.simple.ssh.SSHUser;

public class FileUploadExample {
    public static void main(String[] args) {
        SSHUser sshUser = new SSHUser.Builder()
            .forUser("service_account")
            .withPasswordAs("my_password")
            .build();

        SshKnowHow ssh = new ExecutionBuilder()
            .connectTo("myUnixBox")
            .includeHostKeyChecks(false)
            .usingUserInfo(sshUser)
            .build();

        ssh.uploadFile(new File("localFile.txt"), new File("remoteFile.txt"));
    }
}

案例二：环境变量设置

以下是一个示例，展示如何在执行命令时设置环境变量：

import com.rationaleemotions.simple.ssh.ExecutionBuilder;
import com.rationaleemotions.simple.ssh.SshKnowHow;
import com.rationaleemotions.simple.ssh.SSHUser;
import com.rationaleemotions.simple.ssh.EnvVariable;

public class EnvVariableExample {
    public static void main(String[] args) {
        SSHUser sshUser = new SSHUser.Builder()
            .forUser("service_account")
            .withPasswordAs("my_password")
            .build();

        SshKnowHow ssh = new ExecutionBuilder()
            .connectTo("myUnixBox")
            .includeHostKeyChecks(false)
            .usingUserInfo(sshUser)
            .build();

        EnvVariable env = new EnvVariable("foo", "bar");
        ExecResults results = ssh.executeCommand("whoami", env);
        System.out.println(results.getOutput());
    }
}

典型生态项目

SimpleSSH 可以与其他 Java 项目集成，例如：

• Jenkins: 通过 Jenkins 插件，可以使用 SimpleSSH 在构建过程中执行远程命令。
• Spring Boot: 在 Spring Boot 应用中，可以使用 SimpleSSH 进行远程服务器管理。

通过这些集成，SimpleSSH 可以扩展其功能，满足更复杂的自动化需求。