全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 智能硬件
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 更多
对象存储 OSS

管理文件

更新时间:2018-06-21 18:48:32

您可以通过一系列的接口管理存储空间(Bucket)下的文件(Object)。

判断文件是否存在

以下代码用于判断指定的文件是否存在:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. // 创建OSSClient实例。
  7. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  8. // 判断文件是否存在。
  9. boolean found = ossClient.doesObjectExist("<yourBucketName>", "<yourObjectName>");
  10. System.out.println(found);
  11. // 关闭OSSClient。
  12. ossClient.shutdown();

文件访问权限

文件的访问权限(ACL)有以下四种:

权限 描述
default(默认) 文件遵循存储空间的访问权限。
private(私有读写) 文件是私有资源。文件的拥有者和授权用户有该文件的读写权限,其他用户没有权限操作该文件。
public-read(公共读私有写) 文件是公共读资源。文件拥有者和授权用户有该文件的读写权限,其他用户只有文件的读权限。
public-read-write(公共读写) 文件是公共读写资源。所有用户都有该文件的读写权限。

文件的访问权限优先级高于存储空间的访问权限。例如存储空间的访问权限是私有读写,而文件的访问权限是公共读写,则所有用户都有该文件的读写权限。如果某个文件没有设置过访问权限,则遵循存储空间的访问权限。

设置文件访问权限

您可以通过ossClient.setObjectAcl设置文件的访问权限。

权限 Java SDK对应值
private(私有读写) CannedAccessControlList.Private
public-read(公共读私有写) CannedAccessControlList.PublicRead
public-read-write(公共读写) CannedAccessControlList.PublicReadWrite

以下代码用于设置指定文件的访问权限:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. // 创建OSSClient实例。
  7. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  8. // 设置文件的访问权限。
  9. ossClient.setObjectAcl("<yourBucketName>", "<yourObjectName>", CannedAccessControlList.PublicRead);
  10. // 关闭OSSClient。
  11. ossClient.shutdown();

获取文件访问权限

以下代码用于获取指定文件的访问权限:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. // 创建OSSClient实例。
  7. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  8. // 获取文件的访问权限。
  9. ObjectAcl objectAcl = ossClient.getObjectAcl("<yourBucketName>", "<yourObjectName>");
  10. System.out.println(objectAcl.getPermission().toString());
  11. // 关闭OSSClient。
  12. ossClient.shutdown();

文件元信息

文件元信息(Object Meta)详情请参见开发指南中的文件元信息

设置HTTP header

OSS允许用户自定义HTTP header。

以下代码用于设置HTTP header:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String content = "Hello OSS";
  7. // 创建上传文件的元信息,可以通过文件元信息设置HTTP header。
  8. ObjectMetadata meta = new ObjectMetadata();
  9. String md5 = BinaryUtil.toBase64String(BinaryUtil.calculateMd5(content.getBytes()));
  10. // 开启文件内容MD5校验。开启后OSS会把您提供的MD5与文件的MD5比较,不一致则抛出异常。
  11. meta.setContentMD5(md5);
  12. // 指定上传的内容类型。内容类型决定浏览器将以什么形式、什么编码读取文件。如果没有指定则根据文件的扩展名生成,如果没有扩展名则为默认值application/octet-stream。
  13. meta.setContentType("text/plain");
  14. // 设置内容被下载时的名称。
  15. meta.setContentDisposition("Download File Name");
  16. // 设置上传文件的长度。如超过此长度,则会被截断,为设置的长度。如不足,则为上传文件的实际长度。
  17. meta.setContentLength(content.length());
  18. // 设置内容被下载时网页的缓存行为。
  19. meta.setCacheControl("Download Action");
  20. // 设置缓存过期时间,格式是格林威治时间(GMT)。
  21. meta.setExpirationTime(DateUtil.parseIso8601Date("2022-10-12T00:00:00.000Z"));
  22. // 设置内容被下载时的编码格式。
  23. meta.setContentEncoding("utf-8");
  24. // 设置header。
  25. meta.setHeader("<yourHeader>", "<yourHeaderValue>");
  26. // 创建OSSClient实例。
  27. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  28. // 上传文件。
  29. ossClient.putObject("<yourBucketName>", "<yourObjectName>", new ByteArrayInputStream(content.getBytes()), meta);
  30. // 关闭OSSClient。
  31. ossClient.shutdown();

