Object Storage Service：Swift列舉檔案

注意事項

• 本文範例程式碼以華東1（杭州）的地區IDcn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。

• 要列舉檔案，您必須有oss:ListObjects許可權。具體操作，請參見為RAM使用者授予自訂的權限原則。

程式碼範例

以下代碼用於通過ListObjectsV2方法列舉指定儲存空間下的檔案。

import AlibabaCloudOSS
import Foundation
@main
struct Main {
    static func main() async {
        do {
            // 填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為cn-hangzhou。
            let region = "cn-hangzhou"
            // 填寫Bucket名稱。
            let bucket = "yourBucketName"
            // 可選項，指定訪問OSS服務的網域名稱。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com
            let endpoint: String? = nil
            
            // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
            let credentialsProvider = EnvironmentCredentialsProvider()
            // 配置OSS用戶端參數
            let config = Configuration.default()
                .withRegion(region)        // 設定Bucket所在地區
                .withCredentialsProvider(credentialsProvider)  // 設定訪問憑證
                
            // 設定Endpoint
            if let endpoint = endpoint {
                config.withEndpoint(endpoint)
            }
            
            // 建立OSS用戶端執行個體
            let client = Client(config)
            
            // 指定List操作需要從此token開始
            var continueToken: String?
            // 是否列舉完所有object
            var isTruncated: Bool = false
            repeat {
                let result = try await client.listObjectsV2(
                    ListObjectsV2Request(
                        bucket: bucket,
                        maxKeys: 10,
                        continuationToken: continueToken
                    )
                )
                // 遍曆當前頁中的對象列表
                for content in result.contents ?? [] {
                    // 輸出對象中繼資料：對象名稱、大小（位元組）、最後修改時間
                    print("Object key:\(content.key ?? ""), size: \(String(describing: content.size)), last modified: \(String(describing: content.lastModified))")
                }
                isTruncated = result.isTruncated ?? false
                continueToken = result.nextContinuationToken
            } while isTruncated
        } catch {
            // 錯誤輸出
            print("error：\(error)")
        }
    }
}

常用情境

import AlibabaCloudOSS
import Foundation
@main
struct Main {
    static func main() async {
        do {
            // 填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為cn-hangzhou。
            let region = "cn-hangzhou"
            // 填寫Bucket名稱。
            let bucket = "yourBucketName"
            // 可選項，指定訪問OSS服務的網域名稱。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com
            let endpoint: String? = nil
            
            // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
            let credentialsProvider = EnvironmentCredentialsProvider()
            // 配置OSS用戶端參數
            let config = Configuration.default()
                .withRegion(region)        // 設定Bucket所在地區
                .withCredentialsProvider(credentialsProvider)  // 設定訪問憑證
                
            // 設定Endpoint
            if let endpoint = endpoint {
                config.withEndpoint(endpoint)
            }
            
            // 建立OSS用戶端執行個體
            let client = Client(config)
            // 建立分頁請求對象，用於遍曆儲存桶中的所有對象（分頁處理）
            let paginator = client.listObjectsV2Paginator(
                ListObjectsV2Request(
                    bucket: bucket // 指定要列出對象的Bucket名稱
                )
            )
            // 遍曆分頁結果，逐頁擷取對象資訊
            for try await page in paginator {
                // 遍曆當前頁中的對象列表
                for content in page.contents ?? [] {
                    // 輸出對象中繼資料：對象名稱、大小（位元組）、最後修改時間
                    print("Object key:\(content.key ?? ""), size: \(String(describing: content.size)), last modified: \(String(describing: content.lastModified))")
                }
            }
        } catch {
            // 錯誤輸出
            print("error：\(error)")
        }
    }
}

相關文檔

• 關於列舉檔案的完整範例程式碼，請參見GitHub樣本。

• 關於列舉檔案的API介面，請參見ListObjectsV2。