com.github.guang19.cosservice.template.objecttemplate.BaseAliyunOSSObjectTemplate Maven / Gradle / Ivy
package com.github.guang19.cosservice.template.objecttemplate;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClient;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.DeleteObjectsRequest;
import com.aliyun.oss.model.ListObjectsRequest;
import com.aliyun.oss.model.ObjectListing;
import com.aliyun.oss.model.ObjectMetadata;
import com.github.guang19.cosservice.config.AliyunOSSClientProperties;
import com.github.guang19.cosservice.template.buckettemplate.BaseAliyunOSSBucketTemplate;
import com.github.guang19.cosservice.util.COSUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.InputStream;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
/**
* @author yangguang
* @date 2020/2/7
* @description 阿里云OSS基础操作模板
*/
public abstract class BaseAliyunOSSObjectTemplate implements AliyunOSSObjectTemplate
{
//阿里云COS客户端属性
private final AliyunOSSClientProperties ossClientProperties;
//阿里云OSS客户端
protected final OSS ossClient;
//当前模板endpoint
private final String endpoint;
//当前模板的自定义域名
private final String cname;
//当前模板存储桶
private String objectTemplateBucket;
//图片上传时的样式
private String uploadImgStyle;
//logger
protected final Logger logger = LoggerFactory.getLogger(BaseAliyunOSSBucketTemplate.class);
/**
* 阿里云OSS客户端属性构造
* @param ossClientProperties OSS客户端属性
*/
protected BaseAliyunOSSObjectTemplate(AliyunOSSClientProperties ossClientProperties)
{
this.ossClientProperties = ossClientProperties;
this.endpoint = ossClientProperties.getEndpoint();
this.cname = ossClientProperties.getCname();
this.objectTemplateBucket = ossClientProperties.getObjectTemplateBucket();
this.uploadImgStyle = ossClientProperties.getUploadImgStyle();
this.ossClient = new OSSClient(cname != null ? cname : endpoint, ossClientProperties.getCredentialsProvider(),
COSUtil.newAliyunOSSClientConfig(ossClientProperties));
}
/**
*
* 获取当前存储桶下的所有对象的key,返回的对象包括目录和文件
* 返回的对象数量限制为1000
*
*
* @return 对象key集合
*/
@Override
public List getAllObjects()
{
return getAllObjectsWithKeyPrefix("");
}
/**
*
* 查询拥有相同前缀key的所有对象的key,返回的对象包括目录和文件
*
*
* @param keyPrefix 对象key前缀,如: img/ , file/upload/ , file/img/upload , file/img/upload/jquery.js(如果keyPrefix为文件,那么仅仅会返回这个文件)
* @return 对象key集合
*/
@Override
public List getAllObjectsWithKeyPrefix(String keyPrefix)
{
COSUtil.assertObjectNull(keyPrefix);
ListObjectsRequest listObjectsRequest = new ListObjectsRequest();
listObjectsRequest.setBucketName(objectTemplateBucket);
listObjectsRequest.setPrefix(keyPrefix);
listObjectsRequest.setDelimiter("");
listObjectsRequest.setMaxKeys(1000);
List keys = new LinkedList<>();
ObjectListing objectListing = null;
String nextMarker = null;
try
{
do
{
objectListing = ossClient.listObjects(listObjectsRequest);
objectListing.getObjectSummaries().forEach(ossObjectSummary -> keys.add(ossObjectSummary.getKey()));
nextMarker = objectListing.getNextMarker();
listObjectsRequest.setMarker(nextMarker);
} while (objectListing.isTruncated());
}
catch (OSSException e)
{
logger.error("error during cos client batch get object : ".concat(COSUtil.parseAliyunErrorMessage(e)));
}
return keys;
}
/**
*
* 获取当前存储桶下的所有文件名
*
*
* @return 文件名集合
*/
@Override
public List getAllFileNames()
{
return getAllFileNamesWithKeyPrefix("");
}
/**
*
* 查询拥有相同前缀key的所有文件名
*
*
* @param keyPrefix 文件key前缀,如: img/ , file/upload/ , file/img/upload , file/img/upload/jquery.js(如果keyPrefix为文件,那么仅仅会返回这个文件)
* @return 文件名集合
*/
@Override
public List getAllFileNamesWithKeyPrefix(String keyPrefix)
{
return getAllObjectsWithKeyPrefix(keyPrefix)
.parallelStream()
.filter(key -> !key.endsWith("/"))
.map(key ->
{
String[] splitArr = key.split("/");
return splitArr[splitArr.length - 1];
})
.collect(Collectors.toList());
}
/**
* 获取所有文件的key
*
* @return 文件key集合 ： img/a.jpg , img/a/b/c.jpg , d.jpg
*/
@Override
public List getAllFileKeys()
{
return getAllObjectsWithKeyPrefix("")
.stream()
.filter(key -> !key.endsWith("/"))
.collect(Collectors.toList());
}
/**
* 获取对象的元信息
*
* @param key 对象key
* @return 对象元信息键值对
*
* ETag: xxxxxxxxxxxxxxxxxx
* Connection: keep-alive
* x-cos-request-id:xxxxxxxxxxxxxxxxxxxx
* Last-Modified :Wed Sep 25 16:22:02 CST 2019
* Content-Length :1024
* Date :Tue, 04 Feb 2020 05:03:03 GMT
* Content-Type :image/png
*
*/
@Override
public Map getObjectMetaData(String key)
{
COSUtil.assertObjectNull(key);
Map metadata = null;
try
{
ObjectMetadata objectMetadata = ossClient.getObjectMetadata(objectTemplateBucket, key);
if(objectMetadata != null)
{
metadata = objectMetadata.getRawMetadata();
}
}catch (OSSException e)
{
logger.error("error during get object metadata : ".concat(COSUtil.parseAliyunErrorMessage(e)));
}
return metadata;
}
/**
* 根据对象key删除当前存储桶下的对象
*
* @param key 对象的key
*/
@Override
public void deleteObjectWithKey(String key)
{
COSUtil.assertObjectNull(key);
try
{
ossClient.deleteObject(objectTemplateBucket,key);
}
catch (OSSException e)
{
logger.error("error during delete object : ".concat(COSUtil.parseAliyunErrorMessage(e)));
}
finally
{
close();
}
}
/**
* 根据对象键集合,批量删除当前存储桶下的对象
*
* @param keys 对象键集合
*/
@Override
public void deleteObjectsWithKeys(List keys)
{
COSUtil.assertListEmpty(keys);
DeleteObjectsRequest deleteObjectsRequest = new DeleteObjectsRequest(objectTemplateBucket).withKeys(keys);
try
{
ossClient.deleteObjects(deleteObjectsRequest);
}
catch (OSSException e)
{
logger.error("error during cos client batch delete object : ".concat(e.getMessage()));
}
finally
{
close();
}
}
/**
* 根据url删除当前存储桶对象
*
* @param url 对象的url
*/
@Override
public void deleteObjectWithUrl(String url)
{
COSUtil.assertObjectNull(url);
String domainPrefix = COSUtil.getAliyunObjectUrlPrefix(objectTemplateBucket,endpoint,cname);
if(!url.startsWith(domainPrefix))
{
throw new IllegalArgumentException("url must be aliyun url");
}
else
{
deleteObjectWithKey(url.replace(domainPrefix,""));
}
}
/**
* 根据url集合,批量删除当前存储桶对象
*
* @param urls url集合
*/
@Override
public void deleteObjectsWithUrls(List urls)
{
COSUtil.assertListEmpty(urls);
String domainPrefix = COSUtil.getAliyunObjectUrlPrefix(objectTemplateBucket,endpoint,cname);
deleteObjectsWithKeys(urls.stream().filter(url -> url.startsWith(domainPrefix)).map(url -> url.replace(domainPrefix,"")).collect(Collectors.toList()));
}
/**
* 上传文件到存储桶的默认目录,注意,是文件路径,不是目录
*
* @param filePath 本地文件路径
* @return 上传成功后, 对象的url
*/
@Override
public String uploadFile(String filePath)
{
throw new UnsupportedOperationException("can not upload file with base template");
}
/**
* 上传文件到存储桶
*
* @param cosDir 需要将对象上传到存储桶的哪个目录,必须以 '/' 结尾,允许空串
* @param filePath 本地文件路径
* @return 上传成功后, 对象的url
*/
@Override
public String uploadFile(String cosDir, String filePath)
{
throw new UnsupportedOperationException("can not upload file with base template");
}
/**
* 上传对象到存储桶的默认目录
*
* @param fileStream 对象的输入流
* @param objectName 指定上传后的对象名,但不需要指定后缀,如: a.jpg, a , b.jpg , b , cat 都行
* @return 上传成功后, 对象的url
*/
@Override
public String uploadFile(InputStream fileStream, String objectName)
{
throw new UnsupportedOperationException("can not upload file with base template");
}
/**
* 上传对象到存储桶
*
* @param fileStream 对象的输入流
* @param cosDir 需要将对象上传到存储桶的哪个目录,必须以 '/' 结尾,允许空串
* @param objectName 对象名,但不需要指定后缀,如: a.jpg, a , b.jpg , b , cat 都行
* @return 上传成功后, 对象的url
*/
@Override
public String uploadFile(InputStream fileStream, String cosDir, String objectName)
{
throw new UnsupportedOperationException("can not upload file with base template");
}
/**
* 下载文件到本地
*
* @param key 文件的key
* @param saveFile 指定下载后的文件,这个文件不需要存在
* 比如你需要下载的文件key为: img/a.jpg,
*
* 那么你可以指定filepath为 :
*
* a.jpg
*
* b.jpg")
*
* /usr/dir/img.jpg
*
*
无需指定下载的文件类型
* /usr/dir/a
*
* G:/dir/b
*/
@Override
public void downloadFile(String key, String saveFile)
{
throw new UnsupportedOperationException("can not download file with base template");
}
/**
*
* 把当前存储桶下的所有文件都下载到本地
* 此方法的耗时取决于当前存储桶的文件数量和文件大小
*
*
* @param saveDir 指定本地目录
*/
@Override
public void downloadAllFiles(String saveDir)
{
throw new UnsupportedOperationException("can not download file with base template");
}
/**
* 关闭cos客户端连接
*/
@Override
public void close()
{
ossClient.shutdown();
}
/**
* 获取当前模板的存储桶
* @return 存储桶
*/
public String getObjectTemplateBucket()
{
return objectTemplateBucket;
}
/**
* 设置当前模板的存储桶
* @param objectTemplateBucket 存储桶
*/
public void setObjectTemplateBucket(String objectTemplateBucket)
{
COSUtil.assertObjectNull(objectTemplateBucket);
this.objectTemplateBucket = objectTemplateBucket;
}
/**
* 获取图片上传时的样式
* @return 图片上传时的样式
*/
public String getUploadImgStyle()
{
return uploadImgStyle;
}
/**
* 设置图片上传时的样式
* @param uploadImgStyle 图片上传时的样式
*/
public void setUploadImgStyle(String uploadImgStyle)
{
this.uploadImgStyle = uploadImgStyle;
}
/**
* 获取对象对外访问的域名
* @return 对象对外访问的域名
*/
public String getEndpoint()
{
return endpoint;
}
/**
* 获取自定义域名
* @return 自定义域名
*/
public String getCname()
{
return cname;
}
/**
* 获取上传对象的大小限制
* @return 上传对象的大小限制
*/
public int getUploadLimitSize()
{
return ossClientProperties.getUploadLimitSize();
}
/**
* 根据对象键生成对象url
* @param objectKey 对象键
* @return 对象url
*/
protected String getObjectUrl(String objectKey)
{
return COSUtil.getAliyunObjectUrl(objectTemplateBucket,endpoint,cname,null,objectKey);
}
/**
* 根据图片对象键生成对象url
* @param objectKey 对象键
* @return 对象url
*/
protected String getImgObjectUrl(String objectKey)
{
return COSUtil.getAliyunObjectUrl(objectTemplateBucket,endpoint,cname,uploadImgStyle,objectKey);
}
}