cn.bctools.oss.template

接口 OssTemplate

所有已知实现类:

AliOssTemplate, MinioTemplate

public interface OssTemplate

〈OssTemplate〉

从以下版本开始:

1.0.0

作者:

auto

方法概要

限定符和类型	方法和说明
void	abortMultipartUpload(String bucketName, String filename, String uploadId) 终止分段上传
boolean	bucketExists(String bucketName) 存储桶是否存在
void	completeMultipartUpload(String bucketName, String filename, String uploadId, Set<Etag> etagList) 完成分段上传
String	createMultipartUpload(String bucketName, String filename) 创建分段上传
String	fileLink(String fileName) 获取默认桶链接
String	fileLink(String fileName, String bucketName) 获取文件外链
default String	getFileName(String module, String originalFilename) 根据规则生成文件名称规则 文件名称规则: 模块名称/日期-雪花id-原文件名
InputStream	getObject(String bucketName, String fileName) 获取文件流
List<BaseFile>	listFiles(String bucketName) 根据桶名获取文件列表信息
void	makeBucket(String bucketName) 创建存储桶
BaseFile	put(String bucketName, String module, InputStream stream, String originalName, boolean cover) 上传文件
BaseFile	putContent(String originalName, String content, String... catalogue) 推送文本到出桶中
BaseFile	putFile(String originalName, InputStream inputStream, String... catalogue) 推送文件到默认桶下面。
BaseFile	putFile(String bucketName, String module, String originalName, InputStream inputStream) 上传文件
BaseFile	putFile(String bucketName, String module, String originalName, org.springframework.web.multipart.MultipartFile file) 上传文件
void	removeFile(String bucketName, String fileName) 删除文件
Etag	uploadPart(byte[] bytes, String bucketName, Integer partNumber, String filename, String uploadId) 分段上传文件

方法详细资料

makeBucket

void makeBucket(String bucketName)

创建存储桶

参数:

bucketName - 存储桶名称

bucketExists

boolean bucketExists(String bucketName)

存储桶是否存在

参数:

bucketName - 存储桶名称

返回:

判断结果

fileLink

String fileLink(String fileName,
                String bucketName)

获取文件外链

参数:

fileName - 文件名称

bucketName - 源存储桶

返回:

String

fileLink

String fileLink(String fileName)

获取默认桶链接

putFile

BaseFile putFile(String bucketName,
                 String module,
                 String originalName,
                 org.springframework.web.multipart.MultipartFile file)

上传文件

参数:

bucketName - 存储桶名称

originalName - 上传文件名

file - 文件

module - 模块

返回:

BaseFile

putFile

BaseFile putFile(String bucketName,
                 String module,
                 String originalName,
                 InputStream inputStream)

上传文件

参数:

bucketName - 存储桶名称

originalName - 上传文件名

inputStream - 文件

module - 模块

返回:

BaseFile

put

BaseFile put(String bucketName,
             String module,
             InputStream stream,
             String originalName,
             boolean cover)

上传文件

参数:

bucketName - 存储桶名称

stream - 上传文件InputStream

originalName - 上传文件名

cover - 是否覆盖

module - 模块

返回:

BaseFile

removeFile

void removeFile(String bucketName,
                String fileName)

删除文件

参数:

fileName - 文件名称

bucketName - 存储桶名称

getFileName

default String getFileName(String module,
                           String originalFilename)

根据规则生成文件名称规则

文件名称规则: 模块名称/日期-雪花id-原文件名

参数:

originalFilename - 原始文件名

module - 模块

返回:

string

getObject

InputStream getObject(String bucketName,
                      String fileName)

获取文件流

参数:

bucketName - 存储桶

fileName - 文件名称

返回:

InputStream

listFiles

List<BaseFile> listFiles(String bucketName)

根据桶名获取文件列表信息

参数:

bucketName - 桶名

返回:

桶下文件集

createMultipartUpload

String createMultipartUpload(String bucketName,
                             String filename)

创建分段上传

参数:

bucketName - 桶

filename - 文件名

返回:

分段上传ID

uploadPart

Etag uploadPart(byte[] bytes,
                String bucketName,
                Integer partNumber,
                String filename,
                String uploadId)

分段上传文件

参数:

bytes - 文件

bucketName - 桶

partNumber - 分片序号

filename - 文件名

uploadId - 分片上传凭证

返回:

分片etag

completeMultipartUpload

void completeMultipartUpload(String bucketName,
                             String filename,
                             String uploadId,
                             Set<Etag> etagList)

完成分段上传

参数:

bucketName - 桶

filename - 文件名

uploadId - 凭证

etagList - 分片etag

abortMultipartUpload

void abortMultipartUpload(String bucketName,
                          String filename,
                          String uploadId)

终止分段上传

参数:

bucketName - 桶

filename - 文件名

uploadId - 凭证

putFile

BaseFile putFile(String originalName,
                 InputStream inputStream,
                 String... catalogue)

推送文件到默认桶下面。默认为项目名的桶

参数:

originalName - 文件名

inputStream - 文件内容的输入流

catalogue - 文件目录

返回:

文件上传后的信息

putContent

BaseFile putContent(String originalName,
                    String content,
                    String... catalogue)

推送文本到出桶中

参数:

originalName - 文件名

content - 文件内容

catalogue - 文件目录

返回:

文件上传后的信息