pro.haichuang.framework.sdk.aliyunoss.service

接口 AliYunOssService

所有已知实现类:

DefaultAliYunOssServiceImpl

public interface AliYunOssService

AliYunOssService

该类为 aliyunoss 第三方操作核心接口, 项目中所有 aliyunoss 的操作均使用此接口

该类已默认注入到 spring 中, 默认实现为 DefaultAliYunOssServiceImpl, 如需自定义实现请实现该接口并手动注入该接口

从以下版本开始:

1.1.0.211021

作者:

JiYinchuan

另请参阅:

DefaultAliYunOssServiceImpl

方法概要

限定符和类型	方法和说明
List<String>	deleteObject(Collection<String> ossFilePaths) 删除文件
List<String>	deleteObject(Collection<String> ossFilePaths, boolean quiet) 删除文件
void	deleteObject(String ossFilePath) 删除文件
File	downloadToFile(String ossFilePath) 下载文件至 File 对象
File	downloadToFile(String ossFilePath, File file) 下载文件至 File 对象
File	downloadToFile(String ossFilePath, String fileName) 下载文件至 File 对象
void	downloadToResponse(String ossFilePath, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 下载文件至 HttpServletResponse
void	downloadToResponse(String ossFilePath, String fileName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 下载文件至 HttpServletResponse
String	uploadByFile(File absoluteFilePath, String newFileName, UploadTypeEnum uploadTypeEnum, String... pathOfBizName) 上传文件
String	uploadByFile(File absoluteFilePath, UploadTypeEnum uploadTypeEnum, String... pathOfBizName) 上传文件
List<String>	uploadByFile(LinkedList<File> absoluteFilePaths, LinkedList<String> newFileNames, UploadTypeEnum uploadTypeEnum, String... pathOfBizName) 上传文件
List<String>	uploadByFile(List<File> absoluteFilePaths, UploadTypeEnum uploadTypeEnum, String... pathOfBizName) 上传文件
List<String>	uploadByMultipart(LinkedList<org.springframework.web.multipart.MultipartFile> uploadFiles, LinkedList<String> newFileNames, UploadTypeEnum uploadTypeEnum, String... pathOfBizName) 上传文件
List<String>	uploadByMultipart(List<org.springframework.web.multipart.MultipartFile> uploadFiles, UploadTypeEnum uploadTypeEnum, String... pathOfBizName) 上传文件
String	uploadByMultipart(org.springframework.web.multipart.MultipartFile uploadFile, String newFileName, UploadTypeEnum uploadTypeEnum, String... pathOfBizName) 上传文件
String	uploadByMultipart(org.springframework.web.multipart.MultipartFile uploadFile, UploadTypeEnum uploadTypeEnum, String... pathOfBizName) 上传文件
List<String>	uploadByPath(LinkedList<String> absoluteFilePaths, LinkedList<String> newFileNames, UploadTypeEnum uploadTypeEnum, String... pathOfBizName) 上传文件
List<String>	uploadByPath(List<String> absoluteFilePaths, UploadTypeEnum uploadTypeEnum, String... pathOfBizName) 上传文件
String	uploadByPath(String absoluteFilePath, String newFileName, UploadTypeEnum uploadTypeEnum, String... pathOfBizName) 上传文件
String	uploadByPath(String absoluteFilePath, UploadTypeEnum uploadTypeEnum, String... pathOfBizName) 上传文件

方法详细资料

uploadByMultipart

String uploadByMultipart(org.springframework.web.multipart.MultipartFile uploadFile,
                         UploadTypeEnum uploadTypeEnum,
                         String... pathOfBizName)
                  throws AliYunOssUploadException,
                         IOException

上传文件

参数:

uploadFile - 源文件对象

uploadTypeEnum - 上传文件类型

pathOfBizName - 上传文件路径|业务模块路径

返回:

上传后文件路径

抛出:

AliYunOssUploadException - 阿里云对象存储上传异常

IOException - 获取文件流异常

从以下版本开始:

1.1.0.211021

uploadByMultipart

String uploadByMultipart(org.springframework.web.multipart.MultipartFile uploadFile,
                         String newFileName,
                         UploadTypeEnum uploadTypeEnum,
                         String... pathOfBizName)
                  throws AliYunOssUploadException,
                         IOException

上传文件

参数:

uploadFile - 源文件对象

newFileName - 新文件名

uploadTypeEnum - 上传文件类型

pathOfBizName - 上传文件路径|业务模块路径

返回:

上传后文件路径

抛出:

AliYunOssUploadException - 阿里云对象存储上传异常

IOException - 获取文件流异常

从以下版本开始:

1.1.0.211021

uploadByMultipart

List<String> uploadByMultipart(List<org.springframework.web.multipart.MultipartFile> uploadFiles,
                               UploadTypeEnum uploadTypeEnum,
                               String... pathOfBizName)
                        throws AliYunOssUploadException,
                               IOException

上传文件

参数:

uploadFiles - 源文件对象

uploadTypeEnum - 上传文件类型

pathOfBizName - 上传文件路径|业务模块路径

返回:

上传后文件路径

抛出:

AliYunOssUploadException - 阿里云对象存储上传异常

IOException - 获取文件流异常

从以下版本开始:

1.1.0.211021

uploadByMultipart

List<String> uploadByMultipart(LinkedList<org.springframework.web.multipart.MultipartFile> uploadFiles,
                               LinkedList<String> newFileNames,
                               UploadTypeEnum uploadTypeEnum,
                               String... pathOfBizName)
                        throws AliYunOssUploadException,
                               IOException

上传文件

参数:

uploadFiles - 源文件对象

newFileNames - 新文件名

uploadTypeEnum - 上传文件类型

pathOfBizName - 上传文件路径|业务模块路径

返回:

上传后文件路径

抛出:

AliYunOssUploadException - 阿里云对象存储上传异常

IOException - 获取文件流异常

从以下版本开始:

1.1.0.211021

uploadByPath

String uploadByPath(String absoluteFilePath,
                    UploadTypeEnum uploadTypeEnum,
                    String... pathOfBizName)
             throws AliYunOssUploadException

上传文件

参数:

absoluteFilePath - 源文件绝对路径

uploadTypeEnum - 上传文件类型

pathOfBizName - 上传文件路径|业务模块路径

返回:

上传后文件路径

抛出:

AliYunOssUploadException - 阿里云对象存储上传异常

从以下版本开始:

1.1.0.211021

uploadByPath

String uploadByPath(String absoluteFilePath,
                    String newFileName,
                    UploadTypeEnum uploadTypeEnum,
                    String... pathOfBizName)
             throws AliYunOssUploadException

上传文件

参数:

absoluteFilePath - 源文件绝对路径

newFileName - 新文件名

uploadTypeEnum - 上传文件类型

pathOfBizName - 上传文件路径|业务模块路径

返回:

上传后文件路径

抛出:

AliYunOssUploadException - 阿里云对象存储上传异常

从以下版本开始:

1.1.0.211021

uploadByPath

List<String> uploadByPath(List<String> absoluteFilePaths,
                          UploadTypeEnum uploadTypeEnum,
                          String... pathOfBizName)
                   throws AliYunOssUploadException

上传文件

参数:

absoluteFilePaths - 源文件绝对路径集合

uploadTypeEnum - 上传文件类型

pathOfBizName - 上传文件路径|业务模块路径

返回:

上传后文件路径

抛出:

AliYunOssUploadException - 阿里云对象存储上传异常

从以下版本开始:

1.1.0.211021

uploadByPath

List<String> uploadByPath(LinkedList<String> absoluteFilePaths,
                          LinkedList<String> newFileNames,
                          UploadTypeEnum uploadTypeEnum,
                          String... pathOfBizName)
                   throws AliYunOssUploadException

上传文件

参数:

absoluteFilePaths - 源文件绝对路径集合

newFileNames - 新文件名

uploadTypeEnum - 上传文件类型

pathOfBizName - 上传文件路径|业务模块路径

返回:

上传后文件路径

抛出:

AliYunOssUploadException - 阿里云对象存储上传异常

从以下版本开始:

1.1.0.211021

uploadByFile

String uploadByFile(File absoluteFilePath,
                    UploadTypeEnum uploadTypeEnum,
                    String... pathOfBizName)
             throws AliYunOssUploadException

上传文件

参数:

absoluteFilePath - 源文件对象

uploadTypeEnum - 上传文件类型

pathOfBizName - 上传文件路径|业务模块路径

返回:

上传后文件路径

抛出:

AliYunOssUploadException - 阿里云对象存储上传异常

从以下版本开始:

1.1.0.211021

uploadByFile

String uploadByFile(File absoluteFilePath,
                    String newFileName,
                    UploadTypeEnum uploadTypeEnum,
                    String... pathOfBizName)
             throws AliYunOssUploadException

上传文件

参数:

absoluteFilePath - 源文件对象

newFileName - 新文件名

uploadTypeEnum - 上传文件类型

pathOfBizName - 上传文件路径|业务模块路径

返回:

上传后文件路径

抛出:

AliYunOssUploadException - 阿里云对象存储上传异常

从以下版本开始:

1.1.0.211021

uploadByFile

List<String> uploadByFile(List<File> absoluteFilePaths,
                          UploadTypeEnum uploadTypeEnum,
                          String... pathOfBizName)

上传文件

参数:

absoluteFilePaths - 源文件对象

uploadTypeEnum - 上传文件类型

pathOfBizName - 上传文件路径|业务模块路径

返回:

上传后文件路径

从以下版本开始:

1.1.0.211021

uploadByFile

List<String> uploadByFile(LinkedList<File> absoluteFilePaths,
                          LinkedList<String> newFileNames,
                          UploadTypeEnum uploadTypeEnum,
                          String... pathOfBizName)

上传文件

参数:

absoluteFilePaths - 源文件对象

newFileNames - 新文件名

uploadTypeEnum - 上传文件类型

pathOfBizName - 上传文件路径|业务模块路径

返回:

上传后文件路径

从以下版本开始:

1.1.0.211021

downloadToResponse

void downloadToResponse(String ossFilePath,
                        javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws IOException

下载文件至 HttpServletResponse

参数:

ossFilePath - OSS文件路径

request - HttpServletRequest

response - HttpServletResponse

抛出:

IOException - 获取文件流异常

从以下版本开始:

1.1.0.211021

downloadToResponse

void downloadToResponse(String ossFilePath,
                        @Nullable
                        String fileName,
                        javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws IOException

下载文件至 HttpServletResponse

参数:

ossFilePath - OSS文件路径

fileName - 新文件名称, 为空时则为OSS文件名

request - HttpServletRequest

response - HttpServletResponse

抛出:

IOException - 获取文件流异常

从以下版本开始:

1.1.0.211021

downloadToFile

File downloadToFile(String ossFilePath)

下载文件至 File 对象

参数:

ossFilePath - OSS文件路径

返回:

File对象

从以下版本开始:

1.1.0.211021

downloadToFile

File downloadToFile(String ossFilePath,
                    @Nullable
                    String fileName)

下载文件至 File 对象

参数:

ossFilePath - OSS文件路径

fileName - 新文件名称, 为空时则为OSS文件名

返回:

File对象

从以下版本开始:

1.1.0.211021

downloadToFile

File downloadToFile(String ossFilePath,
                    @Nullable
                    File file)

下载文件至 File 对象

参数:

ossFilePath - OSS文件路径

file - 新文件对象, 为空时则文件名为OSS文件名

返回:

File对象

从以下版本开始:

1.1.0.211021

deleteObject

void deleteObject(String ossFilePath)

删除文件

参数:

ossFilePath - OSS文件路径

从以下版本开始:

1.1.0.211021

deleteObject

List<String> deleteObject(Collection<String> ossFilePaths)

删除文件

参数:

ossFilePaths - OSS文件路径

返回:

删除成功的文件路径集合

从以下版本开始:

1.1.0.211021

deleteObject

List<String> deleteObject(Collection<String> ossFilePaths,
                          boolean quiet)

删除文件

参数:

ossFilePaths - OSS文件路径

quiet - 返回模式 [default: false-详细模式, {true: 简单模式(删除失败的文件路径集合), false: 详细模式(删除成功的文件路径集合)}]

返回:

返回结果参考 quiet 形参注释

从以下版本开始:

1.1.0.211021