HTTP header详情请参见RFC2616

设置自定义元信息

您可以自定义文件的元信息来对文件进行描述。

以下代码用于设置文件的自定义元信息:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String content = "Hello OSS";
  7. // 创建OSSClient实例。
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  9. // 创建文件元信息。
  10. ObjectMetadata meta = new ObjectMetadata();
  11. // 设置自定义元信息property值为property-value。
  12. meta.addUserMetadata("property", "property-value");
  13. // 上传文件。
  14. ossClient.putObject("<yourBucketName>", "<yourObjectName>", new ByteArrayInputStream(content.getBytes()), meta);
  15. // 获取文件元信息。
  16. ossClient.getObjectMetadata("<yourBucketName>", "<yourObjectName>");
  17. // 关闭OSSClient。
  18. ossClient.shutdown();

下载文件时,文件元信息也会同时下载。 一个文件可以有多个元信息,总大小不能超过8KB。

获取文件元信息

您可以通过以下两种方法获取文件元信息:

方法 描述 优势
ossClient.getSimplifiedObjectMeta 获取文件的ETag、Size(文件大小)、 LastModified(最后修改时间)。 更轻量、更快
ossClient.getObjectMetadata 获取文件的全部元信息。

以下代码用于获取文件元信息:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. // 创建OSSClient实例。
  7. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  8. // 获取文件的部分元信息。
  9. SimplifiedObjectMeta objectMeta = ossClient.getSimplifiedObjectMeta("<yourBucketName>", "<yourObjectName>");
  10. System.out.println(objectMeta.getSize());
  11. System.out.println(objectMeta.getETag());
  12. System.out.println(objectMeta.getLastModified());
  13. // 获取文件的全部元信息。
  14. ObjectMetadata metadata = ossClient.getObjectMetadata("<yourBucketName>", "<yourObjectName>");
  15. System.out.println(metadata.getContentType());
  16. System.out.println(metadata.getLastModified());
  17. System.out.println(metadata.getExpirationTime());
  18. // 关闭OSSClient。
  19. ossClient.shutdown();

列举文件

OSS文件按照字母顺序排列。您可以通过ossClient.listObjects列出存储空间下的文件。listObjects有以下三类参数格式:

  • ObjectListing listObjects(String bucketName):列举存储空间下的文件。最多列举100个文件。
  • ObjectListing listObjects(String bucketName, String prefix): 列举存储空间下指定前缀的文件。最多列举100个文件。
  • ObjectListing listObjects(ListObjectsRequest listObjectsRequest):提供多种过滤功能,实现灵活的查询功能。

ObjectListing的参数如下:

参数 描述 方法
objectSummaries 限定返回的文件元信息。 List<OSSObjectSummary> getObjectSummaries()
prefix 本次查询结果的前缀。 String getPrefix()
delimiter 对文件名称进行分组的一个字符。 String getDelimiter()
marker 标明本次列举文件的起点。 String getMarker()
maxKeys 列举文件的最大个数。 int getMaxKeys()
nextMarker 下一次列举文件的起点。 String getNextMarker()
isTruncated 指明是否所有的结果都已经返回。 boolean isTruncated()
commonPrefixes 以delimiter结尾,并有共同前缀的文件集合。 List<String> getCommonPrefixes()
encodingType 指明返回结果中编码使用的类型。 String getEncodingType()

listObjects的完整代码请参见GitHub

简单列举文件

以下代码用于列举指定存储空间下的文件,默认列举100个文件。

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. String KeyPrifex = "<yourKeyPrifex>";
  8. // 创建OSSClient实例。
  9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  10. // 列举文件。 如果不设置KeyPrifex,则列举存储空间下所有的文件。如果设置了KeyPrifex,则列举包含指定前缀的文件。
  11. ObjectListing objectListing = ossClient.listObjects(bucketName, KeyPrifex);
  12. List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
  13. for (OSSObjectSummary s : sums) {
  14. System.out.println("\t" + s.getKey());
  15. }
  16. // 关闭OSSClient。
  17. ossClient.shutdown();

