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

列举文件

更新时间:2018-07-02 15:18:18

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/
本文导读目录