原文地址：https://www.ibm.com/developerworks/cn/opensource/os-sshxcute/

-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

通常的使用場景

JSch 是 SSH2 的一個純 Java 實現。它可以連線到一個 sshd 伺服器，使用埠轉發，X11 轉發，檔案傳輸等等。但是這個類庫畢竟偏向底層，上手與實際執行起來不太方便，sshxcute 框架正是基於 JSch 封裝的，提供了更為便捷的 API 藉口，更加靈活實用的功能，從而可以讓開發與測試人員更加得心應手的使用。sshxcute 是一個框架，它允許工程師利用 Java 程式碼通過 SSH 連線遠端執行 Linux/UNIX 系統上的命令或者指令碼，這種方式不管是針對軟體測試還是系統部署，都簡化了自動化測試與系統環境部署的步驟。

SSHXCUTE 的設計旨在：

• 最小的系統需求 – 僅僅開啟 SSH 連線即可。
• 易用性 – 工程師利用 Java 程式碼執行命令或指令碼。
• 內建命令 / 指令碼任務執行功能。
• 易擴充套件 – 使用者可以自定義任務型別並集成於 sshxcute 框架。

下面的章節分別介紹瞭如何使用 sshxcute 框架，如何配置它的執行時引數選項以及如何利用該框架的 Java API 進行擴充套件從而從容應用到自己的專案中。

sshxcute 框架使用指南

配置

首先，必須確保 JDK 版本在 5.0 以上，然後需要確認 sshxcute.jar 已經在環境變數中的 $CLASSPATH 中，然後才可以開始。如果是用整合開發環境（IDE）下，必須將 sshxcute.jar 加入專案構建路徑下，接下來展示的是如何在 Eclipse IDE 中配置 Java Build Path。右鍵單擊專案 > 屬性 > Java 構建路徑。更多的配置步驟請在網際網路上搜索。

圖 1. Eclipse 中配置 Java 構建路徑步驟

初始化準備工作

通常通過 SSH 協議在遠端 Linux/UNIX 系統上執行命令時，以下是必須的步驟：

1. 開啟 SSH 連線客戶端（例如 Putty，SSHClient 等）
2. 輸入 IP
3. 輸入使用者名稱、密碼登入
4. 登入成功後輸入執行命令
5. 斷開登入

前三個步驟可以通過 sshxcute 的 Java API 模擬實現：

清單 1. 登入遠端主機

1 2 3 4 5 6

// 新建一個 ConnBean 物件，三個引數依次是 ip 地址、使用者名稱、密碼 ConnBean cb = new ConnBean("ip ", "username","password"); // 將上面新建的 ConnBean 作為引數傳遞給 SSHExec 的靜態單例方法，得到一個 SSHExec 的例項 ssh = SSHExec.getInstance(cb); // 利用上面得到的 SSHExec 例項連線主機 ssh.connect();

第五步斷開登入的實現如下：

清單 2. 斷開遠端主機

1	ssh.disconnect();

第四步是 sshxcute 框架的核心所在——自動執行命令或者指令碼。接下來的部分將主要介紹這個主題。

遠端執行命令

這是 sshxcute 框架內自帶的任務型別，接下來 3.4 小節講到的遠端執行 shell 指令碼也是自帶的任務型別。先來看一段程式碼再來詳細解釋。如果讀者已經具備了面向物件程式設計經驗，那麼下面的內容將會被發現如此熟悉與簡單。

清單 3. 遠端執行命令

1 2	CustomTask sampleTask = new ExecCommand("echo 123"); ssh.exec(sampleTask);

ExecCommand 類繼承了 CustomTask 類，我們新建一個 ExecCommand 物件，他的引用型別是 CustomTask。下圖展示了 ExecCommand、ExecShellScript 和 CustomTask 的類圖，從中可以看出他們的關係，ExecCommand、ExecShellScript 是 CustomTask 的子類。

圖 2. sshxcute 框架類圖

ExecCommand 的建構函式只接收一個字串型別變數。注意 ExecCommand 可以執行多個命令，只需要用分隔符“,”分隔各個命令即可。例如：

清單 4. 遠端順序執行多個命令