通过ListObjectsRequest列举文件

通过设置ListObjectsReques的参数实现各种灵活的查询功能。ListObjectsReques的参数如下:

参数 描述 方法
prefix 限定返回的文件必须以prefix作为前缀。 setPrefix(String prefix)
delimiter 对文件名称进行分组的一个字符。所有名称包含指定的前缀且第一次出现delimiter字符之间的文件作为一组元素(commonPrefixes)。 setDelimiter(String delimiter)
marker 列举指定marker之后的文件。 setMarker(String marker)
maxKeys 限定此次列举文件的最大个数。默认值为100,最大值为1000。 setMaxKeys(Integer maxKeys)
encodingType 请求响应体中文件名称采用的编码方式,目前仅支持url。 setEncodingType(String encodingType)

列举指定个数的文件

以下代码用于列举指定个数的文件:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. // 创建OSSClient实例
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  9. // 设置最大个数。
  10. final int maxKeys = 200;
  11. // 列举文件。
  12. ObjectListing objectListing = ossClient.listObjects(new ListObjectsRequest(bucketName).withMaxKeys(maxKeys));
  13. List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
  14. for (OSSObjectSummary s : sums) {
  15. System.out.println("\t" + s.getKey());
  16. }
  17. // 关闭OSSClient。
  18. ossClient.shutdown();

列举指定前缀的文件

以下代码用于列举包含指定前缀(prefix)的文件:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. // 创建OSSClient实例。
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  9. // 指定前缀。
  10. final String keyPrefix = "<yourkeyPrefix>";
  11. // 列举包含指定前缀的文件。默认列举100个文件。
  12. ObjectListing objectListing = ossClient.listObjects(new ListObjectsRequest(bucketName).withPrefix(keyPrefix));
  13. List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
  14. for (OSSObjectSummary s : sums) {
  15. System.out.println("\t" + s.getKey());
  16. }
  17. // 关闭OSSClient。
  18. ossClient.shutdown();

列举指定marker之后的文件

参数marker代表文件名称。以下代码用于列举指定marker之后的文件:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. // 创建OSSClient实例。
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  9. final String marker = "<yourMarker>";
  10. // 列举指定marker之后的文件。默认列举100个文件。
  11. ObjectListing objectListing = ossClient.listObjects(new ListObjectsRequest(bucketName).withMarker(marker));
  12. List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
  13. for (OSSObjectSummary s : sums) {
  14. System.out.println("\t" + s.getKey());
  15. }
  16. // 关闭OSSClient。
  17. ossClient.shutdown();

分页列举所有文件

以下代码用于分页列举指定存储空间下的所有文件。每页列举的文件个数通过maxKeys指定。

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. // 创建OSSClient实例。
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  9. final int maxKeys = 200;
  10. String nextMarker = null;
  11. ObjectListing objectListing;
  12. do {
  13. objectListing = ossClient.listObjects(new ListObjectsRequest(bucketName).withMarker(nextMarker).withMaxKeys(maxKeys));
  14. List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
  15. for (OSSObjectSummary s : sums) {
  16. System.out.println("\t" + s.getKey());
  17. }
  18. nextMarker = objectListing.getNextMarker();
  19. } while (objectListing.isTruncated());
  20. // 关闭OSSClient。
  21. ossClient.shutdown();

分页列举指定marker之后的文件

以下代码用于分页列举指定maker之后的文件。每页列举的文件个数通过maxKeys指定。

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. // 创建OSSClient实例。
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  9. final int maxKeys = 200;
  10. String nextMarker = "<yourNextMarker>";
  11. ObjectListing objectListing;
  12. do {
  13. objectListing = ossClient.listObjects(new ListObjectsRequest(bucketName).withMarker(nextMarker).withMaxKeys(maxKeys));
  14. List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
  15. for (OSSObjectSummary s : sums) {
  16. System.out.println("\t" + s.getKey());
  17. }
  18. nextMarker = objectListing.getNextMarker();
  19. } while (objectListing.isTruncated());
  20. // 关闭OSSClient。
  21. ossClient.shutdown();

