cn.hutool.extra.ssh

类 Sftp

java.lang.Object

cn.hutool.extra.ftp.AbstractFtp

cn.hutool.extra.ssh.Sftp

所有已实现的接口:

Closeable, AutoCloseable

public class Sftp
extends AbstractFtp

SFTP是Secure File Transfer Protocol的缩写，安全文件传送协议。可以为传输文件提供一种安全的加密方法。
SFTP 为 SSH的一部份，是一种传输文件到服务器的安全方式。SFTP是使用加密传输认证信息和传输的数据，所以，使用SFTP是非常安全的。
但是，由于这种传输方式使用了加密/解密技术，所以传输效率比普通的FTP要低得多，如果您对网络安全性要求更高时，可以使用SFTP代替FTP。

此类为基于jsch的SFTP实现
参考：https://www.cnblogs.com/longyg/archive/2012/06/25/2556576.html

从以下版本开始:

4.0.2

作者:

looly

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	Sftp.Mode JSch支持的三种文件传输模式

字段概要

从类继承的字段 cn.hutool.extra.ftp.AbstractFtp

DEFAULT_CHARSET, ftpConfig

构造器概要

构造器

构造器和说明
Sftp(com.jcraft.jsch.ChannelSftp channel, Charset charset) 构造
Sftp(com.jcraft.jsch.ChannelSftp channel, Charset charset, long timeOut) 构造
Sftp(FtpConfig config) 构造
Sftp(FtpConfig config, boolean init) 构造
Sftp(com.jcraft.jsch.Session session) 构造
Sftp(com.jcraft.jsch.Session session, Charset charset) 构造
Sftp(com.jcraft.jsch.Session session, Charset charset, long timeOut) 构造
Sftp(String sshHost, int sshPort, String sshUser, String sshPass) 构造
Sftp(String sshHost, int sshPort, String sshUser, String sshPass, Charset charset) 构造

方法概要

限定符和类型	方法和说明
boolean	cd(String directory) 打开指定目录，如果指定路径非目录或不存在返回false
void	close()
boolean	delDir(String dirPath) 删除文件夹及其文件夹下的所有文件
boolean	delFile(String filePath) 删除文件
void	download(String src, File destFile) 下载文件
void	download(String src, OutputStream out) 下载文件到OutputStream中
Sftp	get(String src, OutputStream out) 获取远程文件
Sftp	get(String src, String dest) 获取远程文件
com.jcraft.jsch.ChannelSftp	getClient() 获取SFTP通道客户端
String	home() 获取HOME路径
void	init() 初始化
void	init(com.jcraft.jsch.ChannelSftp channel, Charset charset) 初始化
void	init(FtpConfig config) 初始化
void	init(com.jcraft.jsch.Session session, Charset charset) 初始化
void	init(String sshHost, int sshPort, String sshUser, String sshPass, Charset charset) 构造
boolean	isDir(String dir) 判断给定路径是否为目录
List<String>	ls(String path) 遍历某个目录下所有文件或目录，不会递归遍历
List<String>	ls(String path, Filter<com.jcraft.jsch.ChannelSftp.LsEntry> filter) 遍历某个目录下所有文件或目录，不会递归遍历 此方法自动过滤"."
List<String>	lsDirs(String path) 遍历某个目录下所有目录，不会递归遍历
List<com.jcraft.jsch.ChannelSftp.LsEntry>	lsEntries(String path) 遍历某个目录下所有文件或目录，生成LsEntry列表，不会递归遍历 此方法自动过滤"."
List<com.jcraft.jsch.ChannelSftp.LsEntry>	lsEntries(String path, Filter<com.jcraft.jsch.ChannelSftp.LsEntry> filter) 遍历某个目录下所有文件或目录，生成LsEntry列表，不会递归遍历 此方法自动过滤"."
List<String>	lsFiles(String path) 遍历某个目录下所有文件，不会递归遍历
boolean	mkdir(String dir) 在当前远程目录（工作目录）下创建新的目录
Sftp	put(InputStream srcStream, String destPath, com.jcraft.jsch.SftpProgressMonitor monitor, Sftp.Mode mode) 将本地数据流上传到目标服务器，目标文件名为destPath，目标必须为文件
Sftp	put(String srcFilePath, String destPath) 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。
Sftp	put(String srcFilePath, String destPath, Sftp.Mode mode) 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。
Sftp	put(String srcFilePath, String destPath, com.jcraft.jsch.SftpProgressMonitor monitor, Sftp.Mode mode) 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。
String	pwd() 远程当前目录
Sftp	reconnectIfTimeout() 如果连接超时的话，重新进行连接
void	recursiveDownloadFolder(String sourcePath, File destDir) 递归下载FTP服务器上文件到本地(文件目录和服务器同步)
void	syncUpload(File file, String remotePath) 将本地文件或者文件夹同步（覆盖）上传到远程路径
String	toString()
boolean	upload(String destPath, File file) 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与file文件名相同。
boolean	upload(String destPath, String fileName, InputStream fileStream) 上传文件到指定目录，可选： 1. path为null或""上传到当前路径 2. path为相对路径则相对于当前路径的子路径 3. path为绝对路径则上传到此路径

