如何Go SDK V2設定、擷取檔案中繼資料 - Object Storage Service

本文介紹如何使用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)
}

Object Storage Service：管理檔案中繼資料（Go SDK V2）

注意事項

上傳檔案時設定中繼資料

上傳檔案時設定中繼資料

擷取檔案中繼資料

使用HeadObject方法擷取對象的所有中繼資料

使用GetObjectMeta方法擷取對象的部分中繼資料

修改已有檔案的中繼資料

使用CopyObject方法修改對象中繼資料

使用拷貝管理器Copier.Copy方法修改對象中繼資料

相關文檔