pro.haichuang.framework.sdk.aliyunoss.util

类 AliYunOssUtils

java.lang.Object

pro.haichuang.framework.sdk.aliyunoss.util.AliYunOssUtils

public class AliYunOssUtils
extends Object

阿里云OSS工具类

该类为 aliyunoss 相关操作工具类, 提供了对 aliyunoss 相关操作的封装

从以下版本开始:

1.0.0

版本:

1.0.0

作者:

JiYinchuan

构造器概要

构造器

构造器和说明
AliYunOssUtils()

方法概要

限定符和类型	方法和说明
static List<String>	baseFileUploadByMultipart(Collection<org.springframework.web.multipart.MultipartFile> files, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 上传文件
static List<String>	baseFileUploadByMultipart(LinkedList<org.springframework.web.multipart.MultipartFile> uploadFiles, LinkedList<String> newFileNames, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 上传文件
static List<String>	deleteObject(Collection<String> ossFilePaths, boolean quiet, String accessKeyId, String accessKeySecret, String bucketName, String endPoint) 批量删除文件
static List<String>	deleteObject(Collection<String> ossFilePaths, String accessKeyId, String accessKeySecret, String bucketName, String endPoint) 批量删除文件
static void	deleteObject(String ossFilePath, String accessKeyId, String accessKeySecret, String bucketName, String endPoint) 删除文件
static File	downloadToFile(String ossFilePath, String accessKeyId, String accessKeySecret, String bucketName, String endPoint) 下载文件至 File 对象
static File	downloadToFile(String ossFilePath, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, File outFile) 下载文件至 File 对象
static File	downloadToFile(String ossFilePath, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileName) 下载文件至 File 对象
static void	downloadToResponse(String ossFilePath, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 下载文件至 HttpServletResponse
static void	downloadToResponse(String ossFilePath, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 下载文件至 HttpServletResponse
static List<String>	uploadByFile(Collection<File> uploadFiles, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 批量上传文件
static String	uploadByFile(File uploadFile, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 简单上传文件
static String	uploadByFile(File uploadFile, String newFileName, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 简单上传文件
static List<String>	uploadByFile(LinkedList<File> uploadFiles, LinkedList<String> newFileNames, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 批量上传文件
static List<String>	uploadByMultipart(Collection<org.springframework.web.multipart.MultipartFile> uploadFiles, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 批量上传文件
static List<String>	uploadByMultipart(LinkedList<org.springframework.web.multipart.MultipartFile> uploadFiles, LinkedList<String> newFileNames, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 批量上传文件
static String	uploadByMultipart(org.springframework.web.multipart.MultipartFile uploadFile, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 简单上传文件
static String	uploadByMultipart(org.springframework.web.multipart.MultipartFile uploadFile, String newFileName, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 简单上传文件
static List<String>	uploadByPath(Collection<String> absoluteFilePaths, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 批量上传文件
static List<String>	uploadByPath(LinkedList<String> absoluteFilePaths, LinkedList<String> newFileNames, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 批量上传文件
static String	uploadByPath(String absoluteFilePath, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 简单上传文件
static String	uploadByPath(String absoluteFilePath, String newFileName, String accessKeyId, String accessKeySecret, String bucketName, String endPoint, String fileType, String... uploadPath) 简单上传文件

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

AliYunOssUtils

public AliYunOssUtils()

方法详细资料

uploadByMultipart

public static String uploadByMultipart(org.springframework.web.multipart.MultipartFile uploadFile,
                                       String accessKeyId,
                                       String accessKeySecret,
                                       String bucketName,
                                       String endPoint,
                                       String fileType,
                                       String... uploadPath)
                                throws AliYunOssUploadException,
                                       IOException

简单上传文件

参数:

uploadFile - 源文件对象

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

IOException - 获取文件流异常

从以下版本开始:

1.0.0

另请参阅:

uploadByMultipart(MultipartFile, String, String, String, String, String, String, String...)

uploadByMultipart

public static String uploadByMultipart(org.springframework.web.multipart.MultipartFile uploadFile,
                                       @Nullable
                                       String newFileName,
                                       String accessKeyId,
                                       String accessKeySecret,
                                       String bucketName,
                                       String endPoint,
                                       String fileType,
                                       String... uploadPath)
                                throws AliYunOssUploadException,
                                       IOException

简单上传文件

参数:

uploadFile - 源文件对象

newFileName - 新文件名

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

IOException - 获取文件流异常

从以下版本开始:

1.0.0

另请参阅:

baseFileUploadByMultipart(LinkedList, LinkedList, String, String, String, String, String, String...)

uploadByPath

public static String uploadByPath(String absoluteFilePath,
                                  String accessKeyId,
                                  String accessKeySecret,
                                  String bucketName,
                                  String endPoint,
                                  String fileType,
                                  String... uploadPath)
                           throws AliYunOssUploadException

简单上传文件

参数:

absoluteFilePath - 源文件绝对路径

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

从以下版本开始:

1.0.0

另请参阅:

uploadByPath(String, String, String, String, String, String, String, String...)

uploadByPath

public static String uploadByPath(String absoluteFilePath,
                                  @Nullable
                                  String newFileName,
                                  String accessKeyId,
                                  String accessKeySecret,
                                  String bucketName,
                                  String endPoint,
                                  String fileType,
                                  String... uploadPath)
                           throws AliYunOssUploadException

简单上传文件

参数:

absoluteFilePath - 源文件绝对路径

newFileName - 新文件名

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

从以下版本开始:

1.0.0

另请参阅:

uploadByFile(File, String, String, String, String, String, String, String...)

uploadByFile

public static String uploadByFile(File uploadFile,
                                  String accessKeyId,
                                  String accessKeySecret,
                                  String bucketName,
                                  String endPoint,
                                  String fileType,
                                  String... uploadPath)
                           throws AliYunOssUploadException

简单上传文件

参数:

uploadFile - 源文件对象

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

从以下版本开始:

1.0.0

另请参阅:

uploadByFile(File, String, String, String, String, String, String, String...)

uploadByFile

public static String uploadByFile(File uploadFile,
                                  @Nullable
                                  String newFileName,
                                  String accessKeyId,
                                  String accessKeySecret,
                                  String bucketName,
                                  String endPoint,
                                  String fileType,
                                  String... uploadPath)
                           throws AliYunOssUploadException

简单上传文件

参数:

uploadFile - 源文件对象

newFileName - 新文件名

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

从以下版本开始:

1.0.0

另请参阅:

baseFileUploadByFile(LinkedList, LinkedList, String, String, String, String, String, String...)

uploadByMultipart

public static List<String> uploadByMultipart(Collection<org.springframework.web.multipart.MultipartFile> uploadFiles,
                                             String accessKeyId,
                                             String accessKeySecret,
                                             String bucketName,
                                             String endPoint,
                                             String fileType,
                                             String... uploadPath)
                                      throws AliYunOssUploadException,
                                             IOException

批量上传文件

参数:

uploadFiles - 文件对象集合

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径集合 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

IOException - 获取文件流异常

从以下版本开始:

1.0.0

另请参阅:

uploadByMultipart(LinkedList, LinkedList, String, String, String, String, String, String...)

uploadByMultipart

public static List<String> uploadByMultipart(LinkedList<org.springframework.web.multipart.MultipartFile> uploadFiles,
                                             @Nullable
                                             LinkedList<String> newFileNames,
                                             String accessKeyId,
                                             String accessKeySecret,
                                             String bucketName,
                                             String endPoint,
                                             String fileType,
                                             String... uploadPath)
                                      throws AliYunOssUploadException,
                                             IOException

批量上传文件

参数:

uploadFiles - 文件对象集合

newFileNames - 新文件名

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径集合 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

IOException - 获取文件流异常

从以下版本开始:

1.0.0

另请参阅:

baseFileUploadByMultipart(LinkedList, LinkedList, String, String, String, String, String, String...)

uploadByPath

public static List<String> uploadByPath(Collection<String> absoluteFilePaths,
                                        String accessKeyId,
                                        String accessKeySecret,
                                        String bucketName,
                                        String endPoint,
                                        String fileType,
                                        String... uploadPath)
                                 throws AliYunOssUploadException

批量上传文件

参数:

absoluteFilePaths - 源文件绝对路径集合

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径集合 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

从以下版本开始:

1.0.0

另请参阅:

uploadByPath(LinkedList, LinkedList, String, String, String, String, String, String...)

uploadByPath

public static List<String> uploadByPath(LinkedList<String> absoluteFilePaths,
                                        @Nullable
                                        LinkedList<String> newFileNames,
                                        String accessKeyId,
                                        String accessKeySecret,
                                        String bucketName,
                                        String endPoint,
                                        String fileType,
                                        String... uploadPath)
                                 throws AliYunOssUploadException

批量上传文件

参数:

absoluteFilePaths - 源文件绝对路径集合

newFileNames - 新文件名

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径集合 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

从以下版本开始:

1.0.0

uploadByFile

public static List<String> uploadByFile(Collection<File> uploadFiles,
                                        String accessKeyId,
                                        String accessKeySecret,
                                        String bucketName,
                                        String endPoint,
                                        String fileType,
                                        String... uploadPath)
                                 throws AliYunOssUploadException

批量上传文件

参数:

uploadFiles - 文件对象集合

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径集合 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

从以下版本开始:

1.0.0

另请参阅:

uploadByFile(LinkedList, LinkedList, String, String, String, String, String, String...)

uploadByFile

public static List<String> uploadByFile(LinkedList<File> uploadFiles,
                                        @Nullable
                                        LinkedList<String> newFileNames,
                                        String accessKeyId,
                                        String accessKeySecret,
                                        String bucketName,
                                        String endPoint,
                                        String fileType,
                                        String... uploadPath)
                                 throws AliYunOssUploadException

批量上传文件

参数:

uploadFiles - 文件对象集合

newFileNames - 新文件名

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径集合 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

从以下版本开始:

1.0.0

另请参阅:

baseFileUploadByFile(LinkedList, LinkedList, String, String, String, String, String, String...)

downloadToResponse

public static void downloadToResponse(String ossFilePath,
                                      String accessKeyId,
                                      String accessKeySecret,
                                      String bucketName,
                                      String endPoint,
                                      javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                               throws IOException

下载文件至 HttpServletResponse

参数:

ossFilePath - OSS文件路径

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

request - HttpServletRequest

response - HttpServletResponse

抛出:

IOException - 文件流转文件失败

从以下版本开始:

1.0.0

另请参阅:

downloadToResponse(String, String, String, String, String, String, HttpServletRequest, HttpServletResponse)

downloadToResponse

public static void downloadToResponse(String ossFilePath,
                                      String accessKeyId,
                                      String accessKeySecret,
                                      String bucketName,
                                      String endPoint,
                                      @Nullable
                                      String fileName,
                                      javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                               throws IOException

下载文件至 HttpServletResponse

参数:

ossFilePath - OSS文件路径

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

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

request - HttpServletRequest

response - HttpServletResponse

抛出:

IOException - 文件流转文件失败

从以下版本开始:

1.0.0

downloadToFile

public static File downloadToFile(String ossFilePath,
                                  String accessKeyId,
                                  String accessKeySecret,
                                  String bucketName,
                                  String endPoint)

下载文件至 File 对象

参数:

ossFilePath - OSS文件路径

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

返回:

File对象

从以下版本开始:

1.0.0

另请参阅:

downloadToFile(String, String, String, String, String, String)

downloadToFile

public static File downloadToFile(String ossFilePath,
                                  String accessKeyId,
                                  String accessKeySecret,
                                  String bucketName,
                                  String endPoint,
                                  @Nullable
                                  String fileName)

下载文件至 File 对象

参数:

ossFilePath - OSS文件路径

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

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

返回:

File对象

从以下版本开始:

1.0.0

downloadToFile

public static File downloadToFile(String ossFilePath,
                                  String accessKeyId,
                                  String accessKeySecret,
                                  String bucketName,
                                  String endPoint,
                                  @Nullable
                                  File outFile)

下载文件至 File 对象

参数:

ossFilePath - OSS文件路径

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

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

返回:

File对象

从以下版本开始:

1.0.0

deleteObject

public static void deleteObject(String ossFilePath,
                                String accessKeyId,
                                String accessKeySecret,
                                String bucketName,
                                String endPoint)

删除文件

参数:

ossFilePath - OSS文件路径

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

从以下版本开始:

1.0.0

deleteObject

public static List<String> deleteObject(Collection<String> ossFilePaths,
                                        String accessKeyId,
                                        String accessKeySecret,
                                        String bucketName,
                                        String endPoint)

批量删除文件

参数:

ossFilePaths - OSS文件路径集合

endPoint - Endpoint地域节点

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

返回:

删除成功的文件路径集合

从以下版本开始:

1.0.0

另请参阅:

deleteObject(Collection, boolean, String, String, String, String)

deleteObject

public static List<String> deleteObject(Collection<String> ossFilePaths,
                                        boolean quiet,
                                        String accessKeyId,
                                        String accessKeySecret,
                                        String bucketName,
                                        String endPoint)

批量删除文件

参数:

ossFilePaths - OSS文件路径集合

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

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

返回:

返回结果参考 quiet 形参注释

从以下版本开始:

1.0.0

baseFileUploadByMultipart

public static List<String> baseFileUploadByMultipart(Collection<org.springframework.web.multipart.MultipartFile> files,
                                                     String accessKeyId,
                                                     String accessKeySecret,
                                                     String bucketName,
                                                     String endPoint,
                                                     String fileType,
                                                     String... uploadPath)
                                              throws AliYunOssUploadException,
                                                     IOException

上传文件

参数:

files - 源文件对象集合

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径集合 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

IOException - 获取文件流异常

从以下版本开始:

1.0.0

另请参阅:

baseFileUploadByMultipart(LinkedList, LinkedList, String, String, String, String, String, String...)

baseFileUploadByMultipart

public static List<String> baseFileUploadByMultipart(LinkedList<org.springframework.web.multipart.MultipartFile> uploadFiles,
                                                     @Nullable
                                                     LinkedList<String> newFileNames,
                                                     String accessKeyId,
                                                     String accessKeySecret,
                                                     String bucketName,
                                                     String endPoint,
                                                     String fileType,
                                                     String... uploadPath)
                                              throws AliYunOssUploadException,
                                                     IOException

上传文件

参数:

uploadFiles - 源文件对象集合

newFileNames - 上传文件名称集合

accessKeyId - AccessKeyId

accessKeySecret - AccessKeySecret

bucketName - BucketName

endPoint - Endpoint地域节点

fileType - 上传文件类型

uploadPath - 上传路径

返回:

上传后的路径集合 [上传路径 + 文件类型 + 文件名]

抛出:

AliYunOssUploadException - 阿里云文件上传异常

IOException - 获取文件流异常

从以下版本开始:

1.0.0