分页列举指定前缀的文件

以下代码用于分页列举包含指定前缀的文件。

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. // 创建OSSClient实例。
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  9. // 指定每页200个文件。
  10. final int maxKeys = 200;
  11. final String keyPrefix = "<yourkeyPrefix>";
  12. String nextMarker = "<yourNextMarker>";
  13. ObjectListing objectListing;
  14. do {
  15. objectListing = ossClient.listObjects(new ListObjectsRequest(bucketName).
  16. withPrefix(keyPrefix).withMarker(nextMarker).withMaxKeys(maxKeys));
  17. List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
  18. for (OSSObjectSummary s : sums) {
  19. System.out.println("\t" + s.getKey());
  20. }
  21. nextMarker = objectListing.getNextMarker();
  22. } while (objectListing.isTruncated());
  23. // 关闭OSSClient。
  24. ossClient.shutdown();

指定文件名称编码

如果文件名称含有以下特殊字符,需要进行编码传输。OSS目前仅支持url编码。

  • 单引号(’)
  • 双引号(”)
  • and符号(&)
  • 尖括号(< >)
  • 顿号(、)
  • 中文

以下代码用于指定文件名称编码:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. // 创建OSSClient实例。
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  9. final int maxKeys = 200;
  10. final String keyPrefix = "<yourkeyPrefix>";
  11. String nextMarker = "<yourNextMarker>";
  12. ObjectListing objectListing;
  13. do {
  14. ListObjectsRequest listObjectsRequest = new ListObjectsRequest(bucketName);
  15. listObjectsRequest.setPrefix(keyPrefix);
  16. listObjectsRequest.setMaxKeys(maxKeys);
  17. listObjectsRequest.setMarker(nextMarker);
  18. // 指定文件名称编码。
  19. listObjectsRequest.setEncodingType("url");
  20. objectListing = ossClient.listObjects(listObjectsRequest);
  21. // 文件解码。
  22. for (OSSObjectSummary objectSummary: objectListing.getObjectSummaries()) {
  23. System.out.println("Key:" + URLDecoder.decode(objectSummary.getKey(), "UTF-8"));
  24. }
  25. // commonPrefixes解码。
  26. for (String commonPrefixes: objectListing.getCommonPrefixes()) {
  27. System.out.println("CommonPrefixes:" + URLDecoder.decode(commonPrefixes, "UTF-8"));
  28. }
  29. // nextMarker解码。
  30. if (objectListing.getNextMarker() != null) {
  31. nextMarker = URLDecoder.decode(objectListing.getNextMarker(), "UTF-8");
  32. }
  33. } while (objectListing.isTruncated());
  34. // 关闭OSSClient。
  35. ossClient.shutdown();

文件夹功能

OSS没有文件夹的概念,所有元素都是以文件来存储。创建文件夹本质上来说是创建了一个大小为0并以正斜线(/)结尾的文件。这个文件可以被上传和下载,控制台会对以正斜线(/)结尾的文件以文件夹的方式展示。

通过delimiter和prefix两个参数可以模拟文件夹功能:

  • 如果设置prefix为某个文件夹名称,则会列举以此prefix开头的文件,即该文件夹下所有的文件和子文件夹(目录),显示为Objects。
  • 如果再设置delimiter为正斜线(/),则只列举该文件夹下的文件和子文件夹(目录),该文件夹下的子文件夹(目录)则显示为CommonPrefixes,子文件夹下的文件和文件夹不显示。

文件夹详情请参见文件夹功能。创建文件的完整代码请参见GitHub

假设存储空间中有4个文件: oss.jpg、fun/test.jpg、fun/movie/001.avi、fun/movie/007.avi,正斜线(/)作为文件夹的分隔符。下面的示例展示了如何模拟文件夹功能。

列举存储空间下所有文件