1	CustomTask sampleTask = new ExecCommand("echo 123", "echo 456, "echo 789");

ExecCommand 的建構函式是：

public ExecCommand(String...args)

把 ExecCommand 物件作為引數傳入 SSHExec.exec(CustomTask) 方法，這樣就可以直接執行命令了。

遠端執行 shell 指令碼

遠端執行 shell 指令碼幾乎與 3.3 小節的遠端執行命令一致。例如，如果想執行 /home/tsadmin 路徑下的 sshxcute_test.sh 指令碼，並且帶兩個引數“hello world”，可以這樣呼叫：

清單 5. 遠端執行 shell 指令碼

1 2 3

CustomTask ct1 = \ new ExecShellScript("/home/tsadmin","./sshxcute_test.sh","hello world"); ssh.exec(ct1);

ExecShellScript 的建構函式是：

public ExecShellScript(String workingDir, String shellPath, String args)

public ExecShellScript(String shellPath, String args)

public ExecShellScript(String shellPath)

其中 workingDir 代表執行前先切換到路徑，shellPath 代表指令碼執行路徑，args 代表引數列表。

上傳檔案到遠端主機

通常會遇到一種情況，要執行的指令碼是存在於本地的，必須先把其上傳到遠端的主機上。這項工作 sshxcute 同樣可以為完成，例如，想要把 c:/data2/data 目錄下的所有檔案上傳到遠端機器上的 /home/tsadmin 目錄下，可以

清單 6. 上傳資料夾下全部檔案到遠端主機

1	ssh.uploadAllDataToServer("c:/data2/data", "/home/tsadmin");

如果想只上傳單一檔案，例如只上傳路徑下的 c:/data/sshxcute_test.sh 到 /home/tsadmin，可以這樣

清單 7. 上傳單一檔案到遠端主機

1	ssh.uploadSingleDataToServer("c:/data/sshxcute_test.sh","/home/tsadmin");

這裡要注意下，必須把順序搞清楚，上傳的步驟必須在執行前，連線成功後。例如：

清單 8. 執行順序注意，上傳指令碼後才能執行成功

1 2 3 4

CustomTask ct1 = new ExecShellScript("/home/tsadmin","./sshxcute_test.sh","hello world"); ssh.connect();  // 連線成功後 ssh.uploadSingleDataToServer("data/sshxcute_test.sh", "/home/tsadmin"); ssh.exec(ct1);  // 執行前

當然這裡不僅僅限於必須執行指令碼，如果你只想上傳檔案可以單獨執行 uploadSingleDataToServer() 或者 uploadSingleDataToServer() 方法。

結果物件

所有的任務型別，包括上面已經講解過的 ExecCommand、ExecShellScript 還有接下來會說明的自定義類任務，在執行完畢後，都會返回一個結果物件（Result）。這個結果物件包含了命令或者指令碼的返回程式碼（return code）、標準輸入、錯誤輸出。還有它會提供一個布林型別的 isSuccess 變數供程式設計師判斷是否任務執行成功，在 4.1 章節判定任務成功與否的過濾關鍵字，將會詳細介紹 sshxcute 是如何判斷任務執行成功與否的，這個判斷的條件也是可以配置的。

例如，SSHExec.exec(CustomTask) 總會返回一個結果物件，可以利用自己的邏輯程式碼列印一些有用的資訊。程式碼相見清單 9

清單 9. 根據結果物件列印輸出或者錯誤資訊

1 2 3 4 5 6 7 8 9 10 11

Result res = ssh.exec(task); if (res.isSuccess) { System.out.println("Return code: " + res.rc); System.out.println("sysout: " + res.sysout); } else { System.out.println("Return code: " + res.rc); System.out.println("error message: " + res.error_msg); }

小結

下面的例子囊括上面所有的技術話題，做個小結。假設需求是在遠端的 Linux 伺服器（ip 是 9.125.71.115）上執行一個 shell 指令碼—— sshxcute_test.sh。它的內容見清單 10。

清單 10. sshxcute_test.sh 指令碼內容

1 2 3 4 5 6 7 8 9 10 11 12 13

#!/bin/bash if [ $# -ne 2 ];then echo "usage: sshxcute_test.sh username password" exit 1 fi export USERNAME=$1 export PASSWORD=$2 if [ "$USERNAME" = "hello" -a "$PASSWORD" = "world" ];then echo "Login success" exit 0 fi echo "Login falied" exit 2

實現程式碼見清單 11。

清單 11. 一個具體例項的實現程式碼

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

// 新建一個 SSHExec 引用 SSHExec ssh = null; // 下面所有的程式碼都放在 try-catch 塊中 try { // 例項化一個 ConnBean 物件，引數依次是 IP 地址、使用者名稱和密碼 ConnBean cb = new ConnBean("9.125.71.115", "username","password"); // 將剛剛例項化的 ConnBean 物件作為引數傳遞給 SSHExec 的單例方法得到一個 SSHExec 物件 ssh = SSHExec.getInstance(cb); // 新建一個 ExecCommand 物件，引用必須是其繼承的 CustomTask 類 CustomTask ct1 = new ExecCommand("chmod 755 /home/tsadmin/sshxcute_test.sh"); // 新建一個 ExecShellScript 物件，引用必須是其繼承的 CustomTask 類 CustomTask ct2 = new ExecShellScript("/home/tsadmin","./sshxcute_test.sh" ,"hello world"); // 連線伺服器 ssh.connect(); // 上傳 shell 指令碼到 /home/tsadmin 目錄 ssh.uploadSingleDataToServer("data/sshxcute_test.sh", "/home/tsadmin"); // 執行命令 ssh.exec(ct1); // 執行指令碼並且返回一個 Result 物件 Result res = ssh.exec(ct2); // 檢查執行結果，如果執行成功列印輸出，如果執行失敗，列印錯誤資訊 if (res.isSuccess) { System.out.println("Return code: " + res.rc); System.out.println("sysout: " + res.sysout); } else { System.out.println("Return code: " + res.rc); System.out.println("error message: " + res.error_msg); } } catch (TaskExecFailException e) { System.out.println(e.getMessage()); e.printStackTrace(); } catch (Exception e) { System.out.println(e.getMessage()); e.printStackTrace(); } finally { ssh.disconnect();  }