cn.bootdu.plugin.ftp.template

类 FtpTemplate

java.lang.Object

cn.bootdu.plugin.ftp.template.FtpTemplate

public class FtpTemplate
extends java.lang.Object

Ftp操作模板

从以下版本开始:

1.0

作者:

duxsheng

字段概要

字段

限定符和类型	字段和说明
private FtpProperties	ftpProperties
private cn.hutool.core.lang.Snowflake	snowflake

构造器概要

构造器

构造器和说明
FtpTemplate()

方法概要

限定符和类型	方法和说明
void	delete(java.lang.String remote) 删除单个文件
void	delete(java.lang.String[] remotes) 删除多个文件
private long	saveFile(java.lang.String filePath, byte[] fileBytes) 保存文件
private long	saveFile(java.lang.String filePath, java.io.InputStream inputStream) 保存文件
private java.lang.String	transferNewPath(java.lang.String originFileName, java.lang.String filePath) 转换新的存储路径
private void	upload(org.apache.commons.net.ftp.FTPClient ftp, java.lang.String remote, java.io.InputStream in) 上传一个文件
void	upload(java.io.InputStream inputStream, java.lang.String originFileName, java.util.function.BiConsumer<java.lang.String,java.lang.String> consumer) 文件上传，支持保存至数据库，和自定义返回，默认保存路径。
<T> T	upload(java.io.InputStream inputStream, java.lang.String originFileName, java.util.function.BiFunction<java.lang.String,java.lang.String,T> function) 文件上传，支持保存至数据库，和自定义返回，默认保存路径。
private java.lang.String	upload(java.io.InputStream inputStream, java.lang.String originFileName, java.lang.String filePath) 文件上传，自定义保存路径
void	upload(java.io.InputStream inputStream, java.lang.String originFileName, java.lang.String filePath, java.util.function.BiConsumer<java.lang.String,java.lang.String> consumer) 文件上传，支持保存至数据库，和自定义返回，默认保存路径。
java.lang.String	upload(java.io.InputStream inputStream, java.lang.String originFileName, java.lang.String filePath, java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.String> function) 文件上传，支持保存至数据库，和自定义返回，默认保存路径。

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

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

字段详细资料

ftpProperties

private FtpProperties ftpProperties

snowflake

private cn.hutool.core.lang.Snowflake snowflake

构造器详细资料

FtpTemplate

public FtpTemplate()

方法详细资料

upload

private java.lang.String upload(java.io.InputStream inputStream,
                                java.lang.String originFileName,
                                java.lang.String filePath)

文件上传，自定义保存路径

参数:

inputStream - 文件上传的流

originFileName - 文件名

filePath - 文件保存路径，只是路径，不包含文件名，文件名系统会自动生成。

返回:

返回一个可以用于前端访问的URL地址

upload

public <T> T upload(java.io.InputStream inputStream,
                    java.lang.String originFileName,
                    java.util.function.BiFunction<java.lang.String,java.lang.String,T> function)

文件上传，支持保存至数据库，和自定义返回，默认保存路径。

类型参数:

T - 用户可以自己定义返回类型

参数:

inputStream - 文件上传的流

originFileName - 文件名

function - 一个接口，提供给用户自定义业务逻辑操作

返回:

返回一个可以用于前端访问的URL地址, 或者存储路径，这个看调用者自己选择。

upload

public void upload(java.io.InputStream inputStream,
                   java.lang.String originFileName,
                   java.util.function.BiConsumer<java.lang.String,java.lang.String> consumer)

文件上传，支持保存至数据库，和自定义返回，默认保存路径。

参数:

inputStream - 文件上传的流

originFileName - 文件名

consumer - 一个消费接口，提供给用户自定义业务逻辑操作

upload

public java.lang.String upload(java.io.InputStream inputStream,
                               java.lang.String originFileName,
                               java.lang.String filePath,
                               java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.String> function)

文件上传，支持保存至数据库，和自定义返回，默认保存路径。

参数:

inputStream - 文件上传的流

originFileName - 文件名

filePath - 文件自定义保存路径

function - 一个接口，提供给用户自定义业务逻辑操作

返回:

返回一个可以用于前端访问的URL地址, 或者存储路径，这个看调用者自己选择。

upload

public void upload(java.io.InputStream inputStream,
                   java.lang.String originFileName,
                   java.lang.String filePath,
                   java.util.function.BiConsumer<java.lang.String,java.lang.String> consumer)

文件上传，支持保存至数据库，和自定义返回，默认保存路径。

参数:

inputStream - 文件上传的流

originFileName - 文件名

filePath - 文件自定义保存路径

consumer - 一个消费接口，提供给用户自定义业务逻辑操作

delete

public void delete(java.lang.String remote)
            throws java.net.SocketException,
                   java.io.IOException

删除单个文件

参数:

remote - 文件列表包含路径

抛出:

java.net.SocketException - socket异常

java.io.IOException - io异常

delete

public void delete(java.lang.String[] remotes)
            throws java.net.SocketException,
                   java.io.IOException

删除多个文件

参数:

remotes - 文件列表包含路径

抛出:

java.net.SocketException - socket异常

java.io.IOException - io异常

saveFile

private long saveFile(java.lang.String filePath,
                      byte[] fileBytes)

保存文件

参数:

filePath - 文件路径

fileBytes - 文件字节数组

返回:

返回一个文件大小字节

saveFile

private long saveFile(java.lang.String filePath,
                      java.io.InputStream inputStream)

保存文件

参数:

filePath - 文件路径

inputStream - 文件输入流

返回:

返回一个文件大小字节

upload

private void upload(org.apache.commons.net.ftp.FTPClient ftp,
                    java.lang.String remote,
                    java.io.InputStream in)
             throws java.net.SocketException,
                    java.io.IOException

上传一个文件

参数:

ftp - ftp客户端

remote - 远程存储地址

in - 文件流

抛出:

java.net.SocketException - socket异常

java.io.IOException - io异常

transferNewPath

private java.lang.String transferNewPath(java.lang.String originFileName,
                                         java.lang.String filePath)

转换新的存储路径

参数:

originFileName - 文件名

filePath - 文件路径（不包含文件名）

返回:

返回一个新的FTP存储路径