cn.novelweb.tool.upload.qcloud

类 CosUpload

java.lang.Object

cn.novelweb.tool.upload.qcloud.CosUpload

public class CosUpload
extends Object

腾讯云上传

2019-11-23 15:47

作者:

Dai Yuanchuan

字段概要

字段

限定符和类型	字段和说明
static String[]	allowActions 使用临时密钥时需要指定 临时密钥允许操作的权限列表 简单上传、表单上传和分片上传需要以下的权限 其他权限参考 //cloud.tencent.com/document/product/436/31923
static String	bucket 存储桶的名称 如 qcloud-1256166828 在存储桶列表中的所属地域查看 存储桶名称格式：BucketName-APPID
static com.qcloud.cos.region.Region	regionName cos 地区 regionName = new com.qcloud.cos.region.Region("ap-shanghai"); 可用区域简称 Region 参考下表 地域 地域简称 北京一区(华北) ap-beijing-1 北京 ap-beijing 上海(华东) ap-shanghai 广州(华南) ap-guangzhou 成都(西南) ap-chengdu 重庆 ap-chongqing 香港 ap-hongkong 新加坡 ap-singapore 多伦多 na-toronto 法兰克福 eu-frankfurt 孟买 ap-mumbai 首尔 ap-seoul 硅谷 na-siliconvalley 弗吉尼亚 na-ashburn 曼谷 ap-bangkok 莫斯科 eu-moscow
static String	secretId 腾讯云secretId信息
static String	secretKey 腾讯云secretKey信息

构造器概要

构造器

构造器和说明
CosUpload()

方法概要

限定符和类型	方法和说明
static com.qcloud.cos.model.Bucket	createBucket(String regionName, String bucket, com.qcloud.cos.model.CannedAccessControlList controlList) 创建存储桶 用户确定地域和存储桶名称后，即可创建存储桶 创建存储桶需要使用永久密钥初始化的COSClient
static boolean	delete(com.qcloud.cos.COSClient cosClient, String... key) 删除多个对象 删除多个指定的对象
static boolean	delete(com.qcloud.cos.COSClient cosClient, String key) 删除单个指定的对象
static boolean	delete(com.qcloud.cos.COSClient cosClient, String bucketName, String... key) 指定存储桶删除多个对象 删除多个指定的对象
static boolean	delete(com.qcloud.cos.COSClient cosClient, String key, String bucketName) 删除单个指定的对象 指定删除存储桶下指定的对象
static com.qcloud.cos.model.ObjectMetadata	download(com.qcloud.cos.COSClient cosClient, File file, String key) 下载对象 下载对象到本地
static List<com.qcloud.cos.model.Bucket>	getBucketList() 查询存储桶列表 查询用户的存储桶列表
static List<com.qcloud.cos.model.Bucket>	getBucketList(com.qcloud.cos.COSClient cosClient) 查询存储桶列表 查询用户的存储桶列表 使用自定义的cos客户端
static void	getFilesList(com.qcloud.cos.COSClient cosClient, String prefix, String delimiter, int maxKeys, ListObjectCompletionHandler handler) 查询存储桶中的文件列表 查询存储桶下的部分或者全部对象
static com.qcloud.cos.COSClient	initCosClient() 使用 永久密钥 初始化 COSClient
static com.qcloud.cos.COSClient	initCosClient(com.qcloud.cos.ClientConfig clientConfig) 使用自定义的 ClientConfig 类 使用 永久密钥 初始化 COSClient
static com.qcloud.cos.model.PutObjectResult	mkdir(com.qcloud.cos.COSClient cosClient, String key) 创建目录 创建目录 实际上就是创建一个 以 / 为结尾的空文件
static com.qcloud.cos.model.PutObjectResult	uploader(com.qcloud.cos.COSClient cosClient, File file, String key) 简单的将本地文件上传到COS 适用于20M以下图片类小文件上传，最大支持上传不超过5GB文件 若 COS 上已存在同样 Key 的对象，上传时则会覆盖旧的对象。
static com.qcloud.cos.transfer.Upload	uploader(com.qcloud.cos.COSClient cosClient, File file, String key, int threadSize) 上传对象 上传接口根据用户文件的长度，自动选择简单上传以及分块上传 用户不用关心分块上传的每个步骤。
static com.qcloud.cos.model.PutObjectResult	uploader(com.qcloud.cos.COSClient cosClient, InputStream cosFile, String key, String contentType) 简单的从输入流上传(需提前告知输入流的长度, 否则可能导致 oom) 适用于20M以下图片类小文件上传，最大支持上传不超过5GB文件 若 COS 上已存在同样 Key 的对象，上传时则会覆盖旧的对象。

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

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

