cn.hutool.extra.ftp

类 Ftp

java.lang.Object

cn.hutool.extra.ftp.AbstractFtp

cn.hutool.extra.ftp.Ftp

所有已实现的接口:

Closeable, AutoCloseable

public class Ftp
extends AbstractFtp

FTP客户端封装
此客户端基于Apache-Commons-Net

从以下版本开始:

4.1.8

作者:

looly

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_PORT 默认端口

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

charset, DEFAULT_CHARSET, host, password, port, user

构造器概要

构造器

构造器和说明
Ftp(String host) 构造，匿名登录
Ftp(String host, int port) 构造，匿名登录
Ftp(String host, int port, String user, String password) 构造
Ftp(String host, int port, String user, String password, Charset charset) 构造
Ftp(String host, int port, String user, String password, Charset charset, FtpMode mode) 构造

方法概要

方法

限定符和类型	方法和说明
boolean	cd(String directory) 改变目录
void	close()
boolean	delDir(String dirPath) 删除文件夹及其文件夹下的所有文件
boolean	delFile(String path) 删除指定目录下的指定文件
void	download(String path, File outFile) 下载文件
void	download(String path, String fileName, File outFile) 下载文件
void	download(String path, String fileName, OutputStream out) 下载文件到输出流
boolean	existFile(String path) 判断ftp服务器文件是否存在
org.apache.commons.net.ftp.FTPClient	getClient() 获取FTPClient客户端对象
Ftp	init() 初始化连接
Ftp	init(String host, int port, String user, String password) 初始化连接
Ftp	init(String host, int port, String user, String password, FtpMode mode) 初始化连接
List<String>	ls(String path) 遍历某个目录下所有文件和目录，不会递归遍历
org.apache.commons.net.ftp.FTPFile[]	lsFiles(String path) 遍历某个目录下所有文件和目录，不会递归遍历
boolean	mkdir(String dir) 在当前远程目录（工作目录）下创建新的目录
String	pwd() 远程当前目录
Ftp	reconnectIfTimeout() 如果连接超时的话，重新进行连接 经测试，当连接超时时，client.isConnected()仍然返回ture，无法判断是否连接超时 因此，通过发送pwd命令的方式，检查连接是否超时
Ftp	setBackToPwd(boolean backToPwd) 设置执行完操作是否返回当前目录
Ftp	setMode(FtpMode mode) 设置FTP连接模式，可选主动和被动模式
boolean	upload(String path, File file) 上传文件到指定目录，可选： 1. path为null或""上传到当前路径 2. path为相对路径则相对于当前路径的子路径 3. path为绝对路径则上传到此路径
boolean	upload(String path, String fileName, File file) 上传文件到指定目录，可选： 1. path为null或""上传到当前路径 2. path为相对路径则相对于当前路径的子路径 3. path为绝对路径则上传到此路径
boolean	upload(String path, String fileName, InputStream fileStream) 上传文件到指定目录，可选： 1. path为null或""上传到当前路径 2. path为相对路径则相对于当前路径的子路径 3. path为绝对路径则上传到此路径

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

exist, mkDirs, toParent

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

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

字段详细资料

DEFAULT_PORT

public static final int DEFAULT_PORT

默认端口

另请参阅:

常量字段值

构造器详细资料

Ftp

public Ftp(String host)

构造，匿名登录

参数:

host - 域名或IP

Ftp

public Ftp(String host,
   int port)

构造，匿名登录

参数:

host - 域名或IP

port - 端口

Ftp

public Ftp(String host,
   int port,
   String user,
   String password)

构造

参数:

host - 域名或IP

port - 端口

user - 用户名

password - 密码

Ftp

public Ftp(String host,
   int port,
   String user,
   String password,
   Charset charset)

构造

参数:

host - 域名或IP

port - 端口

user - 用户名

password - 密码

charset - 编码

Ftp

public Ftp(String host,
   int port,
   String user,
   String password,
   Charset charset,
   FtpMode mode)

构造