以下代码用于列举指定存储空间下的所有文件:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. // 创建OSSClient实例。
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  9. // 构造ListObjectsRequest请求。
  10. ListObjectsRequest listObjectsRequest = new ListObjectsRequest(bucketName);
  11. // 列出文件。
  12. ObjectListing listing = ossClient.listObjects(listObjectsRequest);
  13. // 遍历所有文件。
  14. System.out.println("Objects:");
  15. for (OSSObjectSummary objectSummary : listing.getObjectSummaries()) {
  16. System.out.println(objectSummary.getKey());
  17. }
  18. // 遍历所有commonPrefix。
  19. System.out.println("CommonPrefixes:");
  20. for (String commonPrefix : listing.getCommonPrefixes()) {
  21. System.out.println(commonPrefix);
  22. }
  23. // 关闭OSSClient。
  24. ossClient.shutdown();

返回结果如下:

  1. Objects:
  2. fun/movie/001.avi
  3. fun/movie/007.avi
  4. fun/test.jpg
  5. oss.jpg
  6. CommonPrefixes:

列举指定目录下所有文件

以下代码用于列举指定目录下的所有文件:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. // 创建OSSClient实例。
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  9. // 构造ListObjectsRequest请求。
  10. ListObjectsRequest listObjectsRequest = new ListObjectsRequest(bucketName);
  11. // 设置prefix参数来获取fun目录下的所有文件。
  12. listObjectsRequest.setPrefix("fun/");
  13. // 递归列出fun目录下的所有文件。
  14. ObjectListing listing = ossClient.listObjects(listObjectsRequest);
  15. // 遍历所有文件。
  16. System.out.println("Objects:");
  17. for (OSSObjectSummary objectSummary : listing.getObjectSummaries()) {
  18. System.out.println(objectSummary.getKey());
  19. }
  20. // 遍历所有commonPrefix。
  21. System.out.println("\nCommonPrefixes:");
  22. for (String commonPrefix : listing.getCommonPrefixes()) {
  23. System.out.println(commonPrefix);
  24. }
  25. // 关闭OSSClient。
  26. ossClient.shutdown();

返回结果如下:

  1. Objects:
  2. fun/movie/001.avi
  3. fun/movie/007.avi
  4. fun/test.jpg
  5. CommonPrefixes:

列举目录下的文件和子目录

以下代码用于列举指定目录下的文件和子目录:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. // 创建OSSClient实例。
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  9. // 构造ListObjectsRequest请求。
  10. ListObjectsRequest listObjectsRequest = new ListObjectsRequest(bucketName);
  11. // 设置正斜线(/)为文件夹的分隔符。
  12. listObjectsRequest.setDelimiter("/");
  13. // 列出fun目录下的所有文件和文件夹。
  14. listObjectsRequest.setPrefix("fun/");
  15. ObjectListing listing = ossClient.listObjects(listObjectsRequest);
  16. // 遍历所有文件。
  17. System.out.println("Objects:");
  18. // objectSummaries的列表中给出的是fun目录下的文件。
  19. for (OSSObjectSummary objectSummary : listing.getObjectSummaries()) {
  20. System.out.println(objectSummary.getKey());
  21. }
  22. // 遍历所有commonPrefix。
  23. System.out.println("\nCommonPrefixes:");
  24. // commonPrefixs列表中给出的是fun目录下的所有子文件夹。fun/movie/001.avi和fun/movie/007.avi两个文件没有被列出来,因为它们属于fun文件夹下的movie目录。
  25. for (String commonPrefix : listing.getCommonPrefixes()) {
  26. System.out.println(commonPrefix);
  27. }
  28. // 关闭OSSClient。
  29. ossClient.shutdown();

返回结果如下:

  1. Objects:
  2. fun/test.jpg
  3. CommonPrefixes:
  4. fun/movie/

删除文件

删除单个文件

以下代码用于删除单个文件:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. String objectName = "<yourObjectName>";
  8. // 创建OSSClient实例。
  9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  10. // 删除文件。
  11. ossClient.deleteObject(bucketName, objectName);
  12. // 关闭OSSClient。
  13. ossClient.shutdown();

删除多个文件

每次最多删除1000个文件。有两种返回模式:详细(verbose)模式和简单(quiet)模式:

  • 详细模式:返回删除成功的文件列表。默认为详细模式。
  • 简单模式:返回删除失败的文件列表。

DeleteObjectsRequest的参数如下:

