FileStorageService (x-file-storage-core 2.0.0 API)

java.lang.Object
- org.dromara.x.file.storage.core.FileStorageService

public class FileStorageService
extends Object

用来处理文件存储，对接多个平台

构造器概要

构造器
构造器和说明

FileStorageService()

构造器
构造器和说明
`FileStorageService()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`delete(FileInfo fileInfo)` 根据条件
`boolean`	`delete(FileInfo fileInfo, java.util.function.Predicate<FileInfo> predicate)` 根据条件删除文件
`boolean`	`delete(String url)` 根据 url 删除文件
`boolean`	`delete(String url, java.util.function.Predicate<FileInfo> predicate)` 根据 url 删除文件
`void`	`destroy()`
`Downloader`	`download(FileInfo fileInfo)` 获取文件下载器
`Downloader`	`download(String url)` 获取文件下载器
`Downloader`	`downloadTh(FileInfo fileInfo)` 获取缩略图文件下载器
`Downloader`	`downloadTh(String url)` 获取缩略图文件下载器
`boolean`	`exists(FileInfo fileInfo)` 文件是否存在
`boolean`	`exists(String url)` 文件是否存在
`String`	`generatePresignedUrl(FileInfo fileInfo, Date expiration)` 对文件生成可以签名访问的 URL，无法生成则返回 null
`String`	`generateThPresignedUrl(FileInfo fileInfo, Date expiration)` 对缩略图文件生成可以签名访问的 URL，无法生成则返回 null
`FileInfo`	`getFileInfoByUrl(String url)` 根据 url 获取 FileInfo
`<T extends FileStorage> T`	`getFileStorage()` 获取默认的存储平台
`<T extends FileStorage> T`	`getFileStorage(String platform)` 获取对应的存储平台
`<T extends FileStorage> T`	`getFileStorageVerify(FileInfo fileInfo)` 获取对应的存储平台，如果存储平台不存在则抛出异常
`<T extends FileStorage> T`	`getFileStorageVerify(String platform)` 获取对应的存储平台，如果存储平台不存在则抛出异常
`<T> T`	`invoke(FileStorage platform, String method, Object... args)` 通过反射调用指定存储平台的方法详情见`ReflectUtil.invoke(Object,String,Object...)`
`<T> T`	`invoke(String platform, String method, Object... args)` 通过反射调用指定存储平台的方法详情见`ReflectUtil.invoke(Object,String,Object...)`
`boolean`	`isSupportAcl(FileStorage fileStorage)` 是否支持对文件的访问控制列表
`boolean`	`isSupportAcl(String platform)` 是否支持对文件的访问控制列表
`boolean`	`isSupportMetadata(FileStorage fileStorage)` 是否支持 Metadata
`boolean`	`isSupportMetadata(String platform)` 是否支持 Metadata
`boolean`	`isSupportPresignedUrl(FileStorage fileStorage)` 是否支持对文件生成可以签名访问的 URL
`boolean`	`isSupportPresignedUrl(String platform)` 是否支持对文件生成可以签名访问的 URL
`UploadPretreatment`	`of()` 创建上传预处理器
`UploadPretreatment`	`of(Object source)` 创建上传预处理器
`UploadPretreatment`	`of(Object source, String name)` 创建上传预处理器
`UploadPretreatment`	`of(Object source, String name, String contentType)` 创建上传预处理器
`UploadPretreatment`	`of(Object source, String name, String contentType, Long size)` 创建上传预处理器
`boolean`	`setFileAcl(FileInfo fileInfo, Object acl)` 设置文件的访问控制列表，一般情况下只有对象存储支持该功能详情见`FileInfo#setFileAcl`
`boolean`	`setThFileAcl(FileInfo fileInfo, Object acl)` 设置缩略图文件的访问控制列表，一般情况下只有对象存储支持该功能详情见`FileInfo#setFileAcl`
`FileInfo`	`upload(UploadPretreatment pre)` 上传文件，成功返回文件信息，失败返回 null
`FileWrapper`	`wrapper(Object source)` 对要上传的文件进行包装
`FileWrapper`	`wrapper(Object source, String name)` 对要上传的文件进行包装
`FileWrapper`	`wrapper(Object source, String name, String contentType)` 对要上传的文件进行包装
`FileWrapper`	`wrapper(Object source, String name, String contentType, Long size)` 对要上传的文件进行包装

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料
- FileStorageService
```
public FileStorageService()
```

方法详细资料

getFileStorage

public <T extends FileStorage> T getFileStorage()

获取默认的存储平台

getFileStorage

public <T extends FileStorage> T getFileStorage(String platform)

获取对应的存储平台

getFileStorageVerify
```
public <T extends FileStorage> T getFileStorageVerify(FileInfo fileInfo)
```
获取对应的存储平台，如果存储平台不存在则抛出异常

getFileStorageVerify
```
public <T extends FileStorage> T getFileStorageVerify(String platform)
```
获取对应的存储平台，如果存储平台不存在则抛出异常

upload
```
public FileInfo upload(UploadPretreatment pre)
```
上传文件，成功返回文件信息，失败返回 null

