一、相关资源
·对象存储(Cloud Object Storage,COS)服务的 XML Java SDK 源码下载地址:XML Java SDK。
·SDK 快速下载地址:XML Java SDK。
·示例 Demo 下载地址:COS XML Java SDK 示例。
·SDK 更新日志请参见 Changelog。
·SDK 常见问题请参见:Java SDK 常见问题。
注意:说明:
二、环境配置
·SDK 支持 JDK 1.8 及以上版本,你可以通过命令 java -version 查看 Java 版本。
·JDK 安装方式请参见 Java 安装与配置。
注意:说明:
三、环境准备
下面测试中假设你尝试访问广州地域的 COS 服务。
使用 ping 测试使用 curl 测试[root@VM_centos /data/home/]# ping cos.ap-guangzhou.myqcloud.comPING cos.ap-guangzhou.myqcloud.com (9.*.*.*) xx(xx) bytes of data.64 bytes from 9.*.*.* (9.*.*.*): icmp_seq=1 ttl=xx time=0.xxx ms64 bytes from 9.*.*.* (9.*.*.*): icmp_seq=2 ttl=xx time=0.xxx ms64 bytes from 9.*.*.* (9.*.*.*): icmp_seq=3 ttl=xx time=0.xxx ms64 bytes from 9.*.*.* (9.*.*.*): icmp_seq=4 ttl=xx time=0.xxx ms64 bytes from 9.*.*.* (9.*.*.*): icmp_seq=5 ttl=xx time=0.xxx ms64 bytes from 9.*.*.* (9.*.*.*): icmp_seq=6 ttl=xx time=0.xxx ms64 bytes from 9.*.*.* (9.*.*.*): icmp_seq=7 ttl=xx time=0.xxx ms^C— cos.ap-guangzhou.myqcloud.com ping statistics —x packets transmitted, x received, 0% packet loss, time xxxmsrtt min/avg/max/mdev = 0.xxx/0.xxx/0.xxx/0.xxx ms 如果显示类似上面结果,则基本网络连通与名字服务都是正常的。如果返回其他异常结果,请优先排查环境网络问题或者联系本地网络管理员,确认全部正常后,再继续下一步。如果是在 Windows 下,也可以单击开始 (或快捷键:Win+R)> 运行 (输入 cmd)> 确定(或按 Enter 键),输入命令 ping cos.ap-guangzhou.myqcloud.com 并回车进行测试。如果使用 HTTP 访问:[root@VM_centos /data/home/]# curl http://cos.ap-guangzhou.myqcloud.com -v* About to connect() to cos.ap-guangzhou.myqcloud.com port 80 (#0)* Trying 9.*.*.*…* Connected to cos.ap-guangzhou.myqcloud.com (9.*.*.*) port 80 (#0)> GET / HTTP/1.1> User-Agent: curl/*.*.0> Host: cos.ap-guangzhou.myqcloud.com> Accept: */*> < HTTP/1.1 403 Forbidden< Content-Type: application/xml< Content-Length: XXX< Connection: keep-alive< Date: XXX XXX GMT< Server: tencent-cos< x-cos-request-id: NWE2MWQ5MjZfMTBhYzM1MGFfMTA5ODVfMTVj****< <?xml version='1.0' encoding='utf-8' ?><Error> <Code>AccessDenied</Code> <Message>Check auth failure because signature empty.</Message> <ServerTime>XXX XXX</ServerTime> <Resource>cos.ap-guangzhou.myqcloud.com/</Resource> <RequestId>NWE2MWQ5MjZfMTBhYzM1MGFfMTA5ODVfMTVj****==</RequestId> </Error>* Connection #0 to host cos.ap-guangzhou.myqcloud.com left intact如果使用 HTTPS 访问:[root@VM_centos /data/home/]# curl https://cos.ap-guangzhou.myqcloud.com -vk* About to connect() to cos.ap-guangzhou.myqcloud.com port 443 (#0)* Trying 9.*.*.*…* Connected to cos.ap-guangzhou.myqcloud.com (9.*.*.*) port 443 (#0)* Initializing NSS with certpath: XXXX* skipping SSL peer certificate verification* SSL connection using ******* Server certificate:* subject: CN=*.*.*.* start date: XXX XXX GMT* expire date: XXX XXX GMT* common name: *.cos.ap-guangzhou.myqcloud.com* issuer: XXX> GET / HTTP/1.1> User-Agent: curl/*.*.0> Host: cos.ap-guangzhou.myqcloud.com> Accept: */*> < HTTP/1.1 403 Forbidden< Content-Type: application/xml< Content-Length: XXX< Connection: keep-alive< Date: XXX XXX GMT< Server: tencent-cos< x-cos-request-id: NWE2MWQ5MjZfMTBhYzM1MGFfMTA5ODVfMTVj****< <?xml version='1.0' encoding='utf-8' ?><Error> <Code>AccessDenied</Code> <Message>Check auth failure because signature empty.</Message> <ServerTime>XXX XXX</ServerTime> <Resource>cos.ap-guangzhou.myqcloud.com/</Resource> <RequestId>NWE2MWQ5MjZfMTBhYzM1MGFfMTA5ODVfMTVj****</RequestId> </Error>* Connection #0 to host cos.ap-guangzhou.myqcloud.com left intact如果显示类似上面结果,则说明端口连接正常。如果返回其他异常结果,请优先排查环境网络问题或者联系本地网络管理员,确认全部正常后,再继续下一步。在 Windows 环境下,某些版本可能需要额外安装 curl 工具才能测试。
四、安装 SDK
用户可以通过 Maven 和源码两种方式安装 Java SDK。通过删除 pom 依赖或源码即可卸载 SDK。
五、方式一:Maven 安装
在 Maven 工程的 pom.xml 文件中添加相关依赖,内容如下:
<dependency> <groupId>com.qcloud</groupId> <artifactId>cos_api</artifactId> <version>5.6.227</version></dependency>
注意:依赖坐标可能并非最新版本,请 单击此处 获取最新版本。
六、方式二:源码安装
从 GitHub XML Java SDK 或 快速下载地址 下载源码,通过 Maven 导入。例如 Eclipse,依次选择 File > Import > maven > Existing Maven Projects。
七、初始化 COS 服务
下面为你介绍如何使用 COS Java SDK 完成一个基础操作,例如初始化客户端、创建存储桶、查询存储桶列表、上传对象、查询对象列表、下载对象和删除对象。对于示例中出现的类,在 IDE 中,你可以单击该类,查看该类的所有字段和函数定义,类中有较为详细的注释。
八、导入类名
COS Java SDK 的包名为 com.qcloud.cos.*,你可以通过 Eclipse 或者 IntelliJ 等 IDE 工具,导入程序运行所需要的类。
九、初始化客户端
在执行任何和 COS 服务相关请求之前,都需要先生成 COSClient 类的对象, COSClient 是调用 COS API 接口的对象。
临时密钥初始化(推荐)永久密钥初始化(不推荐)若你使用临时密钥初始化 COSClient(推荐),临时密钥生成和使用可参见 临时密钥生成及使用指引,参考示例如下:// 1 传入获取到的临时密钥 (tmpSecretId, tmpSecretKey, sessionToken)String tmpSecretId = "SECRETID";String tmpSecretKey = "SECRETKEY";String sessionToken = "TOKEN";BasicSessionCredentials cred = new BasicSessionCredentials(tmpSecretId, tmpSecretKey, sessionToken);// 2 设置 bucket 的地域// clientConfig 中包含了设置 region, https(默认 http), 超时, 代理等 set 方法, 使用可参见源码或者常见问题 Java SDK 部分Region region = new Region("COS_REGION"); //COS_REGION 参数:配置成存储桶 bucket 的实际地域,例如 ap-beijing,更多 COS 地域的简称请参见 https://cloud.tencent.com/document/product/436/6224ClientConfig clientConfig = new ClientConfig(region);// 3 生成 cos 客户端COSClient cosClient = new COSClient(cred, clientConfig);你也可以使用永久密钥初始化 COSClient(不推荐,有主密钥泄露风险,不建议在生产环境使用),可以先在访问管理控制台中的 API 密钥管理 页面获取 APPId、SecretId、SecretKey,参考示例如下:// 1 初始化用户身份信息(secretId, secretKey)。// SECRETID 和 SECRETKEY 请登录访问管理控制台 https://console.cloud.tencent.com/cam/capi 进行查看和管理String secretId = System.getenv("secretId");//用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140String secretKey = System.getenv("secretKey");//用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140COSCredentials cred = new BasicCOSCredentials(secretId, secretKey);// 2 设置 bucket 的地域, COS 地域的简称请参见 https://cloud.tencent.com/document/product/436/6224// clientConfig 中包含了设置 region, https(默认 http), 超时, 代理等 set 方法, 使用可参见源码或者常见问题 Java SDK 部分。Region region = new Region("COS_REGION");ClientConfig clientConfig = new ClientConfig(region);// 这里建议设置使用 https 协议// 从 5.6.54 版本开始,默认使用了 httpsclientConfig.setHttpProtocol(HttpProtocol.https);// 3 生成 cos 客户端。COSClient cosClient = new COSClient(cred, clientConfig);
ClientConfig 类为配置信息类,主要的成员如下:
| 成员名 | 设置方法 | 描述 | 类型 |
| region | 构造函数或 set 方法 | 存储桶所在的地域,COS 地域的简称请参见 地域和访问域名 文档 | Region |
| httpProtocol | set 方法 | 请求所使用的协议,默认使用 HTTPS 协议与 COS 交互 | HttpProtocol |
| signExpired | set 方法 | 请求签名的有效时间,单位:秒,默认为3600s | long |
| connectionTimeout | set 方法 | 连接 COS 服务的超时时间,单位:毫秒,默认为30000ms | int |
| socketTimeout | set 方法 | 客户端读取数据的超时时间,单位:毫秒,默认为30000ms | int |
| httpProxyIp | set 方法 | 代理服务器的 IP | String |
| httpProxyPort | set 方法 | 代理服务器的端口 | int |
十、访问 COS 服务
创建存储桶查询存储桶列表上传对象查询对象列表下载对象删除对象
用户确定地域和存储桶名称后,参考如下示例创建存储桶。关于创建存储桶的完整示例,请前往 GitHub 查看。import com.qcloud.cos.COSClient;import com.qcloud.cos.ClientConfig;import com.qcloud.cos.auth.BasicCOSCredentials;import com.qcloud.cos.auth.COSCredentials;import com.qcloud.cos.exception.CosClientException;import com.qcloud.cos.exception.CosServiceException;import com.qcloud.cos.model.Bucket;import com.qcloud.cos.model.CannedAccessControlList;import com.qcloud.cos.model.CreateBucketRequest;import com.qcloud.cos.region.Region;public class BucketDemo { private static String secretId = System.getenv("SECRETID"); private static String secretKey = System.getenv("SECRETKEY"); private static String bucketName = System.getenv("BUCKET_NAME"); private static String cosRegion = System.getenv("REGION"); private static COSClient cosClient = createCli(); public static void main(String[] args) { try { createBucketDemo(); //createMAZBucketDemo(); } catch (Exception e) { e.printStackTrace(); } finally { cosClient.shutdown(); } } private static COSClient createCli() { // 1 初始化用户身份信息(secretId, secretKey) COSCredentials cred = new BasicCOSCredentials(secretId, secretKey); // 2 设置 bucket 的区域, COS 地域的简称请参照 https://cloud.tencent.com/document/product/436/6224 ClientConfig clientConfig = new ClientConfig(new Region(cosRegion)); // 3 生成 cos 客户端 COSClient cosclient = new COSClient(cred, clientConfig); return cosclient; } // 创建 bucket private static void createBucketDemo() { CreateBucketRequest createBucketRequest = new CreateBucketRequest(bucketName); // 设置 bucket 的权限为 PublicRead(公有读私有写), 其他可选有私有读写, 公有读私有写 createBucketRequest.setCannedAcl(CannedAccessControlList.PublicRead); Bucket bucket = cosClient.createBucket(createBucketRequest); System.out.println("create bucket, bucketName is " + bucket.getName()); } //创建多 AZ 桶 private static void createMAZBucketDemo() { CreateBucketRequest createBucketRequest = new CreateBucketRequest(bucketName); try { Bucket bucket = cosClient.createMAZBucket(createBucketRequest); System.out.println("create MAZ bucket, bucketName is " + bucket.getName()); } catch (CosServiceException cse) { cse.printStackTrace(); } catch (CosClientException cce) { cce.printStackTrace(); } }}
查询用户的存储桶列表,参考如下示例。关于查询存储桶列表的完整示例,请前往 GitHub 查看。import java.util.ArrayList;import java.util.List;import com.qcloud.cos.COSClient;import com.qcloud.cos.ClientConfig;import com.qcloud.cos.auth.BasicCOSCredentials;import com.qcloud.cos.auth.COSCredentials;import com.qcloud.cos.exception.CosClientException;import com.qcloud.cos.exception.CosServiceException;import com.qcloud.cos.model.Bucket;import com.qcloud.cos.model.ListBucketsRequest;import com.qcloud.cos.model.ListBucketsResult;import com.qcloud.cos.region.Region;public class BucketDemo { private static String secretId = System.getenv("SECRETID"); private static String secretKey = System.getenv("SECRETKEY"); private static String bucketName = System.getenv("BUCKET_NAME"); private static String cosRegion = System.getenv("REGION"); private static COSClient cosClient = createCli(); public static void main(String[] args) { try { listBuckets(); } catch (Exception e) { e.printStackTrace(); } finally { cosClient.shutdown(); } } private static COSClient createCli() { // 1 初始化用户身份信息(secretId, secretKey) COSCredentials cred = new BasicCOSCredentials(secretId, secretKey); // 2 设置 bucket 的区域, COS 地域的简称请参照 https://cloud.tencent.com/document/product/436/6224 ClientConfig clientConfig = new ClientConfig(new Region(cosRegion)); // 3 生成 cos 客户端 COSClient cosclient = new COSClient(cred, clientConfig); return cosclient; } private static void listBuckets() { List<Bucket> buckets = cosClient.listBuckets(); for (Bucket bucket : buckets) { System.out.println(bucket.getName()); System.out.println(bucket.getLocation()); System.out.println(bucket.getOwner()); System.out.println(bucket.getType()); System.out.println(bucket.getBucketType()); } }}
关于上传对象的完整示例,请前往 GitHub 查看。
将本地文件或者已知长度的输入流内容上传到 COS,适用于20M以下图片类小文件上传,最大支持上传不超过5GB文件。5GB以上的文件必须使用分块上传或高级 API 接口上传。
注意:说明:
注意:高级 API 接口在 com.qcloud.cos.transfer.\\* 子包下。
·若本地文件大部分在20M以上,建议你参考使用高级 API 接口进行上传。
·若 COS 上已存在同样 Key 的对象,上传时则会覆盖旧的对象。
·若要创建目录对象,请参见 SDK 如何创建目录。
·对象键(Key)是对象在存储桶中的唯一标识。例如,在对象的访问域名 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/images/picture.jpg 中,对象键为 images/picture.jpg,详情请参见 对象键 的说明。
上传不超过5GB的文件,参考示例如下:
import java.io.File;import com.qcloud.cos.COSClient;import com.qcloud.cos.ClientConfig;import com.qcloud.cos.auth.BasicCOSCredentials;import com.qcloud.cos.auth.COSCredentials;import com.qcloud.cos.exception.CosClientException;import com.qcloud.cos.exception.CosServiceException;import com.qcloud.cos.model.PutObjectRequest;import com.qcloud.cos.model.PutObjectResult;import com.qcloud.cos.region.Region;public class PutObjectDemo { private static String secretId = System.getenv("SECRETID"); private static String secretKey = System.getenv("SECRETKEY"); private static String bucketName = System.getenv("BUCKET_NAME"); private static String region = System.getenv("REGION"); private static COSClient cosClient = createCli(); public static void main(String[] args) { try { putLocalFileDemo(); } catch (Exception e) { e.printStackTrace(); } finally { cosClient.shutdown(); } } private static COSClient createCli() { // 初始化用户身份信息(secretId, secretKey) COSCredentials cred = new BasicCOSCredentials(secretId,secretKey); // 设置 bucket 的区域, COS 地域的简称请参照 https://cloud.tencent.com/document/product/436/6224 ClientConfig clientConfig = new ClientConfig(new Region(region)); // 生成 cos 客户端 return new COSClient(cred, clientConfig); } private static void putLocalFileDemo() { String key = "abc/abc.txt"; String localPath = "abc.txt"; PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, key, new File(localPath)); try { PutObjectResult putObjectResult = cosClient.putObject(putObjectRequest); System.out.println(putObjectResult.getRequestId()); } catch (CosServiceException cse) { cse.printStackTrace(); } catch (CosClientException cce) { cce.printStackTrace(); } }}
查询存储桶中对象列表,参考如下示例。关于查询对象列表的完整示例,请前往 GitHub 查看。import java.util.List;import com.qcloud.cos.COSClient;import com.qcloud.cos.ClientConfig;import com.qcloud.cos.auth.BasicCOSCredentials;import com.qcloud.cos.auth.COSCredentials;import com.qcloud.cos.exception.CosClientException;import com.qcloud.cos.exception.CosServiceException;import com.qcloud.cos.model.COSObjectSummary;import com.qcloud.cos.model.COSVersionSummary;import com.qcloud.cos.model.ListObjectsRequest;import com.qcloud.cos.model.ListVersionsRequest;import com.qcloud.cos.model.ObjectListing;import com.qcloud.cos.model.VersionListing;import com.qcloud.cos.region.Region;public class ListObjectsDemo { private static String secretId = System.getenv("SECRETID"); private static String secretKey = System.getenv("SECRETKEY"); private static String bucketName = System.getenv("BUCKET_NAME"); private static String region = System.getenv("REGION"); private static COSClient cosClient = createClient(); public static void main(String[] args) { try { listObjectsVersions(); //listObjectsDemo(); //listAllObjects(); } catch (Exception e) { e.printStackTrace(); } finally { cosClient.shutdown(); } } private static COSClient createClient() { // 初始化用户身份信息(secretId, secretKey) COSCredentials cred = new BasicCOSCredentials(secretId,secretKey); // 设置 bucket 的区域, COS 地域的简称请参照 https://cloud.tencent.com/document/product/436/6224 ClientConfig clientConfig = new ClientConfig(new Region(region)); // 生成 cos 客户端 COSClient cosclient = new COSClient(cred, clientConfig); return cosclient; } private static void listObjectsDemo() { ListObjectsRequest listObjectsRequest = new ListObjectsRequest(); // 设置 bucket 名称 listObjectsRequest.setBucketName(bucketName); // prefix 表示列出的 object 的 key 以 prefix 开始 listObjectsRequest.setPrefix(""); // 设置最大遍历出多少个对象, 一次 listobject 最大支持1000 listObjectsRequest.setMaxKeys(1000); // listObjectsRequest.setDelimiter("/"); ObjectListing objectListing = null; try { objectListing = cosClient.listObjects(listObjectsRequest); } catch (CosServiceException e) { e.printStackTrace(); } catch (CosClientException e) { e.printStackTrace(); } // common prefix 表示表示被 delimiter 截断的路径, 如 delimter 设置为/, common prefix 则表示所有子目录的路径 List<String> commonPrefixs = objectListing.getCommonPrefixes(); // object summary 表示所有列出的 object 列表 List<COSObjectSummary> cosObjectSummaries = objectListing.getObjectSummaries(); for (COSObjectSummary cosObjectSummary : cosObjectSummaries) { // 文件的路径 key String key = cosObjectSummary.getKey(); // 文件的 etag String etag = cosObjectSummary.getETag(); // 文件的长度 long fileSize = cosObjectSummary.getSize(); // 文件的存储类型 String storageClasses = cosObjectSummary.getStorageClass(); System.out.println("key: " + key); } } // 如果要获取超过 maxkey数量的 object 或者获取所有的 object, 则需要循环调用 listobject, 用上一次返回的 next marker 作为下一次调用的 marker, // 直到返回的 truncated 为 false private static void listAllObjects() { ListObjectsRequest listObjectsRequest = new ListObjectsRequest(); // 设置 bucket 名称 listObjectsRequest.setBucketName(bucketName); // prefix 表示列出的 object 的 key 以 prefix 开始 listObjectsRequest.setPrefix(""); // deliter 表示分隔符, 设置为/表示列出当前目录下的 object, 设置为空表示列出所有的 object listObjectsRequest.setDelimiter(""); // 设置最大遍历出多少个对象, 一次 listobject 最大支持1000 listObjectsRequest.setMaxKeys(1000); ObjectListing objectListing = null; do { try { objectListing = cosClient.listObjects(listObjectsRequest); } catch (CosServiceException e) { e.printStackTrace(); return; } catch (CosClientException e) { e.printStackTrace(); return; } // common prefix 表示表示被 delimiter 截断的路径, 如 delimter 设置为/, common prefix 则表示所有子目录的路径 List<String> commonPrefixs = objectListing.getCommonPrefixes(); // object summary 表示所有列出的 object 列表 List<COSObjectSummary> cosObjectSummaries = objectListing.getObjectSummaries(); for (COSObjectSummary cosObjectSummary : cosObjectSummaries) { // 文件的路径 key String key = cosObjectSummary.getKey(); // 文件的 etag String etag = cosObjectSummary.getETag(); // 文件的长度 long fileSize = cosObjectSummary.getSize(); // 文件的存储类型 String storageClasses = cosObjectSummary.getStorageClass(); } String nextMarker = objectListing.getNextMarker(); listObjectsRequest.setMarker(nextMarker); } while (objectListing.isTruncated()); } private static void listObjectsVersions() { ListVersionsRequest listVersionsRequest = new ListVersionsRequest(); listVersionsRequest.setBucketName(bucketName); listVersionsRequest.setPrefix(""); VersionListing versionListing = null; do { try { versionListing = cosClient.listVersions(listVersionsRequest); } catch (CosServiceException e) { e.printStackTrace(); return; } catch (CosClientException e) { e.printStackTrace(); return; } List<COSVersionSummary> cosVersionSummaries = versionListing.getVersionSummaries(); for (COSVersionSummary cosVersionSummary : cosVersionSummaries) { System.out.println(cosVersionSummary.getKey() + ":" + cosVersionSummary.getVersionId()); } String keyMarker = versionListing.getNextKeyMarker(); String versionIdMarker = versionListing.getNextVersionIdMarker(); listVersionsRequest.setKeyMarker(keyMarker); listVersionsRequest.setVersionIdMarker(versionIdMarker); } while (versionListing.isTruncated()); }}
上传对象后,你可以用同样的 key,调用 GetObject 接口将对象下载到本地,也可以生成预签名链接(下载请指定 method 为 GET,详情请参见 预签名 URL),分享到其他终端来进行下载。但如果你的文件设置了私有读权限,那么请注意预签名链接的有效期。将文件下载到本地指定路径,参考如下示例。关于下载对象的完整示例,请前往 GitHub 查看。import java.io.File;import java.io.IOException;import java.io.InputStream;import com.qcloud.cos.COSClient;import com.qcloud.cos.ClientConfig;import com.qcloud.cos.auth.BasicCOSCredentials;import com.qcloud.cos.auth.COSCredentials;import com.qcloud.cos.exception.CosClientException;import com.qcloud.cos.exception.CosServiceException;import com.qcloud.cos.model.COSObject;import com.qcloud.cos.model.GetObjectRequest;import com.qcloud.cos.model.ObjectMetadata;import com.qcloud.cos.region.Region;import com.qcloud.cos.utils.IOUtils;public class GetObjectDemo { private static String secretId = System.getenv("SECRETID"); private static String secretKey = System.getenv("SECRETKEY"); private static String bucketName = System.getenv("BUCKET_NAME"); private static String region = System.getenv("REGION"); private static COSClient cosClient = createClient(); public static void main(String[] args) { try { getObjectToFileDemo(); //getObjectInputStreamDemo(); } catch (Exception e) { e.printStackTrace(); } finally { cosClient.shutdown(); } } private static COSClient createClient() { // 初始化用户身份信息(secretId, secretKey) COSCredentials cred = new BasicCOSCredentials(secretId,secretKey); // 设置 bucket 的区域, COS 地域的简称请参照 https://cloud.tencent.com/document/product/436/6224 ClientConfig clientConfig = new ClientConfig(new Region(region)); // 生成 cos 客户端 COSClient cosclient = new COSClient(cred, clientConfig); return cosclient; } private static void getObjectToFileDemo() { String key = "test/my_test.json"; GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key); // 设置下载的单链接限速(如有需要),不需要可忽略 getObjectRequest.setTrafficLimit(8*1024*1024); try { File localFile = new File("my_test.json"); ObjectMetadata objectMetadata = cosClient.getObject(getObjectRequest, localFile); System.out.println(objectMetadata.getContentLength()); } catch (CosServiceException cse) { cse.printStackTrace(); } catch (CosClientException cce) { cce.printStackTrace(); } } private static void getObjectInputStreamDemo() throws IOException { String key = "test/my_test.json"; GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key); InputStream cosObjectInput = null; try { COSObject cosObject = cosClient.getObject(getObjectRequest); cosObjectInput = cosObject.getObjectContent(); } catch (CosServiceException e) { e.printStackTrace(); } catch (CosClientException e) { e.printStackTrace(); } // 处理下载到的流 // 这里是直接读取,按实际情况来处理 byte[] bytes = null; try { bytes = IOUtils.toByteArray(cosObjectInput); } catch (IOException e) { e.printStackTrace(); } finally { // 用完流之后一定要调用 close() cosObjectInput.close(); } }}
注意:对象被删除后,其对应的数据将无法再被访问。删除 COS 上指定路径的对象,参考如下示例代码。关于删除对象的完整示例,请前往 GitHub 查看。import com.qcloud.cos.COSClient;import com.qcloud.cos.ClientConfig;import com.qcloud.cos.auth.BasicCOSCredentials;import com.qcloud.cos.auth.COSCredentials;import com.qcloud.cos.exception.CosClientException;import com.qcloud.cos.exception.CosServiceException;import com.qcloud.cos.region.Region;public class DelFileDemo { private static String secretId = System.getenv("SECRETID"); private static String secretKey = System.getenv("SECRETKEY"); private static String bucketName = System.getenv("BUCKET_NAME"); private static String region = System.getenv("REGION"); private static COSClient cosClient = createCli(); public static void main(String[] args) { delSingleFile(); if (cosClient != null) { cosClient.shutdown(); } } private static COSClient createCli() { // 1 初始化用户身份信息(secretId, secretKey) COSCredentials cred = new BasicCOSCredentials(secretId, secretKey); // 2 设置 bucket 的区域, COS 地域的简称请参照 https://cloud.tencent.com/document/product/436/6224 ClientConfig clientConfig = new ClientConfig(new Region(region)); // 3 生成 cos 客户端 COSClient cosclient = new COSClient(cred, clientConfig); return cosclient; } // 删除单个文件(不带版本号, 即 bucket 未开启多版本) private static void delSingleFile() { try { String key = "aaa/bbb.txt"; cosClient.deleteObject(bucketName, key); } catch (CosServiceException e) { // 如果是其他错误, 比如参数错误, 身份验证不过等会抛出 CosServiceException e.printStackTrace(); } catch (CosClientException e) { // 如果是客户端错误,比如连接不上 COS e.printStackTrace(); } }}
十一、默认请求重试策略
使用 SDK 生成的 cosClient 发起的请求,默认已经对响应错误的请求进行了重试。重试规则如下:
·重试的次数:默认值为 3,可以通过 clientConfig.setMaxErrorRetry 进行设置。
如果设置为 0,则所有类型的错误请求都不进行重试。
·重试的错误类型:客户端异常中所有的报 IOException 的错误。服务端异常中状态码为 500, 502, 503, 504 的错误。
·重试时间间隔:根据重试的次数,重试时间间隔按照200ms、400ms、800ms…的规律递增,最大重试间隔为20s。
用户也可以根据自己的需求,设置重试策略。代码如下:
设置重试次数设置重试策略Region region = new Region("COS_REGION");ClientConfig clientConfig = new ClientConfig(region);// 设置最大重试次数为 4 次clientConfig.setMaxErrorRetry(4);// 自定义重试策略public class OnlyIOExceptionRetryPolicy extends RetryPolicy { @Override public <X extends CosServiceRequest> boolean shouldRetry(CosHttpRequest<X> request, HttpResponse response, Exception exception, int retryIndex) { // 如果是客户端的 IOException 异常则重试,否则不重试 if (exception.getCause() instanceof IOException) { return true; } return false; }}Region region = new Region("COS_REGION");ClientConfig clientConfig = new ClientConfig(region);RetryPolicy myRetryPolicy = new OnlyIOExceptionRetryPolicy();// 设置自定义的重试策略clientConfig.setRetryPolicy(myRetryPolicy);
十二、常见问题
你在使用过程中可能会碰到的一些常见问题,相关的解决办法可参见 Java SDK 常见问题。