如何Swift SDK设置、获取文件元数据_对象存储(OSS)-阿里云帮助中心

本文介绍如何使用OSS Swift SDK设置和获取文件元数据。

注意事项

本文示例代码以华东1（杭州）的地域IDcn-hangzhou为例，默认使用外网Endpoint，如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。
要设置文件元数据，您必须具有oss:PutObject权限；要获取文件元数据，您必须具有oss:GetObject权限。具体操作，请参见为RAM用户授予自定义的权限策略。

上传文件时设置元数据

以下代码使用上传文件（PutObject）为例设置元数据，包括设置文件过期时间、设置文件为公共读、设置自定义元数据来标识文件的用途或属性等。

import AlibabaCloudOSS
import Foundation

@main
struct Main {
    static func main() async {

        do {

            // 填写Bucket所在地域（示例：华东1为cn-hangzhou）
            let region = "cn-hangzhou"
            // 填写Bucket名称
            let bucket = "yourBucketName"
            // 可选项，指定访问OSS服务的域名。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com
            let endpoint: String? = nil
            // 填写要设置标签的对象名称（如：document.txt）
            let key = "yourObjectName" // 替换为实际对象名称

            // 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量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 content = "Hello, OSS!"
            
            // 设置上传对象的元数据
            let metadata: [String: String] = [
                    "key1": "value1",
                    "key2": "value2"
            ]

            // 执行上传对象操作
            let result = try await client.putObject(
                PutObjectRequest(
                    bucket: bucket,
                    key: key,
                    metadata: metadata,
                    body: .data(content.data(using: .utf8)!),
                )
            )

            // 输出操作结果
            print("result:\n\(result)")

        } catch {
            // 错误输出
            print("error：\(error)")
        }
    }
}

获取文件元数据

使用HeadObject方法获取对象的所有元数据

您可以通过以下代码使用HeadObject方法获取指定Object的所有元数据。

import AlibabaCloudOSS
import Foundation

@main
struct Main {
    static func main() async {

        do {

            // 填写Bucket所在地域（示例：华东1为cn-hangzhou）
            let region = "cn-hangzhou"
            // 填写Bucket名称
            let bucket = "yourBucketName"
            // 可选项，指定访问OSS服务的域名。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com
            let endpoint: String? = nil
            // 填写要设置标签的对象名称（如：document.txt）
            let key = "yourObjectName" // 替换为实际对象名称

            // 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量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 result = try await client.headObject(
                HeadObjectRequest(
                    bucket: bucket,
                    key: key
                )
            )
            print("result:\n\(result)")

        } catch {
            // 错误输出
            print("error：\(error)")
        }
    }
}

使用GetObjectMeta方法获取对象的部分元数据

说明

使用GetObjectMeta方法仅可以获取部分的对象元数据，包括：返回内容的长度（ContentLength）、实体标签（ETag）、返回的对象最后一次被修改的时间（LastModified）、对象最后一次被访问的时间（LastAccessTime）、对象的版本ID（VersionId）、对象的 64 位 CRC 值（HashCRC64）。

您可以通过以下代码使用GetObjectMeta方法获取指定对象的部分元数据。

import AlibabaCloudOSS
import Foundation

@main
struct Main {
    static func main() async {

        do {            // 填写Bucket所在地域（示例：华东1为cn-hangzhou）
            let region = "cn-hangzhou"
            // 填写Bucket名称
            let bucket = "yourBucketName"
            // 可选项，指定访问OSS服务的域名。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com
            let endpoint: String? = nil
            // 填写要设置标签的对象名称（如：document.txt）
            let key = "yourObjectName" // 替换为实际对象名称

            // 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量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 result = try await client.getObjectMeta(
                GetObjectMetaRequest(
                    bucket: bucket,
                    key: key
                )
            )
            print("result:\n\(result)")

        } catch {
            print("error：\(error)")
        }
    }
}

Swift管理文件元数据

注意事项

上传文件时设置元数据

上传文件时设置元数据

获取文件元数据

使用HeadObject方法获取对象的所有元数据

使用GetObjectMeta方法获取对象的部分元数据

相关文档