参数:

host - 域名或IP

port - 端口

user - 用户名

password - 密码

charset - 编码

mode - 模式

方法详细资料

init

public Ftp init()

初始化连接

返回:

this

init

public Ftp init(String host,
       int port,
       String user,
       String password)

初始化连接

参数:

host - 域名或IP

port - 端口

user - 用户名

password - 密码

返回:

this

init

public Ftp init(String host,
       int port,
       String user,
       String password,
       FtpMode mode)

初始化连接

参数:

host - 域名或IP

port - 端口

user - 用户名

password - 密码

mode - 模式

返回:

this

setMode

public Ftp setMode(FtpMode mode)

设置FTP连接模式，可选主动和被动模式

参数:

mode - 模式枚举

返回:

this

从以下版本开始:

4.1.19

setBackToPwd

public Ftp setBackToPwd(boolean backToPwd)

设置执行完操作是否返回当前目录

参数:

backToPwd - 执行完操作是否返回当前目录

返回:

this

从以下版本开始:

4.6.0

reconnectIfTimeout

public Ftp reconnectIfTimeout()

如果连接超时的话，重新进行连接 经测试，当连接超时时，client.isConnected()仍然返回ture，无法判断是否连接超时 因此，通过发送pwd命令的方式，检查连接是否超时

指定者:

reconnectIfTimeout 在类中 AbstractFtp

返回:

this

cd

public boolean cd(String directory)

改变目录

指定者:

cd 在类中 AbstractFtp

参数:

directory - 目录

返回:

是否成功

pwd

public String pwd()

远程当前目录

指定者:

pwd 在类中 AbstractFtp

返回:

远程当前目录

从以下版本开始:

4.1.14

ls

public List<String> ls(String path)

从类复制的说明: AbstractFtp

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

指定者:

ls 在类中 AbstractFtp

参数:

path - 需要遍历的目录

返回:

文件和目录列表

lsFiles

public org.apache.commons.net.ftp.FTPFile[] lsFiles(String path)

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

参数:

path - 目录

返回:

文件或目录列表

mkdir

public boolean mkdir(String dir)

从类复制的说明: AbstractFtp

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

指定者:

mkdir 在类中 AbstractFtp

参数:

dir - 目录名

返回:

是否创建成功

existFile

public boolean existFile(String path)

判断ftp服务器文件是否存在

参数:

path - 文件路径

返回:

是否存在

delFile

public boolean delFile(String path)

从类复制的说明: AbstractFtp

删除指定目录下的指定文件

指定者:

delFile 在类中 AbstractFtp

参数:

path - 目录路径

返回:

是否存在

delDir

public boolean delDir(String dirPath)

从类复制的说明: AbstractFtp

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

指定者:

delDir 在类中 AbstractFtp

参数:

dirPath - 文件夹路径

返回:

boolean 是否删除成功

upload

public boolean upload(String path,
             File file)

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

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

指定者:

upload 在类中 AbstractFtp

参数:

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

file - 文件

返回:

是否上传成功

upload

public boolean upload(String path,
             String fileName,
             File file)

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

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

参数:

file - 文件

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

fileName - 自定义在服务端保存的文件名

返回:

是否上传成功

upload

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

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

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

参数:

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

fileName - 文件名

fileStream - 文件流

返回:

是否上传成功

download

public void download(String path,
            File outFile)

下载文件

指定者:

download 在类中 AbstractFtp

参数:

path - 文件路径

outFile - 输出文件或目录

download

public void download(String path,
            String fileName,
            File outFile)

下载文件

参数:

path - 文件路径

fileName - 文件名

outFile - 输出文件或目录

download

public void download(String path,
            String fileName,
            OutputStream out)

下载文件到输出流

参数:

path - 文件路径

fileName - 文件名

out - 输出位置

getClient

public org.apache.commons.net.ftp.FTPClient getClient()

获取FTPClient客户端对象

返回:

FTPClient

close

public void close()
           throws IOException

抛出:

IOException