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

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

注意事项

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

上传文件时设置元数据

以下代码使用上传文件（PutObject）为例设置元数据，包括设置文件过期时间、设置文件为公共读、设置自定义元数据来标识文件的用途或属性等。其他上传类对象接口都支持设置元数据，且设置方式与PutObject方法一致。

package main

import (
	"context"
	"flag"
	"log"
	"strings"
	"time"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定义全局变量
var (
	region     string // 存储区域
	bucketName string // 存储空间名称
	objectName string // 对象名称
)

// init函数用于初始化命令行参数
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
	flag.StringVar(&objectName, "object", "", "The name of the object.")
}

func main() {
	// 解析命令行参数
	flag.Parse()

	// 检查bucket名称是否为空
	if len(bucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name required")
	}

	// 检查region是否为空
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 检查object名称是否为空
	if len(objectName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, object name required")
	}

	// 定义要上传的内容
	content := "hi oss"

	// 加载默认配置并设置凭证提供者和区域
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 创建OSS客户端
	client := oss.NewClient(cfg)

	// 创建上传对象的请求
	request := &oss.PutObjectRequest{
		Bucket:  oss.Ptr(bucketName),                                                          // 存储空间名称
		Key:     oss.Ptr(objectName),                                                          // 对象名称
		Body:    strings.NewReader(content),                                                   // 要上传的内容
		Expires: oss.Ptr(time.Date(2038, 12, 31, 12, 0, 0, 0, time.UTC).Format(time.RFC1123)), // 对象的过期时间
		Acl:     oss.ObjectACLPublicRead,
		Metadata: map[string]string{ // 自定义元数据
			"Author": "alibaba oss sdk", // 对象的作者
			"Date":   "2024-07-01",      // 对象的创建日期
		},
	}

	// 发送上传对象的请求
	result, err := client.PutObject(context.TODO(), request)
	if err != nil {
		log.Fatalf("failed to put object %v", err)
	}

	// 打印上传对象的结果
	log.Printf("put object result:%#v\n", result)
}

获取文件元数据

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

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

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定义全局变量
var (
	region     string // 存储区域
	bucketName string // 存储空间名称
	objectName string // 对象名称
)

// init函数用于初始化命令行参数
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
	flag.StringVar(&objectName, "object", "", "The name of the object.")
}

func main() {
	// 解析命令行参数
	flag.Parse()

	// 检查bucket名称是否为空
	if len(bucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name required")
	}

	// 检查region是否为空
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 检查object名称是否为空
	if len(objectName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, object name required")
	}

	// 加载默认配置并设置凭证提供者和区域
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 创建OSS客户端
	client := oss.NewClient(cfg)

	// 创建HeadObject请求
	request := &oss.HeadObjectRequest{
		Bucket:    oss.Ptr(bucketName),      // 存储空间名称
		Key:       oss.Ptr(objectName),      // 对象名称
	}

	// 执行HeadObject操作并处理结果
	result, err := client.HeadObject(context.TODO(), request)
	if err != nil {
		log.Fatalf("failed to head object %v", err)
	}

	// 打印HeadObject操作的结果
	log.Printf("head object result:%#v\n", result)
}

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

说明

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

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

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定义全局变量
var (
	region     string // 存储区域
	bucketName string // 存储空间名称
	objectName string // 对象名称
)

// init函数用于初始化命令行参数
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
	flag.StringVar(&objectName, "object", "", "The name of the object.")
}

func main() {
	// 解析命令行参数
	flag.Parse()

	// 检查bucket名称是否为空
	if len(bucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name required")
	}

	// 检查region是否为空
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 检查object名称是否为空
	if len(objectName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, object name required")
	}

	// 加载默认配置并设置凭证提供者和区域
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 创建OSS客户端
	client := oss.NewClient(cfg)

	// 创建获取对象元数据的请求
	request := &oss.GetObjectMetaRequest{
		Bucket:    oss.Ptr(bucketName),      // 存储空间名称
		Key:       oss.Ptr(objectName),      // 对象名称
	}

	// 执行获取对象元数据的操作并处理结果
	result, err := client.GetObjectMeta(context.TODO(), request)
	if err != nil {
		log.Fatalf("failed to get object meta %v", err)
	}

	// 打印获取对象元数据的结果
	log.Printf("get object meta result:%#v\n", result)
}

修改已有文件的元数据

使用CopyObject方法修改对象元数据

您可以通过以下代码使用CopyObject方法拷贝源对象时设置目标对象的元数据。

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定义全局变量
var (
	region         string // 存储区域
	srcBucketName  string // 源存储空间名称
	srcObjectName  string // 源对象名称
	destBucketName string // 目标存储空间名称
	destObjectName string // 目标对象名称
)

// init函数用于初始化命令行参数
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&srcBucketName, "src-bucket", "", "The name of the source bucket.")
	flag.StringVar(&srcObjectName, "src-object", "", "The name of the source object.")
	flag.StringVar(&destBucketName, "dest-bucket", "", "The name of the destination bucket.")
	flag.StringVar(&destObjectName, "dest-object", "", "The name of the destination object.")
}