字段详细资料

secretId

public static String secretId

腾讯云secretId信息

secretKey

public static String secretKey

腾讯云secretKey信息

bucket

public static String bucket

存储桶的名称 如 qcloud-1256166828 在存储桶列表中的所属地域查看 存储桶名称格式：BucketName-APPID

regionName

public static com.qcloud.cos.region.Region regionName

cos 地区 regionName = new com.qcloud.cos.region.Region("ap-shanghai"); 可用区域简称 Region 参考下表 地域 地域简称 北京一区(华北) ap-beijing-1 北京 ap-beijing 上海(华东) ap-shanghai 广州(华南) ap-guangzhou 成都(西南) ap-chengdu 重庆 ap-chongqing 香港 ap-hongkong 新加坡 ap-singapore 多伦多 na-toronto 法兰克福 eu-frankfurt 孟买 ap-mumbai 首尔 ap-seoul 硅谷 na-siliconvalley 弗吉尼亚 na-ashburn 曼谷 ap-bangkok 莫斯科 eu-moscow

allowActions

public static String[] allowActions

使用临时密钥时需要指定 临时密钥允许操作的权限列表 简单上传、表单上传和分片上传需要以下的权限 其他权限参考 //cloud.tencent.com/document/product/436/31923

构造器详细资料

CosUpload

public CosUpload()

方法详细资料

initCosClient

public static com.qcloud.cos.COSClient initCosClient()

使用 永久密钥 初始化 COSClient

返回:

返回 永久密钥 COSClient 对象

initCosClient

public static com.qcloud.cos.COSClient initCosClient(com.qcloud.cos.ClientConfig clientConfig)

使用自定义的 ClientConfig 类 使用 永久密钥 初始化 COSClient

参数:

clientConfig - 自定义的 ClientConfig 类 参考:https://cloud.tencent.com/document/product/436/10199

返回:

返回 永久密钥 COSClient 对象

createBucket

public static com.qcloud.cos.model.Bucket createBucket(String regionName,
                                                       String bucket,
                                                       com.qcloud.cos.model.CannedAccessControlList controlList)

创建存储桶 用户确定地域和存储桶名称后，即可创建存储桶 创建存储桶需要使用永久密钥初始化的COSClient

参数:

regionName - cos 地区,定义你要在哪创建这个存储桶 "ap-shanghai"

bucket - 需要创建的存储桶名称,格式：BucketName-APPID

controlList - 存储桶 bucket 的权限 PublicRead(公有读私有写), 其他可选有私有读写, 公有读写

返回:

返回存储桶对象

getBucketList

public static List<com.qcloud.cos.model.Bucket> getBucketList()

查询存储桶列表 查询用户的存储桶列表

返回:

存储桶列表

getBucketList

public static List<com.qcloud.cos.model.Bucket> getBucketList(com.qcloud.cos.COSClient cosClient)

查询存储桶列表 查询用户的存储桶列表 使用自定义的cos客户端

参数:

cosClient - 自定义的cos客户端

返回:

存储桶列表

mkdir

public static com.qcloud.cos.model.PutObjectResult mkdir(com.qcloud.cos.COSClient cosClient,
                                                         String key)

创建目录 创建目录 实际上就是创建一个 以 / 为结尾的空文件

参数:

cosClient - cos 客户端

key - 目录的名称

返回:

返回创建目录的请求结果

uploader

public static com.qcloud.cos.model.PutObjectResult uploader(com.qcloud.cos.COSClient cosClient,
                                                            File file,
                                                            String key)

简单的将本地文件上传到COS 适用于20M以下图片类小文件上传，最大支持上传不超过5GB文件 若 COS 上已存在同样 Key 的对象，上传时则会覆盖旧的对象。

参数:

cosClient - 构建的cos客户端

file - 需要上传的本地文件(小于20M以下)

