Java程序调用远程Shell脚本

此程序的目的是执行远程机器上的Shell脚本。

【环境参数】
远程机器IP：192.112.24.15
用户名：root
密码：root
Shell脚本的路径：/home/IFileGenTool/BakProvisionAndOccurEntrance.sh

【具体步骤】
1、在远程机器上，准备Shell脚本。
[root@localhost IFileGenTool]# vim ./load_data.sh

#!/bin/sh
source /etc/profile
dbName=$1
tableName=$2
echo [`date +'%Y-%m-%d %H:%M:%S'`]' start loading data...'
mysql -uroot -p123456 -P3306 ${dbName} -e "LOAD DATA LOCAL INFILE '/home/IFileGenTool/bak_data/bak_data_bak.txt' INTO TABLE ${tableName} FIELDS TERMINATED BY ';'"
echo [`date +'%Y-%m-%d %H:%M:%S'`]' end loading data...'
exit
EOF

2、导入需要依赖的jar包。
Java远程调用Shell脚本这个程序需要ganymed-ssh2-build210.jar包。
下载地址：http://www.ganymed.ethz.ch/ssh2/
为了调试方便，可以将\ganymed-ssh2-build210\src下的代码直接拷贝到我们的工程里，
此源码的好处就是没有依赖很多其他的包，拷贝过来干干净净。

 <dependency>
     <groupId>org.jvnet.hudson</groupId>
     <artifactId>ganymed-ssh2</artifactId>
     <version>build210-hudson-1</version>
 </dependency>

3、编写RemoteShellExecutor工具类。

import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;

import org.apache.commons.io.IOUtils;

import ch.ethz.ssh2.ChannelCondition;
import ch.ethz.ssh2.Connection;
import ch.ethz.ssh2.Session;
import ch.ethz.ssh2.StreamGobbler;

public class RemoteShellExecutor {
     
     private Connection conn;
     /** 远程机器IP */
     private String ip;
     /** 用户名 */
     private String osUsername;
     /** 密码 */
     private String password;
     private String charset = Charset.defaultCharset().toString();

     private static final int TIME_OUT = 1000 * 5 * 60;

     /**
      * 构造函数
      * @param ip
      * @param usr
      * @param pasword
      */
     public RemoteShellExecutor(String ip, String usr, String pasword) {
          this.ip = ip;
         this.osUsername = usr;
         this.password = pasword;
     }


     /**
     * 登录
     * @return
     * @throws IOException
     */
     private boolean login() throws IOException {
         conn = new Connection(ip);
         conn.connect();
         return conn.authenticateWithPassword(osUsername, password);
     }

     /**
     * 执行脚本
     * 
     * @param cmds
     * @return
     * @throws Exception
     */
     public int exec(String cmds) throws Exception {
         InputStream stdOut = null;
         InputStream stdErr = null;
         String outStr = "";
         String outErr = "";
         int ret = -1;
         try {
         if (login()) {
             // Open a new {@link Session} on this connection
             Session session = conn.openSession();
             // Execute a command on the remote machine.
             session.execCommand(cmds);
             
             stdOut = new StreamGobbler(session.getStdout());
             outStr = processStream(stdOut, charset);
             
             stdErr = new StreamGobbler(session.getStderr());
             outErr = processStream(stdErr, charset);
             
             session.waitForCondition(ChannelCondition.EXIT_STATUS, TIME_OUT);
             
             System.out.println("outStr=" + outStr);
             System.out.println("outErr=" + outErr);
             
             ret = session.getExitStatus();
         } else {
             throw new Exception("登录远程机器失败" + ip); // 自定义异常类 实现略
         }
         } finally {
             if (conn != null) {
                 conn.close();
             }
             IOUtils.closeQuietly(stdOut);
             IOUtils.closeQuietly(stdErr);
         }
         return ret;
     }

     /**
     * @param in
     * @param charset
     * @return
     * @throws IOException
     * @throws UnsupportedEncodingException
     */
     private String processStream(InputStream in, String charset) throws Exception {
         byte[] buf = new byte[1024];
         StringBuilder sb = new StringBuilder();
         while (in.read(buf) != -1) {
             sb.append(new String(buf, charset));
         }
         return sb.toString();
     }

    public static void main(String args[]) throws Exception {
        RemoteShellExecutor executor = new RemoteShellExecutor("192.168.234.123", "root", "beebank");
        // 执行myTest.sh 参数为java Know dummy
        System.out.println(executor.exec("/home/IFileGenTool /load_data.sh t_users myDataBase01"));
    }
}

4、Java程序调用远程Shell

private void backupAndRestoreData(String originalTableName) throws Exception {
    
    //1. 调用远程Shell脚本，对生产库中数据进行导出和导入备份。                
    LogUtil.getLogger().info("######    1. 开始对数据库中数据利用进行导出和导入备份   ######");
    RemoteShellExecutor executor = new RemoteShellExecutor("192.168.234.123", "root", "root");
    // 执行myTest.sh 参数为java Know dummy
    System.out.println(executor.exec("/home/IFileGenTool/load_data.sh"));
}

5、运行结果

备份数据成功。

6、说明：
0 // getExitStatus方法的返回值

注：一般情况下shell脚本正常执行完毕，getExitStatus方法返回0。
此方法通过远程命令取得Exit Code/status。但并不是每个server设计时都会返回这个值，如果没有则会返回null。
在调用getExitStatus时，要先调用WaitForCondition方法，通过ChannelCondition.java接口的定义可以看到每个条件的具体含义。见以下代码：ChannelCondition.java的源代码