cn.cloudscope.oss.service

接口 StorageWorker

所有已知实现类:

AliyunWorker, MinioWorker, TencentCosWorker

public interface StorageWorker

文件存储接口

作者:

wupanhua

字段概要

字段

限定符和类型	字段和说明
static org.slf4j.Logger	log
static String	SUFFIX_BACKUP
static String	SUFFIX_THUMBNAIL
static Map<String,String>	TYPE_CACHE

方法概要

限定符和类型	方法和说明
default String	appendSuffix(String fileName, String suffix) <添加文件后缀>
default String	backupFile(String originPath, boolean deleteOrigin, boolean isPublic) 复制文件
default String	buildThumbnail(String path, String bucket, File file) 单独创建文件缩略图，或可在上传时直接生成 upload(InputStream, String, String, boolean)
default String	contentTypeByFileName(String name)
String	copyObject(String source, String target, boolean isPublic) 相同桶间文件复制
String	crateFileExpireUrl(String path, int expire) <创建一个指定有效期的数据访问链接>
default UploadResult	createImgExpireUrl(String path, int expire) <创建一个指定有效期的图片访问链接>
boolean	deleteFile(String path) 根据路径删除文件
default String	doUpload(File file, String bucket, String path) 待实现的文件上传接口
String	doUpload(InputStream stream, String bucket, String path, String originName) 待实现的文件上传接口
InputStream	download(String key) 下载文件
default void	download(String key, OutputStream response) 下载文件到指定输出流
default String	generatePath(String fileName) 按规则生成文件路径（年月及文件名hash）
default String	generatePath(String folder, String fileName) 生成远程文件路径
String	getBucket(boolean isPublic)
String	getEndpoint()
default String	getPublicBucket()
default DocumentUrlResult	getPublicDocumentUrl(String key) 获取公开文档访问路径
default String	suffixByContentType(String contentType)
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) 上传文件，若是图片的话，生成缩略图
default UploadResult	upload(InputStream inputStream, String fileName, String folder, boolean thumbnail) 上传文件
default UploadResult	upload(InputStream inputStream, String fileName, String folder, boolean thumbnail, boolean isPublic) 上传文件
default UploadResult	upload(String filePath, String folder) 上传文件
default UploadResult	uploadFromUri(String uri, boolean keepPublic, boolean thumbnail)
default List<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

另请参阅:

常量字段值

TYPE_CACHE

static final Map<String,String> TYPE_CACHE

方法详细资料

upload

default UploadResult upload(InputStream inputStream,
                            String fileName,
                            String folder,
                            boolean thumbnail)

上传文件

参数:

inputStream - 文件流

fileName - 文件名

folder - 目标文件夹

thumbnail - 是否生成缩略图

返回:

文件上传后的路径

upload

default UploadResult upload(InputStream inputStream,
                            String fileName,
                            String folder,
                            boolean thumbnail,
                            boolean isPublic)

上传文件

参数:

inputStream - 文件流

fileName - 文件名

folder - 目标文件夹

thumbnail - 是否生成缩略图

isPublic - 上传到公开库

返回:

文件上传后的路径

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.cloudscope.oss.bean.UploadResult

doUpload

String doUpload(InputStream stream,
                String bucket,
                String path,
                String originName)

待实现的文件上传接口

参数:

stream - 文件流

bucket -

path - 远程路径

originName -

返回:

远程文件路径

doUpload

default String doUpload(File file,
                        String bucket,
                        String path)
                 throws IOException

待实现的文件上传接口

参数:

file - 文件

path - 远程路径

返回:

远程文件路径

抛出:

IOException - File Not Found

generatePath

default String generatePath(String folder,
                            String fileName)

生成远程文件路径

参数:

folder - 目标文件夹

fileName - 文件名

返回:

java.lang.String

upload

default UploadResult upload(String filePath,
                            String folder)

上传文件

参数:

filePath - 目标文件

folder - 上传文件夹，可为空，且推荐为空

返回:

cn.cloudscope.oss.bean.UploadResult

upload

default UploadResult upload(File file)

上传文件

参数:

file - 目标文件

返回:

cn.cloudscope.oss.bean.UploadResult

buildThumbnail

default String buildThumbnail(String path,
                              String bucket,
                              File file)

单独创建文件缩略图，或可在上传时直接生成 upload(InputStream, String, String, boolean)

参数:

path - 图片OSS地址

file - 原图片

返回:

java.lang.String

appendSuffix

default String appendSuffix(String fileName,
                            String suffix)

<添加文件后缀>

参数:

fileName - 文件名（可以包含路径）

suffix - 要添加的文件后缀

返回:

添加后缀后的新文件名

download

InputStream download(String key)

下载文件

参数:

key - 文件路径

返回:

java.io.InputStream

download

default void download(String key,
                      OutputStream response)

下载文件到指定输出流

参数:

key - 文件minio路径

response - 响应流

backupFile

default String backupFile(String originPath,
                          boolean deleteOrigin,
                          boolean isPublic)

复制文件

参数:

originPath - 文件前缀路径

deleteOrigin - 是否删除原文件

isPublic -

返回:

备份后的文件路径

copyObject

String copyObject(String source,
                  String target,
                  boolean isPublic)

相同桶间文件复制

参数:

source - 源路径

target - 目标路径

isPublic - 是否公开库

返回:

java.lang.String

从以下版本开始:

2023/9/25 16:08

deleteFile

boolean deleteFile(String path)

根据路径删除文件

参数:

path - 1

返回:

boolean

uploadMultipleFile

default List<UploadResult> uploadMultipleFile(List<File> files)

上传多个文件

参数:

files - 待上传文件列表

返回:

上传文件成功后的结果集

crateFileExpireUrl

String crateFileExpireUrl(String path,
                          int expire)

<创建一个指定有效期的数据访问链接>

参数:

path - oss存储路径

expire - 有效时间（s）

返回:

签名后的路径，可直接访问

createImgExpireUrl

default UploadResult createImgExpireUrl(String path,
                                        int expire)

<创建一个指定有效期的图片访问链接>

参数:

path - oss存储路径

expire - 有效时间（s）

返回:

void

generatePath

default String generatePath(String fileName)

按规则生成文件路径（年月及文件名hash）

参数:

fileName - 文件名

返回:

java.lang.String

uploadFromUri

default UploadResult uploadFromUri(String uri,
                                   boolean keepPublic,
                                   boolean thumbnail)

contentTypeByFileName

default String contentTypeByFileName(String name)

suffixByContentType

default String suffixByContentType(String contentType)

getEndpoint

String getEndpoint()

getPublicBucket

default String getPublicBucket()

getBucket

String getBucket(boolean isPublic)

getPublicDocumentUrl

default DocumentUrlResult getPublicDocumentUrl(String key)

获取公开文档访问路径

参数:

key - 文档路径

返回:

cn.devcorp.bean.DocumentUrlResult