key - 对象键（Key）是对象在存储桶中的唯一标识

返回:

返回简单上传的请求结果

uploader

public static com.qcloud.cos.model.PutObjectResult uploader(com.qcloud.cos.COSClient cosClient,
                                                            InputStream cosFile,
                                                            String key,
                                                            String contentType)

简单的从输入流上传(需提前告知输入流的长度, 否则可能导致 oom) 适用于20M以下图片类小文件上传，最大支持上传不超过5GB文件 若 COS 上已存在同样 Key 的对象，上传时则会覆盖旧的对象。

参数:

cosClient - 构建的cos客户端

cosFile - 数据流

key - 对象键（Key）是对象在存储桶中的唯一标识

contentType - 设置 Content type, 默认是 application/octet-stream

返回:

返回简单上传的请求结果

uploader

public static com.qcloud.cos.transfer.Upload uploader(com.qcloud.cos.COSClient cosClient,
                                                      File file,
                                                      String key,
                                                      int threadSize)

上传对象 上传接口根据用户文件的长度，自动选择简单上传以及分块上传 用户不用关心分块上传的每个步骤。

参数:

cosClient - 构建的cos客户端

file - 需要上传的本地文件

key - 对象键（Key）是对象在存储桶中的唯一标识

threadSize - 需要构建的线程池大小 建议在客户端与 COS 网络充足的情况下，设置成16或32即可 对于使用公网传输且网络带宽质量不高的情况，建议减小该值，避免因网速过慢，造成请求超时

返回:

返回 Upload 实例，可以查询上传是否结束，也可同步的等待上传结束。 如果想同步的等待上传结束，则调用 upload.waitForCompletion() 方法

download

public static com.qcloud.cos.model.ObjectMetadata download(com.qcloud.cos.COSClient cosClient,
                                                           File file,
                                                           String key)

下载对象 下载对象到本地

参数:

cosClient - 构建的cos客户端

file - 需要写入到本地的文件

key - 对象键,需要进行下载的对象key值

返回:

返回文件的属性 ObjectMetadata，包含文件的自定义头和 content-type 等属性。

delete

public static boolean delete(com.qcloud.cos.COSClient cosClient,
                             String key)

删除单个指定的对象

参数:

cosClient - 构建的cos客户端

key - 对象键,你需要删除的对象key值

返回:

返回删除状态:true 删除成功 false:删除失败

delete

public static boolean delete(com.qcloud.cos.COSClient cosClient,
                             String key,
                             String bucketName)

删除单个指定的对象 指定删除存储桶下指定的对象

参数:

cosClient - 构建的 cos 客户端

key - 对象键,你需要删除的对象key值

bucketName - 指定存储桶的名称,Bucket 的命名格式为 BucketName-APPID

返回:

返回删除状态:true 删除成功 false:删除失败

delete

public static boolean delete(com.qcloud.cos.COSClient cosClient,
                             String bucketName,
                             String... key)

指定存储桶删除多个对象 删除多个指定的对象

参数:

cosClient - 构建的cos客户端

bucketName - 指定存储桶的名称,Bucket 的命名格式为 BucketName-APPID

key - 对象键数组,你需要删除的对象key值列表,最多一次删除1000个

返回:

返回删除状态:true 删除成功 false:删除失败

delete

public static boolean delete(com.qcloud.cos.COSClient cosClient,
                             String... key)

删除多个对象 删除多个指定的对象

参数:

cosClient - 构建的cos客户端

key - 对象键数组,你需要删除的对象key值列表,最多一次删除1000个

返回:

返回删除状态:true 删除成功 false:删除失败

getFilesList

public static void getFilesList(com.qcloud.cos.COSClient cosClient,
                                String prefix,
                                String delimiter,
                                int maxKeys,
                                ListObjectCompletionHandler handler)

查询存储桶中的文件列表 查询存储桶下的部分或者全部对象

参数:

cosClient - COS客户端

prefix - 你需要列出的目录前缀 如:images/ 表示列出的object的key以images/开始

delimiter - 表示分隔符,设置为/表示列出当前目录下的object,设置为空表示列出所有的object

maxKeys - 设置最大遍历出多少个对象,一次listObject最大支持1000

handler - 获取完成后的回调接口