从类继承的方法 cn.hutool.extra.ftp.AbstractFtp

download, exist, mkDirs, toParent

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

Sftp

public Sftp(String sshHost,
            int sshPort,
            String sshUser,
            String sshPass)

构造

参数:

sshHost - 远程主机

sshPort - 远程主机端口

sshUser - 远程主机用户名

sshPass - 远程主机密码

Sftp

public Sftp(String sshHost,
            int sshPort,
            String sshUser,
            String sshPass,
            Charset charset)

构造

参数:

sshHost - 远程主机

sshPort - 远程主机端口

sshUser - 远程主机用户名

sshPass - 远程主机密码

charset - 编码

从以下版本开始:

4.1.14

Sftp

public Sftp(FtpConfig config)

构造

参数:

config - FTP配置

从以下版本开始:

5.3.3

Sftp

public Sftp(FtpConfig config,
            boolean init)

构造

参数:

config - FTP配置

init - 是否立即初始化

从以下版本开始:

5.8.4

Sftp

public Sftp(com.jcraft.jsch.Session session)

构造

参数:

session - Session

Sftp

public Sftp(com.jcraft.jsch.Session session,
            Charset charset)

构造

参数:

session - Session

charset - 编码

从以下版本开始:

4.1.14

Sftp

public Sftp(com.jcraft.jsch.Session session,
            Charset charset,
            long timeOut)

构造

参数:

session - Session

charset - 编码

timeOut - 超时时间，单位毫秒

从以下版本开始:

5.8.4

Sftp

public Sftp(com.jcraft.jsch.ChannelSftp channel,
            Charset charset,
            long timeOut)

构造

参数:

channel - ChannelSftp

charset - 编码

timeOut - 超时时间，单位毫秒

从以下版本开始:

5.8.4

Sftp

public Sftp(com.jcraft.jsch.ChannelSftp channel,
            Charset charset)

构造

参数:

channel - ChannelSftp

charset - 编码

方法详细资料

init

public void init(String sshHost,
                 int sshPort,
                 String sshUser,
                 String sshPass,
                 Charset charset)

构造

参数:

sshHost - 远程主机

sshPort - 远程主机端口

sshUser - 远程主机用户名

sshPass - 远程主机密码

charset - 编码

init

public void init()

初始化

从以下版本开始:

5.3.3

init

public void init(FtpConfig config)

初始化

参数:

config - FTP配置

从以下版本开始:

5.3.3

init

public void init(com.jcraft.jsch.Session session,
                 Charset charset)

初始化

参数:

session - Session

charset - 编码

init

public void init(com.jcraft.jsch.ChannelSftp channel,
                 Charset charset)

初始化

参数:

channel - ChannelSftp

charset - 编码

reconnectIfTimeout

public Sftp reconnectIfTimeout()

从类复制的说明: AbstractFtp

如果连接超时的话，重新进行连接

指定者:

reconnectIfTimeout 在类中 AbstractFtp

返回:

this

getClient

public com.jcraft.jsch.ChannelSftp getClient()

获取SFTP通道客户端

返回:

通道客户端

从以下版本开始:

4.1.14

pwd

public String pwd()

远程当前目录

指定者:

pwd 在类中 AbstractFtp

返回:

远程当前目录

home

public String home()

获取HOME路径

返回:

HOME路径

从以下版本开始:

4.0.5

ls

public List<String> ls(String path)

遍历某个目录下所有文件或目录，不会递归遍历

指定者:

ls 在类中 AbstractFtp

参数:

path - 遍历某个目录下所有文件或目录

返回:

目录或文件名列表

从以下版本开始:

4.0.5

lsDirs

public List<String> lsDirs(String path)

遍历某个目录下所有目录，不会递归遍历

参数:

path - 遍历某个目录下所有目录

返回:

目录名列表

从以下版本开始:

4.0.5

lsFiles

public List<String> lsFiles(String path)

遍历某个目录下所有文件，不会递归遍历

参数:

path - 遍历某个目录下所有文件

返回:

文件名列表

从以下版本开始:

4.0.5

ls

public List<String> ls(String path,
                       Filter<com.jcraft.jsch.ChannelSftp.LsEntry> filter)

遍历某个目录下所有文件或目录，不会递归遍历
此方法自动过滤"."和".."两种目录

参数:

path - 遍历某个目录下所有文件或目录

filter - 文件或目录过滤器，可以实现过滤器返回自己需要的文件或目录名列表

返回:

目录或文件名列表

从以下版本开始:

4.0.5

lsEntries

public List<com.jcraft.jsch.ChannelSftp.LsEntry> lsEntries(String path)

遍历某个目录下所有文件或目录，生成LsEntry列表，不会递归遍历
此方法自动过滤"."和".."两种目录

参数:

path - 遍历某个目录下所有文件或目录

返回:

目录或文件名列表

从以下版本开始:

5.3.5

lsEntries

public List<com.jcraft.jsch.ChannelSftp.LsEntry> lsEntries(String path,
                                                           Filter<com.jcraft.jsch.ChannelSftp.LsEntry> filter)