getFileInfoByUrl

public FileInfo getFileInfoByUrl(String url)

根据 url 获取 FileInfo

delete
```
public boolean delete(String url)
```
根据 url 删除文件

delete

public boolean delete(String url,
                      java.util.function.Predicate<FileInfo> predicate)

根据 url 删除文件

delete

public boolean delete(FileInfo fileInfo)

根据条件

delete

public boolean delete(FileInfo fileInfo,
                      java.util.function.Predicate<FileInfo> predicate)

根据条件删除文件

exists
```
public boolean exists(String url)
```
文件是否存在

exists

public boolean exists(FileInfo fileInfo)

文件是否存在

download

public Downloader download(FileInfo fileInfo)

获取文件下载器

download

public Downloader download(String url)

获取文件下载器

downloadTh

public Downloader downloadTh(FileInfo fileInfo)

获取缩略图文件下载器

downloadTh

public Downloader downloadTh(String url)

获取缩略图文件下载器

isSupportPresignedUrl
```
public boolean isSupportPresignedUrl(String platform)
```
是否支持对文件生成可以签名访问的 URL

isSupportPresignedUrl
```
public boolean isSupportPresignedUrl(FileStorage fileStorage)
```
是否支持对文件生成可以签名访问的 URL

generatePresignedUrl

public String generatePresignedUrl(FileInfo fileInfo,
                                   Date expiration)

对文件生成可以签名访问的 URL，无法生成则返回 null

参数:: expiration - 到期时间

generateThPresignedUrl

public String generateThPresignedUrl(FileInfo fileInfo,
                                     Date expiration)

对缩略图文件生成可以签名访问的 URL，无法生成则返回 null

参数:: expiration - 到期时间

isSupportAcl
```
public boolean isSupportAcl(String platform)
```
是否支持对文件的访问控制列表

isSupportAcl

public boolean isSupportAcl(FileStorage fileStorage)

是否支持对文件的访问控制列表

setFileAcl
```
public boolean setFileAcl(FileInfo fileInfo,
                          Object acl)
```
设置文件的访问控制列表，一般情况下只有对象存储支持该功能详情见FileInfo#setFileAcl

setThFileAcl
```
public boolean setThFileAcl(FileInfo fileInfo,
                            Object acl)
```
设置缩略图文件的访问控制列表，一般情况下只有对象存储支持该功能详情见FileInfo#setFileAcl

isSupportMetadata

public boolean isSupportMetadata(String platform)

是否支持 Metadata

isSupportMetadata

public boolean isSupportMetadata(FileStorage fileStorage)

是否支持 Metadata

of
```
public UploadPretreatment of()
```
创建上传预处理器

of

public UploadPretreatment of(Object source)

创建上传预处理器

参数:: source - 源

of

public UploadPretreatment of(Object source,
                             String name)

创建上传预处理器

参数:: source - 源; name - 文件名

of

public UploadPretreatment of(Object source,
                             String name,
                             String contentType)

创建上传预处理器

参数:: source - 源; name - 文件名; contentType - 文件的 MIME 类型

of

public UploadPretreatment of(Object source,
                             String name,
                             String contentType,
                             Long size)

创建上传预处理器

参数:: source - 源; name - 文件名; contentType - 文件的 MIME 类型; size - 文件大小

wrapper
```
public FileWrapper wrapper(Object source)
```
对要上传的文件进行包装

参数:

source - 源

wrapper

public FileWrapper wrapper(Object source,
                           String name)

对要上传的文件进行包装

参数:: source - 源; name - 文件名

wrapper

public FileWrapper wrapper(Object source,
                           String name,
                           String contentType)

对要上传的文件进行包装

参数:: source - 源; name - 文件名

wrapper

public FileWrapper wrapper(Object source,
                           String name,
                           String contentType,
                           Long size)

对要上传的文件进行包装

参数:: source - 源; name - 文件名; contentType - 文件的 MIME 类型; size - 文件大小

invoke

public <T> T invoke(String platform,
                    String method,
                    Object... args)

通过反射调用指定存储平台的方法详情见ReflectUtil.invoke(Object,String,Object...)

invoke

public <T> T invoke(FileStorage platform,
                    String method,
                    Object... args)

通过反射调用指定存储平台的方法详情见ReflectUtil.invoke(Object,String,Object...)

destroy
```
public void destroy()
```

类 FileStorageService

构造器概要

方法概要

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

构造器详细资料

FileStorageService

方法详细资料

getFileStorage

getFileStorage

getFileStorageVerify

getFileStorageVerify

upload

getFileInfoByUrl

delete

delete

delete

delete

exists

exists

download

download

downloadTh

downloadTh

isSupportPresignedUrl

isSupportPresignedUrl

generatePresignedUrl

generateThPresignedUrl

isSupportAcl

isSupportAcl

setFileAcl

setThFileAcl

isSupportMetadata

isSupportMetadata

of

of

of

of

of

wrapper

wrapper

wrapper

wrapper

invoke

invoke

destroy