Java JSch遠端執行Shell命令的方法

2022-02-24 13:00:19

背景

專案需求，需要遠端 ssh 登入到某個節點執行 shell 命令來完成任務。對於這種需求，如果不用 java 程式，直接 linux 的 ssh 命令就可以完成，但是在編碼到程式中時需要相關的程式包來完成，本文主要介紹在 java 中如何使用 JSch 包實現 ssh 遠端連線並執行命令。

JSch 簡介

JSch 是Java Secure Channel的縮寫。JSch是一個SSH2的純Java實現。它允許你連線到一個SSH伺服器，並且可以使用埠轉發，X11轉發，檔案傳輸等，當然你也可以整合它的功能到你自己的應用程式。框架jsch很老的框架，更新到2016年，現在也不更新了。

JSch 使用 shell 執行命令，有兩種方法

ChannelExec: 一次執行一條命令，一般我們用這個就夠了。
ChannelShell: 可執行多條命令，平時開發用的不多，根據需要來吧；

ChannelExec channelExec = (ChannelExec) session.openChannel("exec");//只能執行一條指令（也可執行符合指令）
ChannelShell channelShell = (ChannelShell) session.openChannel("shell");//可執行多條指令 不過需要輸入輸出流

1. ChannelExec

每個命令之間用 ; 隔開。說明：各命令的執行給果，不會影響其它命令的執行。換句話說，各個命令都會執行，但不保證每個命令都執行成功。
每個命令之間用 && 隔開。說明：若前面的命令執行成功，才會去執行後面的命令。這樣可以保證所有的命令執行完畢後，執行過程都是成功的。
每個命令之間用 || 隔開。說明：|| 是或的意思，只有前面的命令執行失敗後才去執行下一條命令，直到執行成功一條命令為止。

2. ChannelShell

對於ChannelShell，以輸入流的形式，可執行多條指令，這就像在本地計算機上使用互動式shell（它通常用於：互動式使用）。如要要想停止，有兩種方式：

傳送一個exit命令，告訴程式本次互動結束；
使用位元組流中的available方法，來獲取資料的總大小，然後迴圈去讀。

使用範例

1. 引入 pom 依賴

<dependency>
   <groupId>com.jcraft</groupId>
   <artifactId>jsch</artifactId>
   <version>0.1.53</version>
</dependency>

2. jsch 使用範例

在此封裝了一個 Shell 工具類，用來執行 shell 命令，具體使用細節在程式碼註釋中有說明，可以直接拷貝並使用，程式碼如下：

package org.example.shell;
/**
 * Created by qianghaohao on 2021/3/28
 */


import com.jcraft.jsch.ChannelExec;
import com.jcraft.jsch.JSch;
import com.jcraft.jsch.Session;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;

/**
 * @description:
 * @author: qianghaohao
 * @time: 2021/3/28
 */
public class Shell {
    private String host;
    private String username;
    private String password;
    private int port = 22;
    private int timeout = 60 * 60 * 1000;

    public Shell(String host, String username, String password, int port, int timeout) {
        this.host = host;
        this.username = username;
        this.password = password;
        this.port = port;
        this.timeout = timeout;
    }

    public Shell(String host, String username, String password) {
        this.host = host;
        this.username = username;
        this.password = password;
    }

    public String execCommand(String cmd) {
        JSch jSch = new JSch();
        Session session = null;
        ChannelExec channelExec = null;
        BufferedReader inputStreamReader = null;
        BufferedReader errInputStreamReader = null;
        StringBuilder runLog = new StringBuilder("");
        StringBuilder errLog = new StringBuilder("");
        try {
            // 1. 獲取 ssh session
            session = jSch.getSession(username, host, port);
            session.setPassword(password);
            session.setTimeout(timeout);
            session.setConfig("StrictHostKeyChecking", "no");
            session.connect();  // 獲取到 ssh session

            // 2. 通過 exec 方式執行 shell 命令
            channelExec = (ChannelExec) session.openChannel("exec");
            channelExec.setCommand(cmd);
            channelExec.connect();  // 執行命令

            // 3. 獲取標準輸入流
            inputStreamReader = new BufferedReader(new InputStreamReader(channelExec.getInputStream()));
            // 4. 獲取標準錯誤輸入流
            errInputStreamReader = new BufferedReader(new InputStreamReader(channelExec.getErrStream()));

            // 5. 記錄命令執行 log
            String line = null;
            while ((line = inputStreamReader.readLine()) != null) {
                runLog.append(line).append("n");
            }

            // 6. 記錄命令執行錯誤 log
            String errLine = null;
            while ((errLine = errInputStreamReader.readLine()) != null) {
                errLog.append(errLine).append("n");
            }

            // 7. 輸出 shell 命令執行紀錄檔
            System.out.println("exitStatus=" + channelExec.getExitStatus() + ", openChannel.isClosed="
                    + channelExec.isClosed());
            System.out.println("命令執行完成，執行紀錄檔如下:");
            System.out.println(runLog.toString());
            System.out.println("命令執行完成，執行錯誤紀錄檔如下:");
            System.out.println(errLog.toString());
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                if (inputStreamReader != null) {
                    inputStreamReader.close();
                }
                if (errInputStreamReader != null) {
                    errInputStreamReader.close();
                }

                if (channelExec != null) {
                    channelExec.disconnect();
                }
                if (session != null) {
                    session.disconnect();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

        return runLog.toString();
    }
}

上述工具類使用：

package org.example;

import org.example.shell.Shell;

/**
 * Hello world!
 *
 */
public class App {
    public static void main( String[] args ) {
        String cmd = "ls -1";
        Shell shell = new Shell("192.168.10.10", "ubuntu", "11111");
        String execLog = shell.execCommand(cmd);
        System.out.println(execLog);
    }
}