AbstractFtp (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.extra.ftp.AbstractFtp

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

Ftp, Sftp, SshjSftp
```
public abstract class AbstractFtp
extends Object
implements Closeable
```
抽象FTP类，用于定义通用的FTP方法

Since:

4.1.14

Author:

looly

Field Summary

Fields
Modifier and Type Field and Description

static Charset DEFAULT_CHARSET
默认编码

protected FtpConfig ftpConfig

Fields
Modifier and Type	Field and Description
`static Charset`	`DEFAULT_CHARSET` 默认编码
`protected FtpConfig`	`ftpConfig`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractFtp(FtpConfig config)
构造

Constructors
Modifier	Constructor and Description
`protected`	`AbstractFtp(FtpConfig config)` 构造

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract boolean`	`cd(String directory)` 打开指定目录，具体逻辑取决于实现，例如在FTP中，进入失败返回`false`， SFTP中则抛出异常
`abstract boolean`	`delDir(String dirPath)` 删除文件夹及其文件夹下的所有文件
`abstract boolean`	`delFile(String path)` 删除指定目录下的指定文件
`abstract void`	`download(String path, File outFile)` 下载文件
`void`	`download(String path, File outFile, String tempFileSuffix)` 下载文件-避免未完成的文件来自：https://gitee.com/dromara/hutool/pulls/407 此方法原理是先在目标文件同级目录下创建临时文件，下载之，等下载完毕后重命名，避免因下载错误导致的文件不完整。
`boolean`	`exist(String path)` 文件或目录是否存在
`boolean`	`isDir(String dir)` 判断给定路径是否为目录
`abstract List<String>`	`ls(String path)` 遍历某个目录下所有文件和目录，不会递归遍历
`abstract boolean`	`mkdir(String dir)` 在当前远程目录（工作目录）下创建新的目录
`void`	`mkDirs(String dir)` 创建指定文件夹及其父目录，从根目录开始创建，创建完成后回到默认的工作目录
`abstract String`	`pwd()` 远程当前目录（工作目录）
`abstract AbstractFtp`	`reconnectIfTimeout()` 如果连接超时的话，重新进行连接
`abstract void`	`recursiveDownloadFolder(String sourcePath, File destDir)` 递归下载FTP服务器上文件到本地(文件目录和服务器同步), 服务器上有新文件会覆盖本地文件
`boolean`	`toParent()` 打开上级目录
`abstract boolean`	`upload(String destPath, File file)` 将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与file文件名相同。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.io.Closeable
close

- Field Detail
  - DEFAULT_CHARSET
```
public static final Charset DEFAULT_CHARSET
```
    默认编码
  - ftpConfig
```
protected FtpConfig ftpConfig
```
- Constructor Detail
  - AbstractFtp
```
protected AbstractFtp(FtpConfig config)
```
    构造
    
    Parameters:
    
    config - FTP配置
    
    Since:
    
    5.3.3
- Method Detail
  - reconnectIfTimeout
```
public abstract AbstractFtp reconnectIfTimeout()
```
    如果连接超时的话，重新进行连接
    
    Returns:
    
    this
    
    Since:
    
    4.5.2
  - cd
```
public abstract boolean cd(String directory)
```
    打开指定目录，具体逻辑取决于实现，例如在FTP中，进入失败返回false， SFTP中则抛出异常
    
    Parameters:
    
    directory - directory
    
    Returns:
    
    是否打开目录
  - toParent
```
public boolean toParent()
```
    打开上级目录
    
    Returns:
    
    是否打开目录
    
    Since:
    
    4.0.5
  - pwd
```
public abstract String pwd()
```
    远程当前目录（工作目录）
    
    Returns:
    
    远程当前目录
  - isDir
```
public boolean isDir(String dir)
```
    判断给定路径是否为目录
    
    Parameters:
    
    dir - 被判断的路径
    
    Returns:
    
    是否为目录
    
    Since:
    
    5.7.5
  - mkdir
```
public abstract boolean mkdir(String dir)
```
    在当前远程目录（工作目录）下创建新的目录
    
    Parameters:
    
    dir - 目录名
    
    Returns:
    
    是否创建成功
  - exist
```
public boolean exist(String path)
```
    文件或目录是否存在
    
    Parameters:
    
    path - 目录
    
    Returns:
    
    是否存在
  - ls
```
public abstract List<String> ls(String path)
```
    遍历某个目录下所有文件和目录，不会递归遍历
    
    Parameters:
    
    path - 需要遍历的目录
    
    Returns:
    
    文件和目录列表
  - delFile
```
public abstract boolean delFile(String path)
```
    删除指定目录下的指定文件
    
    Parameters:
    
    path - 目录路径
    
    Returns:
    
    是否存在
  - delDir
```
public abstract boolean delDir(String dirPath)
```
    删除文件夹及其文件夹下的所有文件
    
    Parameters:
    
    dirPath - 文件夹路径
    
    Returns:
    
    boolean 是否删除成功
  - mkDirs
```
public void mkDirs(String dir)
```
    创建指定文件夹及其父目录，从根目录开始创建，创建完成后回到默认的工作目录
    
    Parameters:
    
    dir - 文件夹路径，绝对路径
  - upload
```
public abstract boolean upload(String destPath,
                               File file)
```
    将本地文件上传到目标服务器，目标文件名为destPath，若destPath为目录，则目标文件名将与file文件名相同。覆盖模式
    
    Parameters:
    
    destPath - 服务端路径，可以为null 或者相对路径或绝对路径
    
    file - 需要上传的文件
    
    Returns:
    
    是否成功
  - download
```
public abstract void download(String path,
                              File outFile)
```
    下载文件
    
    Parameters:
    
    path - 文件路径
    
    outFile - 输出文件或目录
  - download
```
public void download(String path,
                     File outFile,
                     String tempFileSuffix)
```
    下载文件-避免未完成的文件
    来自：https://gitee.com/dromara/hutool/pulls/407
    此方法原理是先在目标文件同级目录下创建临时文件，下载之，等下载完毕后重命名，避免因下载错误导致的文件不完整。
    
    Parameters:
    
    path - 文件路径
    
    outFile - 输出文件或目录
    
    tempFileSuffix - 临时文件后缀，默认".temp"
    
    Since:
    
    5.7.12
  - recursiveDownloadFolder
```
public abstract void recursiveDownloadFolder(String sourcePath,
                                             File destDir)
```
    递归下载FTP服务器上文件到本地(文件目录和服务器同步), 服务器上有新文件会覆盖本地文件
    
    Parameters:
    
    sourcePath - ftp服务器目录
    
    destDir - 本地目录
    
    Since:
    
    5.3.5

Class AbstractFtp

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.io.Closeable

Field Detail

DEFAULT_CHARSET

ftpConfig

Constructor Detail

AbstractFtp

Method Detail

reconnectIfTimeout

cd

toParent

pwd

isDir

mkdir

exist

ls

delFile

delDir

mkDirs

upload

download

download

recursiveDownloadFolder