参数 描述 方法
Keys 需要删除的文件。 setKeys(List<String>)
quiet 返回模式。true表示简单模式,false表示详细模式。默认为详细模式。 setQuiet(boolean)
encodingType 指定对返回的文件名称进行编码,目前仅支持url。 setEncodingType(String)

DeleteObjectsResult的参数如下:

参数 描述 方法
deletedObjects 删除结果。详细模式下为删除成功的文件列表,简单模式下为删除失败的文件列表。 List<String> getDeletedObjects()
encodingType deletedObjects中文件名称的编码,为空表示没有编码。 getEncodingType()

以下代码用于批量删除文件:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. // 创建OSSClient实例。
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  9. // 删除文件。
  10. List<String> keys = new ArrayList<String>();
  11. keys.add("key0");
  12. keys.add("key1");
  13. keys.add("key2");
  14. DeleteObjectsResult deleteObjectsResult = ossClient.deleteObjects(new DeleteObjectsRequest(bucketName).withKeys(keys));
  15. List<String> deletedObjects = deleteObjectsResult.getDeletedObjects();
  16. // 关闭OSSClient。
  17. ossClient.shutdown();

批量删除文件的完整代码请参见GitHub

拷贝文件

您可以通过ossClient.copyObject方法将文件从一个存储空间(源存储空间)复制到同一地域的另一个存储空间(目标存储空间)。此方法有两种参数指定方式:

参数指定方式 描述
CopyObjectResult copyObject(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey) 允许指定源存储空间和源文件,以及目标存储空间和目标文件。拷贝后,目标文件的内容及元信息与源文件相同,称为简单拷贝。
CopyObjectResult copyObject(CopyObjectRequest copyObjectRequest) 允许指定目标文件的元信息和拷贝的限制条件。如果拷贝操作的源文件地址和目标文件地址相同,则直接替换源文件的元信息。

CopyObjectRequest可设置的参数如下:

参数 描述 方法
sourceBucketName 源存储空间名称。 setSourceBucketName(String sourceBucketName)
sourceKey 源文件名称。 setSourceKey(String sourceKey)
destinationBucketName 目标存储空间名称。 setDestinationBucketName(String destinationBucketName)
destinationKey 目标文件名称。 setDestinationKey(String destinationKey)
newObjectMetadata 目标文件元信息。 setNewObjectMetadata(ObjectMetadata newObjectMetadata)
matchingETagConstraints 拷贝的限制条件。如果源文件的ETag值和提供的ETag值相等,则执行拷贝操作,否则返回错误。 setMatchingETagConstraints(List<String> matchingETagConstraints)
nonmatchingEtagConstraints 拷贝的限制条件。如果源文件的ETag值和用户提供的ETag值不相等,则执行拷贝操作,否则返回错误。 setNonmatchingETagConstraints(List<String> nonmatchingEtagConstraints)
unmodifiedSinceConstraint 拷贝的限制条件。如果传入参数中的时间等于或者晚于文件实际修改时间,则执行拷贝操作,否则返回错误。 setUnmodifiedSinceConstraint(Date unmodifiedSinceConstraint)
modifiedSinceConstraint 拷贝的限制条件。如果源文件在指定的时间之后被修改过,则执行拷贝操作,否则返回错误。 setModifiedSinceConstraint(Date modifiedSinceConstraint)

CopyObjectRequest的参数如下:

参数 描述 方法
etag OSS文件唯一性标志 String getETag()
lastModified 文件最后修改时间 Date getLastModified()

此操作的限制条件如下:

  • 用户有源文件的读写权限。
  • 不支持跨地域拷贝。例如,不支持将杭州存储空间里的文件拷贝到青岛。
  • 文件的大小不能超过1GB。

简单拷贝

以下代码用于简单拷贝:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String sourceBucketName = "<yourSourceBucketName>";
  7. String sourceObjectName = "<yourSourceObjectName>";
  8. String destinationBucketName = "<yourDestinationBucketName>";
  9. String destinationObjectName = "<yourDestinationObjectName>";
  10. // 创建OSSClient实例。
  11. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  12. // 拷贝文件。
  13. CopyObjectResult result = ossClient.copyObject(sourceBucketName, sourceObjectName, destinationBucketName, destinationObjectName);
  14. System.out.println("ETag: " + result.getETag() + " LastModified: " + result.getLastModified());
  15. // 关闭OSSClient。
  16. ossClient.shutdown();

