com.pig4cloud.pigx.common.file.oss.service

类 OssTemplate

java.lang.Object

com.pig4cloud.pigx.common.file.oss.service.OssTemplate

所有已实现的接口:

FileTemplate, org.springframework.beans.factory.InitializingBean

public class OssTemplate
extends java.lang.Object
implements org.springframework.beans.factory.InitializingBean, FileTemplate

aws-s3 通用存储操作 支持所有兼容s3协议的云存储: {阿里云OSS，腾讯云COS，七牛云，京东云，minio 等}

从以下版本开始:

1.0

作者:

lengleng, 858695266

字段概要

字段

限定符和类型	字段和说明
private com.amazonaws.services.s3.AmazonS3	amazonS3
private FileProperties	properties

构造器概要

构造器

构造器和说明
OssTemplate()

方法概要

限定符和类型	方法和说明
void	afterPropertiesSet()
void	createBucket(java.lang.String bucketName) 创建bucket
java.util.List<com.amazonaws.services.s3.model.Bucket>	getAllBuckets() 获取全部bucket
java.util.List<com.amazonaws.services.s3.model.S3ObjectSummary>	getAllObjectsByPrefix(java.lang.String bucketName, java.lang.String prefix, boolean recursive) 根据文件前置查询文件
java.util.Optional<com.amazonaws.services.s3.model.Bucket>	getBucket(java.lang.String bucketName)
com.amazonaws.services.s3.model.S3Object	getObject(java.lang.String bucketName, java.lang.String objectName) 获取文件
com.amazonaws.services.s3.model.S3Object	getObjectInfo(java.lang.String bucketName, java.lang.String objectName) 获取文件信息
java.lang.String	getObjectURL(java.lang.String bucketName, java.lang.String objectName, java.lang.Integer expires) 获取文件外链
void	putObject(java.lang.String bucketName, java.lang.String objectName, java.io.InputStream stream) 上传文件
com.amazonaws.services.s3.model.PutObjectResult	putObject(java.lang.String bucketName, java.lang.String objectName, java.io.InputStream stream, long size, java.lang.String contextType) 上传文件
void	putObject(java.lang.String bucketName, java.lang.String objectName, java.io.InputStream stream, java.lang.String contextType) 上传文件
void	removeBucket(java.lang.String bucketName)
void	removeObject(java.lang.String bucketName, java.lang.String objectName) 删除文件

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

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

字段详细资料

properties

private final FileProperties properties

amazonS3

private com.amazonaws.services.s3.AmazonS3 amazonS3

构造器详细资料

OssTemplate

public OssTemplate()

方法详细资料

createBucket

public void createBucket(java.lang.String bucketName)

创建bucket

指定者:

createBucket 在接口中 FileTemplate

参数:

bucketName - bucket名称

getAllBuckets

public java.util.List<com.amazonaws.services.s3.model.Bucket> getAllBuckets()

获取全部bucket

指定者:

getAllBuckets 在接口中 FileTemplate

另请参阅:

AWS API Documentation

getBucket

public java.util.Optional<com.amazonaws.services.s3.model.Bucket> getBucket(java.lang.String bucketName)

参数:

bucketName - bucket名称

另请参阅:

AWS API Documentation

removeBucket

public void removeBucket(java.lang.String bucketName)

指定者:

removeBucket 在接口中 FileTemplate

参数:

bucketName - bucket名称

另请参阅:

AWS API Documentation

getAllObjectsByPrefix

public java.util.List<com.amazonaws.services.s3.model.S3ObjectSummary> getAllObjectsByPrefix(java.lang.String bucketName,
                                                                                             java.lang.String prefix,
                                                                                             boolean recursive)

根据文件前置查询文件

指定者:

getAllObjectsByPrefix 在接口中 FileTemplate

参数:

bucketName - bucket名称

prefix - 前缀

recursive - 是否递归查询

返回:

S3ObjectSummary 列表

另请参阅:

AWS API Documentation

getObjectURL

public java.lang.String getObjectURL(java.lang.String bucketName,
                                     java.lang.String objectName,
                                     java.lang.Integer expires)

获取文件外链

参数:

bucketName - bucket名称

objectName - 文件名称

expires - 过期时间 <=7

返回:

url

另请参阅:

AmazonS3.generatePresignedUrl(String bucketName, String key, Date expiration)

getObject

public com.amazonaws.services.s3.model.S3Object getObject(java.lang.String bucketName,
                                                          java.lang.String objectName)

获取文件

指定者:

getObject 在接口中 FileTemplate

参数:

bucketName - bucket名称

objectName - 文件名称

返回:

二进制流

另请参阅:

AWS API Documentation

putObject

public void putObject(java.lang.String bucketName,
                      java.lang.String objectName,
                      java.io.InputStream stream)
               throws java.lang.Exception

上传文件

指定者:

putObject 在接口中 FileTemplate

参数:

bucketName - bucket名称

objectName - 文件名称

stream - 文件流

抛出:

java.lang.Exception

putObject

public void putObject(java.lang.String bucketName,
                      java.lang.String objectName,
                      java.io.InputStream stream,
                      java.lang.String contextType)
               throws java.lang.Exception

上传文件

指定者:

putObject 在接口中 FileTemplate

参数:

bucketName - bucket名称

objectName - 文件名称

stream - 文件流

contextType - 文件类型

抛出:

java.lang.Exception

putObject

public com.amazonaws.services.s3.model.PutObjectResult putObject(java.lang.String bucketName,
                                                                 java.lang.String objectName,
                                                                 java.io.InputStream stream,
                                                                 long size,
                                                                 java.lang.String contextType)
                                                          throws java.lang.Exception

上传文件

参数:

bucketName - bucket名称

objectName - 文件名称

stream - 文件流

size - 大小

contextType - 类型

抛出:

java.lang.Exception

另请参阅:

AWS API Documentation

getObjectInfo

public com.amazonaws.services.s3.model.S3Object getObjectInfo(java.lang.String bucketName,
                                                              java.lang.String objectName)
                                                       throws java.lang.Exception

获取文件信息

参数:

bucketName - bucket名称

objectName - 文件名称

抛出:

java.lang.Exception

另请参阅:

AWS API Documentation

removeObject

public void removeObject(java.lang.String bucketName,
                         java.lang.String objectName)
                  throws java.lang.Exception

删除文件

指定者:

removeObject 在接口中 FileTemplate

参数:

bucketName - bucket名称

objectName - 文件名称

抛出:

java.lang.Exception

另请参阅:

AWS API Documentation

afterPropertiesSet

public void afterPropertiesSet()

指定者:

afterPropertiesSet 在接口中 FileTemplate

指定者:

afterPropertiesSet 在接口中 org.springframework.beans.factory.InitializingBean