Java實踐-遠程調用Shell腳本並獲取輸出信息

1、添加依賴

<dependency>
    <groupId>ch.ethz.ganymed</groupId>
    <artifactId>ganymed-ssh2</artifactId>
    <version>262</version>
</dependency>
<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.6</version>
</dependency>

2、Api說明

1. 首先構造一個連接器，傳入一個需要登陸的ip地址；

Connection conn = new Connection(ipAddr);

2. 模擬登陸目的服務器，傳入用戶名和密碼；

boolean isAuthenticated = conn.authenticateWithPassword(userName, passWord);

它會返回一個布爾值，true 代表成功登陸目的服務器，否則登陸失敗。

3. 打開一個session，執行你需要的linux 腳本命令；

Session session = conn.openSession();
session.execCommand(“ifconfig”);

4. 接收目標服務器上的控制台返回結果，讀取br中的內容；

InputStream stdout = new StreamGobbler(session.getStdout());
BufferedReader br = new BufferedReader(new InputStreamReader(stdout));

5. 得到腳本運行成功與否的標志 ：0－成功 非0－失敗

System.out.println(“ExitCode: ” + session.getExitStatus());

6. 關閉session和connection

session.close();
conn.close();

Tips：

1. 通過第二部認證成功后當前目錄就位於/home/username/目錄之下，你可以指定腳本文件所在的絕對路徑，或者通過cd導航到腳本文件所在的目錄，然后傳遞執行腳本所需要的參數，完成腳本調用執行。
2. 執行腳本以后，可以獲取腳本執行的結果文本，需要對這些文本進行正確編碼后返回給客戶端，避免亂碼產生。
3. 如果你需要執行多個linux控制台腳本，比如第一個腳本的返回結果是第二個腳本的入參，你必須打開多個Session,也就是多次調用
   Session sess = conn.openSession();,使用完畢記得關閉就可以了。

3. 實例：工具類

public class SSHTool {

    private Connection conn;
    private String ipAddr;
    private Charset charset = StandardCharsets.UTF_8;
    private String userName;
    private String password;

    public SSHTool(String ipAddr, String userName, String password, Charset charset) {
        this.ipAddr = ipAddr;
        this.userName = userName;
        this.password = password;
        if (charset != null) {
            this.charset = charset;
        }
    }

    /**
     * 登錄遠程Linux主機
     *
     * @return 是否登錄成功
     */
    private boolean login() {
        conn = new Connection(ipAddr);

        try {
            // 連接
            conn.connect();
            // 認證
            return conn.authenticateWithPassword(userName, password);
        } catch (IOException e) {
            e.printStackTrace();
            return false;
        }
    }


    /**
     * 執行Shell腳本或命令
     *
     * @param cmds 命令行序列
     * @return 腳本輸出結果
     */
    public StringBuilder exec(String cmds) throws IOException {
        InputStream in = null;
        StringBuilder result = new StringBuilder();
        try {
            if (this.login()) {
                // 打開一個會話
                Session session = conn.openSession();
                session.execCommand(cmds);
                in = session.getStdout();
                result = this.processStdout(in, this.charset);
                conn.close();
            }
        } finally {
            if (null != in) {
                in.close();
            }
        }
        return result;
    }

    /**
     * 解析流獲取字符串信息
     *
     * @param in      輸入流對象
     * @param charset 字符集
     * @return 腳本輸出結果
     */
    public StringBuilder processStdout(InputStream in, Charset charset) throws FileNotFoundException {
        byte[] buf = new byte[1024];
        StringBuilder sb = new StringBuilder();
//        OutputStream os = new FileOutputStream("./data.txt");
        try {
            int length;
            while ((length = in.read(buf)) != -1) {
//                os.write(buf, 0, c);
                sb.append(new String(buf, 0, length));
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
        return sb;
    }

    public static void main(String[] args) throws IOException {
        SSHTool tool = new SSHTool("192.168.100.40", "root", "123456", StandardCharsets.UTF_8);
        StringBuilder exec = tool.exec("bash /root/test12345.sh");
        System.out.println(exec);
    }
}

4、測試腳本

echo "Hello"

輸出結果