cn.hutool.extra.ftp

类 Ftp

java.lang.Object

cn.hutool.extra.ftp.Ftp

所有已实现的接口:

Closeable, AutoCloseable

public class Ftp
extends Object
implements Closeable

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

从以下版本开始:

4.1.8

作者:

looly

字段概要

字段

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

构造器概要

构造器

构造器和说明
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) 构造

方法概要

方法

限定符和类型	方法和说明
boolean	cd(String directory) 改变目录
void	close()
boolean	del(String path, String fileName) 删除指定目录下的指定文件
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(String host, int port, String user, String password) 初始化连接
boolean	mkdir(String remote) 创建多层目录文件，如果有ftp服务器已存在该文件，则不创建，如果无，则创建
boolean	upload(String path, File file) 上传文件
boolean	upload(String path, String fileName, File file) 上传文件
boolean	upload(String path, String fileName, InputStream fileStream) 上传文件

从类继承的方法 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 - 编码

方法详细资料

init

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

初始化连接

参数:

host - 域名或IP

port - 端口

user - 用户名

password - 密码

返回:

this

cd

public boolean cd(String directory)

改变目录

参数:

directory - 目录

返回:

是否成功

mkdir

public boolean mkdir(String remote)

创建多层目录文件，如果有ftp服务器已存在该文件，则不创建，如果无，则创建

参数:

remote - 目录

返回:

是否创建成功

existFile

public boolean existFile(String path)

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

参数:

path - 文件路径

返回:

是否存在

del

public boolean del(String path,
          String fileName)

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

参数:

path - 目录路径

fileName - 文件名

返回:

是否存在

upload

public boolean upload(String path,
             File file)

上传文件

参数:

path - 服务端路径（目录）

file - 文件

返回:

是否上传成功

upload

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

上传文件

参数:

file - 文件

path - 服务端路径

fileName - 文件名

返回:

是否上传成功

upload

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

上传文件

参数:

path - 服务端路径

fileName - 文件名

fileStream - 文件流

返回:

是否上传成功

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

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

抛出:

IOException