通过CopyObjectRequest拷贝

以下代码用于通过CopyObjectRequest拷贝文件:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String sourceBucketName = "<yourSourceBucketName>";
  7. String sourceObjectName = "<yourSourceObjectName>";
  8. String destinationBucketName = "<yourDestinationBucketName>";
  9. String destinationObjectName = "<yourDestinationObjectName>";
  10. // 创建OSSClient实例。
  11. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  12. // 创建CopyObjectRequest对象。
  13. CopyObjectRequest copyObjectRequest = new CopyObjectRequest(sourceBucketName, sourceObjectName, destinationBucketName, destinationObjectName);
  14. // 设置新的文件元信息。
  15. ObjectMetadata meta = new ObjectMetadata();
  16. meta.setContentType("text/html");
  17. copyObjectRequest.setNewObjectMetadata(meta);
  18. // 复制文件。
  19. CopyObjectResult result = ossClient.copyObject(copyObjectRequest);
  20. System.out.println("ETag: " + result.getETag() + " LastModified: " + result.getLastModified());
  21. // 关闭OSSClient。
  22. ossClient.shutdown();

拷贝大文件

CopyObject只能拷贝小于1GB的文件,大文件需要使用分片拷贝(UploadPartCopy)。分片拷贝分为三步:

  1. 通过ossClient.initiateMultipartUpload初始化分片拷贝任务。
  2. 通过ossClient.uploadPartCopy进行分片拷贝。除最后一个分片外,其它分片都要大于100KB。
  3. 通过ossClient.completeMultipartUpload提交分片拷贝任务。
  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String sourceBucketName = "<yourSourceBucketName>";
  7. String sourceObjectName = "<yourSourceObjectName>";
  8. String destinationBucketName = "<yourDestinationBucketName>";
  9. String destinationObjectName = "<yourDestinationObjectName>";
  10. ObjectMetadata objectMetadata = ossClient.getObjectMetadata(sourceBucketName, sourceObjectName);
  11. // 获取被拷贝文件的大小。
  12. long contentLength = objectMetadata.getContentLength();
  13. // 设置分片大小为10MB。
  14. long partSize = 1024 * 1024 * 10;
  15. // 计算分片总数。
  16. int partCount = (int) (contentLength / partSize);
  17. if (contentLength % partSize != 0) {
  18. partCount++;
  19. }
  20. System.out.println("total part count:" + partCount);
  21. // 初始化拷贝任务。可以通过InitiateMultipartUploadRequest指定目标文件元信息。
  22. InitiateMultipartUploadRequest initiateMultipartUploadRequest = new InitiateMultipartUploadRequest(destinationBucketName, destinationObjectName);
  23. InitiateMultipartUploadResult initiateMultipartUploadResult = ossClient.initiateMultipartUpload(initiateMultipartUploadRequest);
  24. String uploadId = initiateMultipartUploadResult.getUploadId();
  25. // 分片拷贝。
  26. List<PartETag> partETags = new ArrayList<PartETag>();
  27. for (int i = 0; i < partCount; i++) {
  28. // 计算每个分片的大小。
  29. long skipBytes = partSize * i;
  30. long size = partSize < contentLength - skipBytes ? partSize : contentLength - skipBytes;
  31. // 创建UploadPartCopyRequest。可以通过UploadPartCopyRequest指定限定条件。
  32. UploadPartCopyRequest uploadPartCopyRequest =
  33. new UploadPartCopyRequest(sourceBucketName, sourceObjectName, destinationBucketName, destinationObjectName);
  34. uploadPartCopyRequest.setUploadId(uploadId);
  35. uploadPartCopyRequest.setPartSize(size);
  36. uploadPartCopyRequest.setBeginIndex(skipBytes);
  37. uploadPartCopyRequest.setPartNumber(i + 1);
  38. UploadPartCopyResult uploadPartCopyResult = ossClient.uploadPartCopy(uploadPartCopyRequest);
  39. // 将返回的分片ETag保存到partETags中。
  40. partETags.add(uploadPartCopyResult.getPartETag());
  41. }
  42. // 提交分片拷贝任务。
  43. CompleteMultipartUploadRequest completeMultipartUploadRequest = new CompleteMultipartUploadRequest(
  44. destinationBucketName, destinationObjectName, uploadId, partETags);
  45. ossClient.completeMultipartUpload(completeMultipartUploadRequest);
  46. // 关闭OSSClient。
  47. ossClient.shutdown();