遍历某个目录下所有文件或目录，生成LsEntry列表，不会递归遍历
此方法自动过滤"."和".."两种目录

参数:

path - 遍历某个目录下所有文件或目录

filter - 文件或目录过滤器，可以实现过滤器返回自己需要的文件或目录名列表

返回:

目录或文件名列表

从以下版本开始:

5.3.5

mkdir

public boolean mkdir(String dir)

从类复制的说明: AbstractFtp

在当前远程目录（工作目录）下创建新的目录

指定者:

mkdir 在类中 AbstractFtp

参数:

dir - 目录名

返回:

是否创建成功

isDir

public boolean isDir(String dir)

从类复制的说明: AbstractFtp

判断给定路径是否为目录

覆盖:

isDir 在类中 AbstractFtp

参数:

dir - 被判断的路径

返回:

是否为目录

cd

public boolean cd(String directory)
           throws FtpException

打开指定目录，如果指定路径非目录或不存在返回false

指定者:

cd 在类中 AbstractFtp

参数:

directory - directory

返回:

是否打开目录

抛出:

FtpException - 进入目录失败异常

delFile

public boolean delFile(String filePath)

删除文件

指定者:

delFile 在类中 AbstractFtp

参数:

filePath - 要删除的文件绝对路径

返回:

是否存在

delDir

public boolean delDir(String dirPath)

删除文件夹及其文件夹下的所有文件

指定者:

delDir 在类中 AbstractFtp

参数:

dirPath - 文件夹路径

返回:

boolean 是否删除成功

syncUpload

public void syncUpload(File file,
                       String remotePath)

将本地文件或者文件夹同步（覆盖）上传到远程路径

参数:

file - 文件或者文件夹

remotePath - 远程路径

从以下版本开始:

5.7.6

upload

public boolean upload(String destPath,
                      File file)

从类复制的说明: AbstractFtp

将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与file文件名相同。 覆盖模式

指定者:

upload 在类中 AbstractFtp

参数:

destPath - 服务端路径，可以为null 或者相对路径或绝对路径

file - 需要上传的文件

返回:

是否成功

upload

public boolean upload(String destPath,
                      String fileName,
                      InputStream fileStream)

上传文件到指定目录，可选：

 1. path为null或""上传到当前路径
 2. path为相对路径则相对于当前路径的子路径
 3. path为绝对路径则上传到此路径
 

参数:

destPath - 服务端路径，可以为null 或者相对路径或绝对路径

fileName - 文件名

fileStream - 文件流

返回:

是否上传成功

从以下版本开始:

5.7.16

put

public Sftp put(String srcFilePath,
                String destPath)

将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。覆盖模式

参数:

srcFilePath - 本地文件路径

destPath - 目标路径，

返回:

this

put

public Sftp put(String srcFilePath,
                String destPath,
                Sftp.Mode mode)

将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。

参数:

srcFilePath - 本地文件路径

destPath - 目标路径，

mode - Sftp.Mode 模式

返回:

this

put

public Sftp put(String srcFilePath,
                String destPath,
                com.jcraft.jsch.SftpProgressMonitor monitor,
                Sftp.Mode mode)

将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与srcFilePath文件名相同。

参数:

srcFilePath - 本地文件路径

destPath - 目标路径，

monitor - 上传进度监控，通过实现此接口完成进度显示

mode - Sftp.Mode 模式

返回:

this

从以下版本开始:

4.6.5

put

public Sftp put(InputStream srcStream,
                String destPath,
                com.jcraft.jsch.SftpProgressMonitor monitor,
                Sftp.Mode mode)

将本地数据流上传到目标服务器，目标文件名为destPath，目标必须为文件

参数:

srcStream - 本地的数据流

destPath - 目标路径，

monitor - 上传进度监控，通过实现此接口完成进度显示

mode - Sftp.Mode 模式

返回:

this

从以下版本开始:

5.7.16

download

public void download(String src,
                     File destFile)

从类复制的说明: AbstractFtp

下载文件

指定者:

download 在类中 AbstractFtp

参数:

src - 文件路径

destFile - 输出文件或目录

download

public void download(String src,
                     OutputStream out)

下载文件到OutputStream中

参数:

src - 源文件路径，包括文件名

out - 目标流

另请参阅:

get(String, OutputStream)

recursiveDownloadFolder

public void recursiveDownloadFolder(String sourcePath,
                                    File destDir)
                             throws JschRuntimeException

递归下载FTP服务器上文件到本地(文件目录和服务器同步)

指定者:

recursiveDownloadFolder 在类中 AbstractFtp

参数:

sourcePath - ftp服务器目录，必须为目录

destDir - 本地目录

抛出:

JschRuntimeException

get

public Sftp get(String src,
                String dest)

获取远程文件

参数:

src - 远程文件路径

dest - 目标文件路径

返回:

this

get

public Sftp get(String src,
                OutputStream out)

获取远程文件

参数:

src - 远程文件路径

out - 目标流

返回:

this

从以下版本开始:

5.7.0

close

public void close()

toString

public String toString()

覆盖:

toString 在类中 Object