全部產品
Search

搜尋本產品

    Object Storage Service：列舉檔案

    文件中心

    Object Storage Service：列舉檔案

    更新時間：Aug 30, 2018

    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 KeyPrefix = "<yourKeyPrefix>";
    9. // 建立OSSClient執行個體。
    10. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
    12. // 列舉檔案。 如果不設定KeyPrefix，則列舉儲存空間下所有的檔案。KeyPrefix，則列舉包含指定首碼的檔案。
    13. ObjectListing objectListing = ossClient.listObjects(bucketName, KeyPrefix);
    14. List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
    15. for (OSSObjectSummary s : sums) {
    16.     System.out.println("\t" + s.getKey());
    17. }
    19. // 關閉OSSClient。
    20. 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>";
    8. // 建立OSSClient執行個體
    9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
    11. // 設定最大個數。
    12. final int maxKeys = 200;
    13. // 列舉檔案。
    14. ObjectListing objectListing = ossClient.listObjects(new ListObjectsRequest(bucketName).withMaxKeys(maxKeys));
    15. List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
    16. for (OSSObjectSummary s : sums) {
    17.     System.out.println("\t" + s.getKey());
    18. }
    20. // 關閉OSSClient。
    21. 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>";
    8. // 建立OSSClient執行個體。
    9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
    11. // 指定首碼。
    12. final String keyPrefix = "<yourkeyPrefix>";
    14. // 列舉包含指定首碼的檔案。預設列舉100個檔案。
    15. ObjectListing objectListing = ossClient.listObjects(new ListObjectsRequest(bucketName).withPrefix(keyPrefix));
    16. List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
    17. for (OSSObjectSummary s : sums) {
    18.     System.out.println("\t" + s.getKey());
    19. }
    21. // 關閉OSSClient。
    22. 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>";
    8. // 建立OSSClient執行個體。
    9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
    10. final String marker = "<yourMarker>";
    12. // 列舉指定marker之後的檔案。預設列舉100個檔案。
    13. ObjectListing objectListing = ossClient.listObjects(new ListObjectsRequest(bucketName).withMarker(marker));
    14. List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
    15. for (OSSObjectSummary s : sums) {
    16.     System.out.println("\t" + s.getKey());
    17. }
    19. // 關閉OSSClient。
    20. 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>";
    8. // 建立OSSClient執行個體。
    9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
    11. final int maxKeys = 200;
    12. String nextMarker = null;
    13. ObjectListing objectListing;
    15. do {
    16.     objectListing = ossClient.listObjects(new ListObjectsRequest(bucketName).withMarker(nextMarker).withMaxKeys(maxKeys));
    18.     List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
    19.     for (OSSObjectSummary s : sums) {
    20.         System.out.println("\t" + s.getKey());
    21.     }
    23.     nextMarker = objectListing.getNextMarker();
    25. } while (objectListing.isTruncated());
    27. // 關閉OSSClient。
    28. 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>";
    8. // 建立OSSClient執行個體。
    9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
    11. final int maxKeys = 200;
    12. String nextMarker = "<yourNextMarker>";
    13. ObjectListing objectListing;
    15. do {
    16.     objectListing = ossClient.listObjects(new ListObjectsRequest(bucketName).withMarker(nextMarker).withMaxKeys(maxKeys));
    18.     List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
    19.     for (OSSObjectSummary s : sums) {
    20.         System.out.println("\t" + s.getKey());
    21.     }
    23.     nextMarker = objectListing.getNextMarker();
    25. } while (objectListing.isTruncated());
    27. // 關閉OSSClient。
    28. 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>";
    8. // 建立OSSClient執行個體。
    9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
    11. // 指定每頁200個檔案。
    12. final int maxKeys = 200;
    13. final String keyPrefix = "<yourkeyPrefix>";
    14. String nextMarker = "<yourNextMarker>";
    15. ObjectListing objectListing;
    17. do {
    18.     objectListing = ossClient.listObjects(new ListObjectsRequest(bucketName).
    19.             withPrefix(keyPrefix).withMarker(nextMarker).withMaxKeys(maxKeys));
    21.     List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
    22.     for (OSSObjectSummary s : sums) {
    23.         System.out.println("\t" + s.getKey());
    24.     }
    26.     nextMarker = objectListing.getNextMarker();
    28. } while (objectListing.isTruncated());
    30. // 關閉OSSClient。
    31. 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>";
    8. // 建立OSSClient執行個體。
    9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
    11. final int maxKeys = 200;
    12. final String keyPrefix = "<yourkeyPrefix>";
    13. String nextMarker = "<yourNextMarker>";
    14. ObjectListing objectListing;
    16. do {
    17.     ListObjectsRequest listObjectsRequest = new ListObjectsRequest(bucketName);
    18.     listObjectsRequest.setPrefix(keyPrefix);
    19.     listObjectsRequest.setMaxKeys(maxKeys);
    20.     listObjectsRequest.setMarker(nextMarker);
    22.     // 指定檔案名稱編碼。
    23.     listObjectsRequest.setEncodingType("url");
    25.     objectListing = ossClient.listObjects(listObjectsRequest);
    27.     // 檔案解碼。
    28.     for (OSSObjectSummary objectSummary: objectListing.getObjectSummaries()) {
    29.         System.out.println("Key:" + URLDecoder.decode(objectSummary.getKey(), "UTF-8"));
    30.     }
    32.     // commonPrefixes解碼。
    33.     for (String commonPrefixes: objectListing.getCommonPrefixes()) {
    34.         System.out.println("CommonPrefixes:" + URLDecoder.decode(commonPrefixes, "UTF-8"));
    35.     }
    37.     // nextMarker解碼。
    38.     if (objectListing.getNextMarker() != null) {
    39.         nextMarker = URLDecoder.decode(objectListing.getNextMarker(), "UTF-8");
    40.     }
    41. } while (objectListing.isTruncated());
    43. // 關閉OSSClient。
    44. 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>";
    8. // 建立OSSClient執行個體。
    9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
    11. // 構造ListObjectsRequest請求。
    12. ListObjectsRequest listObjectsRequest = new ListObjectsRequest(bucketName);
    14. // 列出檔案。
    15. ObjectListing listing = ossClient.listObjects(listObjectsRequest);
    17. // 遍曆所有檔案。
    18. System.out.println("Objects:");
    19. for (OSSObjectSummary objectSummary : listing.getObjectSummaries()) {
    20.     System.out.println(objectSummary.getKey());
    21. }
    23. // 遍曆所有commonPrefix。
    24. System.out.println("CommonPrefixes:");
    25. for (String commonPrefix : listing.getCommonPrefixes()) {
    26.     System.out.println(commonPrefix);
    27. }
    29. // 關閉OSSClient。
    30. ossClient.shutdown();

    返回結果如下：

    1. Objects:
    2. fun/movie/001.avi
    3. fun/movie/007.avi
    4. fun/test.jpg
    5. oss.jpg
    7. 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>";
    8. // 建立OSSClient執行個體。
    9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
    11. // 構造ListObjectsRequest請求。
    12. ListObjectsRequest listObjectsRequest = new ListObjectsRequest(bucketName);
    13. // 設定prefix參數來獲取fun目錄下的所有檔案。
    14. listObjectsRequest.setPrefix("fun/");
    16. // 遞迴列出fun目錄下的所有檔案。
    17. ObjectListing listing = ossClient.listObjects(listObjectsRequest);
    19. // 遍曆所有檔案。
    20. System.out.println("Objects:");
    21. for (OSSObjectSummary objectSummary : listing.getObjectSummaries()) {
    22.     System.out.println(objectSummary.getKey());
    23. }
    25. // 遍曆所有commonPrefix。
    26. System.out.println("\nCommonPrefixes:");
    27. for (String commonPrefix : listing.getCommonPrefixes()) {
    28.     System.out.println(commonPrefix);
    29. }
    31. // 關閉OSSClient。
    32. ossClient.shutdown();

    返回結果如下：

    1. Objects:
    2. fun/movie/001.avi
    3. fun/movie/007.avi
    4. fun/test.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>";
    8. // 建立OSSClient執行個體。
    9. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
    11. // 構造ListObjectsRequest請求。
    12. ListObjectsRequest listObjectsRequest = new ListObjectsRequest(bucketName);
    14. // 設定正斜線（/）為檔案夾的分隔符號。
    15. listObjectsRequest.setDelimiter("/");
    17. // 列出fun目錄下的所有檔案和檔案夾。
    18. listObjectsRequest.setPrefix("fun/");
    20. ObjectListing listing = ossClient.listObjects(listObjectsRequest);
    22. // 遍曆所有檔案。
    23. System.out.println("Objects:");
    24. // objectSummaries的列表中給出的是fun目錄下的檔案。
    25. for (OSSObjectSummary objectSummary : listing.getObjectSummaries()) {
    26.     System.out.println(objectSummary.getKey());
    27. }
    29. // 遍曆所有commonPrefix。
    30. System.out.println("\nCommonPrefixes:");
    31. // commonPrefixs列表中給出的是fun目錄下的所有子檔案夾。fun/movie/001.avi和fun/movie/007.avi兩個檔案沒有被列出來，因為它們屬於fun檔案夾下的movie目錄。
    32. for (String commonPrefix : listing.getCommonPrefixes()) {
    33.     System.out.println(commonPrefix);
    34. }
    36. // 關閉OSSClient。
    37. ossClient.shutdown();

    返回結果如下：

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