分片拷贝的详细说明请参见UploadPartCopy。分片拷贝的完整代码请参见GitHub

解冻归档文件

归档类型(Archive)的文件需要解冻(Restore)之后才能读取。非归档类型的文件,不要调用restoreObject方法。

归档文件的状态变换过程如下:

  1. 归档类型的文件初始时处于冷冻状态。
  2. 提交解冻操作后,服务端执行解冻,文件处于解冻中的状态。
  3. 完成解冻后,可以读取文件。解冻状态默认持续1天,最多延长7天,之后文件又回到冷冻状态。

以下代码用于解冻归档文件:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. String objectName = "<yourObjectName>";
  8. // 创建OSSClient实例。
  9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  10. ObjectMetadata objectMetadata = ossClient.getObjectMetadata(bucketName, objectName);
  11. // 校验文件是否为归档文件。
  12. StorageClass storageClass = objectMetadata.getObjectStorageClass();
  13. if (storageClass == StorageClass.Archive) {
  14. // 解冻文件。
  15. ossClient.restoreObject(bucketName, objectName);
  16. // 等待解冻完成。
  17. do {
  18. Thread.sleep(1000);
  19. objectMetadata = ossClient.getObjectMetadata(bucketName, objectName);
  20. } while (!objectMetadata.isRestoreCompleted());
  21. }
  22. // 获取解冻文件。
  23. OSSObject ossObject = ossClient.getObject(bucketName, objectName);
  24. ossObject.getObjectContent().close();
  25. // 关闭OSSClient。
  26. ossClient.shutdown();

归档存储类型的详细说明请参见存储类型介绍。解冻归档文件的完整代码请参见GitHUb

符号链接

创建符号链接

符号链接是一种特殊的文件,它指向某个具体的文件,类似于Windows上使用的快捷方式。符号链接支持自定义元信息。

以下代码用于创建符号链接:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. String symLink = "<yourSymLink>";
  8. String destinationObjectName = "<yourDestinationObjectName>";
  9. // 创建OSSClient实例。
  10. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  11. // 创建上传文件元信息。
  12. ObjectMetadata metadata = new ObjectMetadata();
  13. metadata.setContentType("text/plain");
  14. // 设置自定义元信息property的值为property-value。
  15. metadata.addUserMetadata("property", "property-value");
  16. // 创建CreateSymlinkRequest。
  17. CreateSymlinkRequest createSymlinkRequest = new CreateSymlinkRequest(bucketName, symLink, destinationObjectName);
  18. // 设置元信息。
  19. createSymlinkRequest.setMetadata(metadata);
  20. // 创建符号链接。
  21. ossClient.createSymlink(createSymlinkRequest);
  22. // 关闭OSSClient。
  23. ossClient.shutdown();

符号链接的详细信息请参见PutSymlink

获取符号链接指向的文件内容

获取符号链接要求您对该符号链接有读权限。以下代码用于获取符号链接指向的文件内容:

  1. // Endpoint以杭州为例,其它Region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String bucketName = "<yourBucketName>";
  7. String symLink = "<yourSymLink>";
  8. // 创建OSSClient实例。
  9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  10. // 获取符号链接。
  11. OSSSymlink symbolicLink = ossClient.getSymlink(bucketName, symLink);
  12. // 打印符号链接指向的文件内容。
  13. System.out.println(symbolicLink.getSymlink());
  14. System.out.println(symbolicLink.getTarget());
  15. System.out.println(symbolicLink.getRequestId());
  16. // 关闭OSSClient。
  17. ossClient.shutdown();

符号链接的详细信息请参见GetSymlink

本文导读目录