Ftp (hutool-extra 6.0.0-M9 API)

所有超级接口:

AutoCloseable, Closeable

所有已知实现类:

AbstractFtp, CommonsFtp, JschSftp, SshjSftp
```
public interface Ftp
extends Closeable
```
FTP的统一规范接口

作者:

Looly

字段概要

字段
限定符和类型字段和说明

static Charset DEFAULT_CHARSET
默认编码

字段
限定符和类型	字段和说明
`static Charset`	`DEFAULT_CHARSET` 默认编码

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`boolean`	`cd(String directory)` 打开指定目录，具体逻辑取决于实现，例如在FTP中，进入失败返回`false`， SFTP中则抛出异常
`boolean`	`delDir(String dirPath)` 删除文件夹及其文件夹下的所有文件
`boolean`	`delFile(String path)` 删除指定目录下的指定文件
`void`	`download(String path, File outFile)` 下载文件
`boolean`	`exist(String path)` 文件或目录是否存在提供路径为空则返回`false` 提供路径非目录但是以'/'或'\'结尾返回`false` 文件名是'.'
`FtpConfig`	`getConfig()` 获取FTP配置
`InputStream`	`getFileStream(String path)` 读取FTP服务器上的文件为输入流
`default boolean`	`isDir(String dir)` 判断给定路径是否为目录
`List<String>`	`ls(String path)` 遍历某个目录下所有文件和目录，不会递归遍历
`boolean`	`mkdir(String dir)` 在当前远程目录（工作目录）下创建新的目录
`void`	`mkDirs(String dir)` 创建指定文件夹及其父目录，从根目录开始创建，创建完成后回到默认的工作目录
`String`	`pwd()` 远程当前目录（工作目录）
`Ftp`	`reconnectIfTimeout()` 如果连接超时的话，重新进行连接
`void`	`recursiveDownloadFolder(String sourcePath, File destDir)` 递归下载FTP服务器上文件到本地(文件目录和服务器同步), 服务器上有新文件会覆盖本地文件
`default boolean`	`toParent()` 打开上级目录
`boolean`	`uploadFile(String destPath, File file)` 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与file文件名相同。

从接口继承的方法 java.io.Closeable
close

- 字段详细资料
  - DEFAULT_CHARSET
```
static final Charset DEFAULT_CHARSET
```
    默认编码
- 方法详细资料
  - getConfig
```
FtpConfig getConfig()
```
    获取FTP配置
    
    返回:
    
    FTP配置
  - reconnectIfTimeout
```
Ftp reconnectIfTimeout()
```
    如果连接超时的话，重新进行连接
    
    返回:
    
    this
  - pwd
```
String pwd()
```
    远程当前目录（工作目录）
    
    返回:
    
    远程当前目录
  - cd
```
boolean cd(String directory)
```
    打开指定目录，具体逻辑取决于实现，例如在FTP中，进入失败返回false， SFTP中则抛出异常
    
    参数:
    
    directory - directory
    
    返回:
    
    是否打开目录
  - toParent
```
default boolean toParent()
```
    打开上级目录
    
    返回:
    
    是否打开目录
  - exist
```
boolean exist(String path)
```
    文件或目录是否存在
    - 提供路径为空则返回false
    - 提供路径非目录但是以'/'或'\'结尾返回false
    - 文件名是'.'或者'..'返回false
    参数:
    
    path - 目录
    
    返回:
    
    是否存在
  - isDir
```
default boolean isDir(String dir)
```
    判断给定路径是否为目录
    
    参数:
    
    dir - 被判断的路径
    
    返回:
    
    是否为目录
    
    从以下版本开始:
    
    5.7.5
  - mkdir
```
boolean mkdir(String dir)
```
    在当前远程目录（工作目录）下创建新的目录
    
    参数:
    
    dir - 目录名
    
    返回:
    
    是否创建成功
  - mkDirs
```
void mkDirs(String dir)
```
    创建指定文件夹及其父目录，从根目录开始创建，创建完成后回到默认的工作目录
    
    参数:
    
    dir - 文件夹路径，绝对路径
  - ls
```
List<String> ls(String path)
```
    遍历某个目录下所有文件和目录，不会递归遍历
    
    参数:
    
    path - 需要遍历的目录
    
    返回:
    
    文件和目录列表
  - delFile
```
boolean delFile(String path)
```
    删除指定目录下的指定文件
    
    参数:
    
    path - 目录路径
    
    返回:
    
    是否存在
  - delDir
```
boolean delDir(String dirPath)
```
    删除文件夹及其文件夹下的所有文件
    
    参数:
    
    dirPath - 文件夹路径
    
    返回:
    
    boolean 是否删除成功
  - uploadFile
```
boolean uploadFile(String destPath,
                   File file)
```
    将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与file文件名相同。覆盖模式
    
    参数:
    
    destPath - 服务端路径，可以为null 或者相对路径或绝对路径
    
    file - 需要上传的文件
    
    返回:
    
    是否成功
  - download
```
void download(String path,
              File outFile)
```
    下载文件
    
    参数:
    
    path - 文件路径
    
    outFile - 输出文件或目录
  - recursiveDownloadFolder
```
void recursiveDownloadFolder(String sourcePath,
                             File destDir)
```
    递归下载FTP服务器上文件到本地(文件目录和服务器同步), 服务器上有新文件会覆盖本地文件
    
    参数:
    
    sourcePath - ftp服务器目录
    
    destDir - 本地目录
    
    从以下版本开始:
    
    5.3.5
  - getFileStream
```
InputStream getFileStream(String path)
```
    读取FTP服务器上的文件为输入流
    
    参数:
    
    path - 文件路径
    
    返回:
    
    InputStream

接口 Ftp

字段概要

方法概要

从接口继承的方法 java.io.Closeable

字段详细资料

DEFAULT_CHARSET

方法详细资料

getConfig

reconnectIfTimeout

pwd

cd

toParent

exist

isDir

mkdir

mkDirs

ls

delFile

delDir

uploadFile

download

recursiveDownloadFolder

getFileStream