本文介紹如何使用OSS Go SDK設置和獲取文件元數據。
注意事項
本文示例代碼以華東1(杭州)的地域ID
cn-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(®ion, "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(®ion, "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(®ion, "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(®ion, "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(®ion, "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)
}