本文針對大檔案的傳輸情境,介紹如何使用Go SDK V2新增的Copier模組進行檔案拷貝。
注意事項
本文範例程式碼以華東1(杭州)的地區ID
cn-hangzhou為例,預設使用外網Endpoint,如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱。本文以從環境變數讀取存取憑證為例。如何配置訪問憑證,請參見配置訪問憑證。
要進行拷貝檔案,您必須擁有源檔案的讀許可權及目標Bucket的讀寫權限。
不支援跨地區拷貝。例如不能將華東1(杭州)地區儲存空間中的檔案拷貝到華北1(青島)地區。
拷貝檔案時,您需要確保源Bucket和目標Bucket均未設定合規保留原則,否則報錯The object you specified is immutable.。
方法定義
拷貝管理器介紹
當需要將對象從儲存空間複製到另外一個儲存空間,或者修改對象的屬性時,您可以通過拷貝介面或者分區拷貝介面來完成這個操作。這兩個介面有其適用的情境,例如:
拷貝介面(CopyObject)只適合拷貝 5GiB 以下的對象;
分區拷貝介面(UploadPartCopy)支援拷貝大於5GiB 的對象,但不支援中繼資料指令(x-oss-metadata-directive)和標籤指令(x-oss-tagging-directive)參數,拷貝時需要主動設定需要複製的中繼資料和標籤。
Go SDK V2新增拷貝管理器Copier提供了通用的拷貝介面,隱藏了介面的差異和實現細節,可根據拷貝的請求參數自動選擇合適的介面複製對象。Copier的常用方法定義如下:
type Copier struct {
...
}
// 用於建立新的拷貝管理器
func (c *Client) NewCopier(optFns ...func(*CopierOptions)) *Copier
// // 用於拷貝檔案
func (c *Copier) Copy(ctx context.Context, request *CopyObjectRequest, optFns ...func(*CopierOptions)) (*CopyResult, error)請求參數列表
參數名 | 類型 | 說明 |
ctx | context.Context | 請求的上下文,可以用來佈建要求的總時限 |
request | *CopyObjectRequest | 設定具體介面的請求參數,具體請參見CopyObjectRequest |
optFns | ...func(*CopierOptions) | (可選)配置選項,具體請參見CopierOptions |
其中,CopyObjectRequest的常用參數列舉如下:
參數名 | 類型 | 說明 |
Bucket | *string | 指定目標儲存空間名稱 |
Key | *string | 指定目標對象名稱 |
SourceBucket | *string | 指定源儲存空間名稱 |
SourceKey | *string | 指定來源物件名稱 |
ForbidOverwrite | *string | 指定CopyObject操作時是否覆蓋同名目標Object |
Tagging | *string | 指定Object的對象標籤,可同時設定多個標籤,例如TagA=A&TagB=B。 |
TaggingDirective | *string | 指定如何設定目標Object的對象標籤。取值如下:
|
CopierOptions選項的常用參數列舉如下:
參數名 | 類型 | 說明 |
PartSize | int64 | 指定分區大小,預設值為 64MiB |
ParallelNum | int | 指定上傳任務的並發數,預設值為 3。針對的是單次調用的並發限制,而不是全域的並發限制 |
MultipartCopyThreshold | int64 | 使用分區拷貝的閾值,預設值為 200MiB |
LeavePartsOnError | bool | 當拷貝失敗時,是否保留已拷貝的分區,預設不保留 |
DisableShallowCopy | bool | 不使用淺拷貝行為,預設使用 |
傳回值列表
傳回值名 | 類型 | 說明 |
result | *CopyResult | 介面傳回值,當 err 為nil 時有效,具體請參見CopyResult |
err | error | 請求的狀態,當請求失敗時,err 不為 nil |
範例程式碼
您可以使用以下代碼將對象從源儲存空間拷貝到目標儲存空間並修改對象的屬性。
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()
// 構建拷貝對象的請求
request := &oss.CopyObjectRequest{
Bucket: oss.Ptr(destBucketName), // 目標儲存空間名稱
Key: oss.Ptr(destObjectName), // 目標對象名稱
SourceKey: oss.Ptr(srcObjectName), // 來源物件名稱
SourceBucket: oss.Ptr(srcBucketName), // 源儲存空間名稱
StorageClass: oss.StorageClassStandard, // 指定儲存類型為標準類型
MetadataDirective: oss.Ptr("Replace"), // 不拷貝來源物件中繼資料
TaggingDirective: oss.Ptr("Replace"), // 不拷貝來源物件標籤
}
// 執行拷貝對象的操作
result, err := c.Copy(context.TODO(), request)
if err != nil {
log.Fatalf("failed to copy object %v", err) // 如果拷貝失敗,記錄錯誤並退出
}
// 列印拷貝對象的結果
log.Printf("copy object result:%#v\n", result)
}