StorageWorker (oss-spring-boot-starter 1.0.1 API)

所有已知实现类:

AliyunOSSWorker, MinioWorker
```
public interface StorageWorker
```
文件存储接口

作者:

wupanhua

字段概要

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

static org.slf4j.Logger log

static String SUFFIX_BACKUP

static String SUFFIX_THUMBNAIL

字段
限定符和类型	字段和说明
`static org.slf4j.Logger`	`log`
`static String`	`SUFFIX_BACKUP`
`static String`	`SUFFIX_THUMBNAIL`

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`default String`	`appendSuffix(String fileName, String suffix)` Description: <添加文件后缀>
`String`	`backupFile(String originPath, boolean deleteOrigin)` 复制文件
`default String`	`buildThumbnail(String path, File file)` 单独创建文件缩略图，或可在上传时直接生成 `upload(InputStream, String, String, boolean)`
`String`	`crateFileExpireUrl(String path, int expire)` Description: <创建一个指定有效期的数据访问链接>
`UploadResult`	`createImgExpireUrl(String path, int expire)` Description: <创建一个指定有效期的图片访问链接>
`boolean`	`deleteFile(String path)` Description:根据路径删除文件 <>
`default String`	`doUpload(File file, String path)` 待实现的文件上传接口
`String`	`doUpload(InputStream stream, String path, String originName)` 待实现的文件上传接口
`InputStream`	`download(String key)` 下载文件
`void`	`download(String key, OutputStream response)` 下载文件到指定输出流
`default String`	`generatePath(String fileName)`
`DocumentUrlResult`	`getDocumentUrl(String key, int expiresIn)` 获取一个可访问的文件链接
`default UploadResult`	`upload(File file)` 上传文件
`default UploadResult`	`upload(File file, String folder)` 上传文件
`default UploadResult`	`upload(InputStream inputStream, String fileName)` 上传文件
`default UploadResult`	`upload(InputStream inputStream, String fileName, String folder)` 上传文件，若是图片的话，生成缩略图
`UploadResult`	`upload(InputStream inputStream, String fileName, String folder, boolean thumbnail)` 上传文件
`default UploadResult`	`upload(String filePath, String folder)` 上传文件
`UploadResult`	`uploadMultipleFile(List<File> files)` 上传多个文件

- 字段详细资料
  - log
```
static final org.slf4j.Logger log
```
  - SUFFIX_THUMBNAIL
```
static final String SUFFIX_THUMBNAIL
```
    另请参阅:
    
    常量字段值
  - SUFFIX_BACKUP
```
static final String SUFFIX_BACKUP
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - upload
```
UploadResult upload(InputStream inputStream,
                    String fileName,
                    String folder,
                    boolean thumbnail)
```
    上传文件
    
    参数:
    
    inputStream - 文件流
    
    fileName - 文件名
    
    folder - 目标文件夹
    
    thumbnail - 是否生成缩略图
    
    返回:
    
    文件上传后的路径
  - upload
```
default UploadResult upload(InputStream inputStream,
                            String fileName,
                            String folder)
```
    上传文件，若是图片的话，生成缩略图
    
    参数:
    
    inputStream - 文件流
    
    fileName - 文件名
    
    folder - 目标文件夹
    
    返回:
    
    文件上传后的路径
  - upload
```
default UploadResult upload(InputStream inputStream,
                            String fileName)
```
    上传文件
    
    参数:
    
    inputStream - 文件流
    
    fileName - 文件名
    
    返回:
    
    文件上传后的路径
  - upload
```
default UploadResult upload(File file,
                            String folder)
```
    上传文件
    
    参数:
    
    file - 目标文件
    
    folder - 上传文件夹，可为空，且推荐为空
    
    返回:
    
    cn.net.idso.bean.UploadResult
  - doUpload
```
String doUpload(InputStream stream,
                String path,
                String originName)
```
    待实现的文件上传接口
    
    参数:
    
    stream - 文件流
    
    path - 远程路径
    
    originName -
    
    返回:
    
    远程文件路径
  - doUpload
```
default String doUpload(File file,
                        String path)
                 throws IOException
```
    待实现的文件上传接口
    
    参数:
    
    file - 文件
    
    path - 远程路径
    
    返回:
    
    远程文件路径
    
    抛出:
    
    IOException
  - upload
```
default UploadResult upload(String filePath,
                            String folder)
```
    上传文件
    
    参数:
    
    filePath - 目标文件
    
    folder - 上传文件夹，可为空，且推荐为空
    
    返回:
    
    cn.net.idso.bean.UploadResult
  - upload
```
default UploadResult upload(File file)
```
    上传文件
    
    参数:
    
    file - 目标文件
    
    返回:
    
    cn.net.idso.bean.UploadResult
  - buildThumbnail
```
default String buildThumbnail(String path,
                              File file)
```
    单独创建文件缩略图，或可在上传时直接生成 upload(InputStream, String, String, boolean)
    
    参数:
    
    path - 图片OSS地址
    
    file - 原图片
    
    返回:
    
    java.lang.String
  - appendSuffix
```
default String appendSuffix(String fileName,
                            String suffix)
```
    Description: <添加文件后缀>
    
    参数:
    
    fileName - 文件名（可以包含路径）
  - download
```
InputStream download(String key)
```
    下载文件
    
    参数:
    
    key - 文件路径
    
    返回:
    
    java.io.InputStream
  - download
```
void download(String key,
              OutputStream response)
```
    下载文件到指定输出流
    
    参数:
    
    key - 文件minio路径
    
    response - 响应流
  - backupFile
```
String backupFile(String originPath,
                  boolean deleteOrigin)
```
    复制文件
    
    参数:
    
    originPath - 文件前缀路径
    
    deleteOrigin - 是否删除原文件
  - deleteFile
```
boolean deleteFile(String path)
            throws Exception
```
    Description:根据路径删除文件 <>
    
    参数:
    
    path - 1
    
    返回:
    
    boolean
    
    抛出:
    
    Exception
  - getDocumentUrl
```
DocumentUrlResult getDocumentUrl(String key,
                                 int expiresIn)
```
    获取一个可访问的文件链接
    
    参数:
    
    key - 文件路径
    
    expiresIn - 过期时间（秒），默认7天
    
    返回:
    
    DocumentUrlResult
  - uploadMultipleFile
```
UploadResult uploadMultipleFile(List<File> files)
```
    上传多个文件
    
    参数:
    
    files -
    
    返回:
    
    上传文件成功后的结果集
  - crateFileExpireUrl
```
String crateFileExpireUrl(String path,
                          int expire)
```
    Description: <创建一个指定有效期的数据访问链接>
    
    参数:
    
    path - oss存储路径
    
    expire - 有效时间（s）
    
    返回:
    
    void
    
    抛出:
    
    Exception - 文件创建异常
  - createImgExpireUrl
```
UploadResult createImgExpireUrl(String path,
                                int expire)
```
    Description: <创建一个指定有效期的图片访问链接>
    
    参数:
    
    path - oss存储路径
    
    expire - 有效时间（s）
    
    返回:
    
    void
  - generatePath
```
default String generatePath(String fileName)
```

接口 StorageWorker

字段概要

方法概要

字段详细资料

log

SUFFIX_THUMBNAIL

SUFFIX_BACKUP

方法详细资料

upload

upload

upload

upload

doUpload

doUpload

upload

upload

buildThumbnail

appendSuffix

download

download

backupFile

deleteFile

getDocumentUrl

uploadMultipleFile

crateFileExpireUrl

createImgExpireUrl

generatePath