1. JSCH简介
JSch 是SSH2的一个纯Java实现。它允许你连接到一个sshd 服务器，使用端口转发，X11转发，文件传输等等。你可以将它的功能集成到你自己的 程序中。同时该项目也提供一个J2ME版本用来在手机上直连SSHD服务器。
2. JSCH依赖
<dependency>
<groupId>com.jcraft</groupId>
<artifactId>jsch</artifactId>
<version>0.1.55</version>
</dependency>
3. 使用方法
3.1 连接远程主机
/**
* 初始化
*
* @param ip 远程主机IP地址
* @param port 远程主机端口
* @param username 远程主机登陆用户名
* @param password 远程主机登陆密码
* @throws JSchException JSch异常
*/
public void init(String ip, Integer port, String username, String password) throws JSchException {
JSch jsch = new JSch();
session = jsch.getSession(username, ip, port);
session.setPassword(password);
Properties sshConfig = new Properties();
sshConfig.put("StrictHostKeyChecking", strictHostKeyChecking);
session.setConfig(sshConfig);
session.connect(timeout);
log.info("Session connected!");
}
public void init(String ip, String username, String password) throws JSchException {
init(ip,22,username,password);
}
3.2 ChannelExec使用说明
/**
* 连接多次执行命令，执行命令完毕后需要执行close()方法
*
* @param command 需要执行的指令
* @return 执行结果
* @throws Exception 没有执行初始化
*/
public String execCmd(String command) throws Exception {
// 打开执行shell指令的通道
channel = session.openChannel("exec");
channelExec = (ChannelExec) channel;
if (session == null || channel == null || channelExec == null) {
log.error("请先执行init()");
throw new Exception("请先执行init()");
}
log.info("execCmd command - > {}", command);
channelExec.setCommand(command);
channel.setInputStream(null);
channelExec.setErrStream(System.err);
channel.connect();
StringBuilder sb = new StringBuilder(16);
try (InputStream in = channelExec.getInputStream();
InputStreamReader isr = new InputStreamReader(in, StandardCharsets.UTF_8);
BufferedReader reader = new BufferedReader(isr)) {
String buffer;
while ((buffer = reader.readLine()) != null) {
sb.append("\n").append(buffer);
}
log.info("execCmd result - > {}", sb);
return sb.toString();
}
}
/**
* 执行命令关闭连接
* @param command 需要执行的指令
* @return 执行结果
* @throws Exception 没有执行初始化
*/
public String execCmdAndClose(String command) throws Exception {
String result = execCmd(command);
close();
return result;
}
/**
* 释放资源
*/
public void close() {
if (channelExec != null && channelExec.isConnected()) {
channelExec.disconnect();
}
if (channel != null && channel.isConnected()) {
channel.disconnect();
}
if (session != null && session.isConnected()) {
session.disconnect();
}
}
3.3 ChannelSftp使用说明
3.3.1 ChannelSftp简介
ChannelSftp类是JSch实现SFTP核心类，它包含了所有SFTP的方法，如：
- put()： 文件上传
- get()： 文件下载
- cd()： 进入指定目录
- ls()： 得到指定目录下的文件列表
- rename()： 重命名指定文件或目录
- rm()： 删除指定文件
- mkdir()： 创建目录
- rmdir()： 删除目录
3.3.2 JSch支持三种文件传输模式：
| 模式 | 描述 |
|---|---|
| OVERWRITE | 完全覆盖模式，这是JSch的默认文件传输模式，即如果目标文件已经存在，传输的文件将完全覆盖目标文件，产生新的文件。 |
| RESUME | 恢复模式，如果文件已经传输一部分，这时由于网络或其他任何原因导致文件传输中断，如果下一次传输相同的文件，则会从上一次中断的地方续传。 |
| APPEND | 追加模式，如果目标文件已存在，传输的文件将在目标文件后追加。 |
3.3.3 文件上传
实现文件上传可以调用ChannelSftp对象的put方法。ChannelSftp中有12个put方法的重载方法：
| 方法 | 描述 |
|---|---|
| public void put(String src, String dst) | 将本地文件名为src的文件上传到目标服务器，目标文件名为dst，若dst为目录，则目标文件名将与src文件名相同。采用默认的传输模式：OVERWRITE |
| public void put(String src, String dst, int mode) | 将本地文件名为src的文件上传到目标服务器，目标文件名为dst，若dst为目录，则目标文件名将与src文件名相同。指定文件传输模式为mode（mode可选值为：ChannelSftp.OVERWRITE，ChannelSftp.RESUME，ChannelSftp.APPEND） |
| public void put(String src, String dst, SftpProgressMonitor monitor) | 将本地文件名为src的文件上传到目标服务器，目标文件名为dst，若dst为目录，则目标文件名将与src文件名相同。采用默认的传输模式：OVERWRITE,并使用实现了SftpProgressMonitor接口的monitor对象来监控文件传输的进度。 |
| public void put(String src, String dst,SftpProgressMonitor monitor, int mode) | 将本地文件名为src的文件上传到目标服务器，目标文件名为dst，若dst为目录，则目标文件名将与src文件名相同。指定传输模式为mode，并使用实现了SftpProgressMonitor接口的monitor对象来监控文件传输的进度。 |
| public void put(InputStream src, String dst) | 将本地的input stream对象src上传到目标服务器，目标文件名为dst，dst不能为目录。采用默认的传输模式：OVERWRITE |
| public void put(InputStream src, String dst, int mode) | 将本地的input stream对象src上传到目标服务器，目标文件名为dst，dst不能为目录。指定文件传输模式为mode |
| public void put(InputStream src, String dst, SftpProgressMonitor monitor) | 将本地的input stream对象src上传到目标服务器，目标文件名为dst，dst不能为目录。采用默认的传输模式：OVERWRITE，并使用实现了SftpProgressMonitor接口的monitor对象来监控传输的进度。 |
| public void put(InputStream src, String dst,SftpProgressMonitor monitor, int mode) | 将本地的input stream对象src上传到目标服务器，目标文件名为dst，dst不能为目录。指定文件传输模式为mode，并使用实现了SftpProgressMonitor接口的monitor对象来监控传输的进度。 |
| public OutputStream put(String dst) | 该方法返回一个输出流，可以向该输出流中写入数据，最终将数据传输到目标服务器，目标文件名为dst，dst不能为目录。采用默认的传输模式：OVERWRITE |
| public OutputStream put(String dst, final int mode) | 该方法返回一个输出流，可以向该输出流中写入数据，最终将数据传输到目标服务器，目标文件名为dst，dst不能为目录。指定文件传输模式为mode |
| public OutputStream put(String dst, final SftpProgressMonitor monitor, final int mode) | 该方法返回一个输出流，可以向该输出流中写入数据，最终将数据传输到目标服务器，目标文件名为dst，dst不能为目录。指定文件传输模式为mode，并使用实现了SftpProgressMonitor接口的monitor对象来监控传输的进度。 |
| public OutputStream put(String dst, final SftpProgressMonitor monitor, final int mode, long offset) | 该方法返回一个输出流，可以向该输出流中写入数据，最终将数据传输到目标服务器，目标文件名为dst，dst不能为目录。指定文件传输模式为mode，并使用实现了SftpProgressMonitor接口的monitor对象来监控传输的进度。offset指定了一个偏移量，从输出流偏移offset开始写入数据。 |
/**
* SFTP文件上传
*
* @param src 源地址
* @param dst 目的地址
* @throws Exception 上传文件失败
*/
public void putAndClose(String src, String dst) throws Exception {
putAndClose(src, dst, ChannelSftp.OVERWRITE);
}
/**
* SFTP文件上传
*
* @param src 源地址
* @param dst 目的地址
* @param mode 上传模式 默认为ChannelSftp.OVERWRITE
* @throws Exception 上传文件失败
*/
public void putAndClose(String src, String dst, int mode) throws Exception {
initChannelSftp();
log.info("Upload File {} -> {}", src, dst);
channelSftp.put(src, dst, mode);
log.info("Upload File Success!");
close();
}
/**
* SFTP文件上传并监控上传进度
*
* @param src 源地址
* @param dst 目的地址
* @throws Exception 上传文件失败
*/
public void putMonitorAndClose(String src, String dst) throws Exception {
putMonitorAndClose(src, dst, ChannelSftp.OVERWRITE);
}
/**
* SFTP文件上传并监控上传进度
*
* @param src 源地址
* @param dst 目的地址
最低0.47元/天 解锁文章
扫一扫
2097
到【灌水乐园】发言