func main() {
	// 解析命令行参数
	flag.Parse()

	// 检查源bucket名称是否为空
	if len(srcBucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, source bucket name required")
	}

	// 检查region是否为空
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 如果目标bucket名称未指定，则使用源bucket名称
	if len(destBucketName) == 0 {
		destBucketName = srcBucketName
	}

	// 检查源object名称是否为空
	if len(srcObjectName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, source object name required")
	}

	// 检查目标object名称是否为空
	if len(destObjectName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, destination object name required")
	}

	// 加载默认配置并设置凭证提供者和区域
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 创建OSS客户端
	client := oss.NewClient(cfg)

	// 创建metadata
	metaData := map[string]string{
		"x-oss-meta-tag1": "value1", // 元数据key为x-oss-meta-tag1，值为value1
		"x-oss-meta-tag2": "value2", // 元数据key为x-oss-meta-tag2，值为value2
	}

	// 创建复制对象请求
	copyRequest := &oss.CopyObjectRequest{
		Bucket:            oss.Ptr(destBucketName), // 目标存储空间名称
		Key:               oss.Ptr(destObjectName), // 目标对象名称
		SourceKey:         oss.Ptr(srcObjectName),  // 源对象名称
		SourceBucket:      oss.Ptr(srcBucketName),  // 源存储空间名称
		Metadata:          metaData,                // 填写实际的目标对象的元数据
		MetadataDirective: oss.Ptr("Replace"),      // 不拷贝源对象的元数据
	}

	// 执行复制对象操作并处理结果
	copyResult, err := client.CopyObject(context.TODO(), copyRequest)
	if err != nil {
		log.Fatalf("failed to copy object: %v", err)
	}

	log.Printf("copy object result versionId:%#v\n", copyResult)

}

使用拷贝管理器Copier.Copy方法修改对象元数据

您可以通过以下代码使用拷贝管理器Copier.Copy方法拷贝源对象时设置目标对象的元数据，包括使用新的元数据替换原来的元数据，清除原来的元数据或者更新指定的部分元数据，在拷贝对象完成后可以选择是否删除源对象。

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定义全局变量
var (
	region         string // 存储区域
	srcBucketName  string // 源存储空间名称
	srcObjectName  string // 源对象名称
	destBucketName string // 目标存储空间名称
	destObjectName string // 目标对象名称
)

// init函数用于初始化命令行参数
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&srcBucketName, "src-bucket", "", "The name of the source bucket.")
	flag.StringVar(&srcObjectName, "src-object", "", "The name of the source object.")
	flag.StringVar(&destBucketName, "dest-bucket", "", "The name of the destination bucket.")
	flag.StringVar(&destObjectName, "dest-object", "", "The name of the destination object.")
}

func main() {
	// 解析命令行参数
	flag.Parse()

	// 检查源存储空间名称是否为空
	if len(srcBucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name required")
	}

	// 检查存储区域是否为空
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 如果目标存储空间名称未指定，则使用源存储空间名称
	if len(destBucketName) == 0 {
		destBucketName = srcBucketName
	}

	// 检查源对象名称是否为空
	if len(srcObjectName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, src object name required")
	}

	// 检查目标对象名称是否为空
	if len(destObjectName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, destination object name required")
	}

	// 配置OSS客户端
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 创建OSS客户端
	client := oss.NewClient(cfg)

	// 创建文件拷贝器
	c := client.NewCopier()

	// 设置目标对象的元数据
	metaData := map[string]string{
		"x-oss-meta-tag1": "value1",
		"x-oss-meta-tag2": "value2",
	}
	// 构建拷贝对象的请求
	copyRequest := &oss.CopyObjectRequest{
		Bucket:       oss.Ptr(destBucketName), // 目标存储空间名称
		Key:          oss.Ptr(destObjectName), // 目标对象名称
		SourceKey:    oss.Ptr(srcObjectName),  // 源对象名称
		SourceBucket: oss.Ptr(srcBucketName),  // 源存储空间名称
		Metadata:     metaData,                // 填写目标对象的元数据
		MetadataDirective: oss.Ptr("Replace"),  // 不拷贝源对象的元数据
	}

	// 执行拷贝对象的操作
	result, err := c.Copy(context.TODO(), copyRequest)
	if err != nil {
		log.Fatalf("failed to copy object %v", err) // 如果拷贝失败，记录错误并退出
	}

	// 构建删除对象的请求
	deleteRequest := &oss.DeleteObjectRequest{
		Bucket: oss.Ptr(srcBucketName), // 存储空间名称
		Key:    oss.Ptr(srcObjectName), // 要删除的对象名称
	}

	// 执行删除对象的操作
	deleteResult, err := client.DeleteObject(context.TODO(), deleteRequest)
	if err != nil {
		log.Fatalf("failed to delete multiple objects %v", err)
	}

	// 打印拷贝对象的结果
	log.Printf("copy object result:%#v\n", result)
	// 打印删除对象的结果
	log.Printf("delete objects result:%#v\n", deleteResult)
}

Go管理文件元数据

注意事项

上传文件时设置元数据

上传文件时设置元数据

获取文件元数据

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

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

修改已有文件的元数据

使用CopyObject方法修改对象元数据

使用拷贝管理器Copier.Copy方法修改对象元数据

相关文档