非同步處理(x-oss-async-process)是指程式執行一個任務時,不需要等待該任務完成就能繼續執行其他任務。本文介紹如何使用Go SDK V2進行非同步處理的情境,例如文檔轉換、視頻轉碼、視頻拼接等。
注意事項
本文範例程式碼以華東1(杭州)的地區ID
cn-hangzhou為例,預設使用外網Endpoint,如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱。本文以從環境變數讀取存取憑證為例。如何配置訪問憑證,請參見配置訪問憑證。
方法定義
func (c *Client) AsyncProcessObject(ctx context.Context, request *AsyncProcessObjectRequest, optFns ...func(*Options)) (*AsyncProcessObjectResult, error)請求參數列表
參數名 | 類型 | 說明 |
ctx | context.Context | 請求的上下文,可以用來佈建要求的總時限 |
request | *AsyncProcessObjectRequest | 設定具體介面的請求參數,具體請參見AsyncProcessObjectRequest |
optFns | ...func(*Options) | (可選)介面級的配置參數, 具體請參見Options |
傳回值列表
傳回值名 | 類型 | 說明 |
result | *AsyncProcessObjectResult | 介面傳回值,當 err 為nil 時有效,具體請參見AsyncProcessObjectResult |
err | error | 請求的狀態,當請求失敗時,err 不為 nil |
範例程式碼
以下代碼展示了如何使用Go SDK V2進行文檔格式轉換,將其轉換為需要的輸出類型。
package main
import (
"context"
"encoding/base64"
"flag"
"fmt"
"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函數在main函數之前執行,用來初始化程式
func init() {
// 設定命令列參數來指定region
flag.StringVar(®ion, "region", "", "The region in which the bucket is located.")
// 設定命令列參數來指定bucket名稱
flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
// 設定命令列參數來指定需要進行轉換的文檔名稱
flag.StringVar(&objectName, "object", "", "The name of the object.")
}
func main() {
flag.Parse() // 解析命令列參數
// 檢查是否提供了地區資訊,如果沒有提供,則輸出預設參數並退出程式
if len(region) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, region required")
}
// 檢查是否提供了儲存空間名稱,如果沒有提供,則輸出預設參數並退出程式
if len(bucketName) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, bucket name required")
}
// 檢查是否提供了對象名稱,如果沒有提供,則輸出預設參數並退出程式
if len(objectName) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, object name required")
}
// 建立設定物件,並使用環境變數作為憑證提供者和指定的地區
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
client := oss.NewClient(cfg) // 使用配置建立一個新的OSS用戶端
// 指定轉換後的檔案名稱
targetKey := "dest.png"
// 構建文檔處理樣式字串以及文檔轉換處理參數
animationStyle := "doc/convert,target_png,source_docx" // 定義將源Docx文檔轉換為PNG圖片的處理規則
// 構建處理指示,包括儲存路徑和Base64編碼的Bucket名稱和目標檔案名稱
bucketNameEncoded := base64.URLEncoding.EncodeToString([]byte(bucketName))
targetKeyEncoded := base64.URLEncoding.EncodeToString([]byte(targetKey))
process := fmt.Sprintf("%s|sys/saveas,b_%v,o_%v/notify", animationStyle, bucketNameEncoded, targetKeyEncoded)
// 構建一個AsyncProcessObject請求,用於發起對特定對象的非同步處理
request := &oss.AsyncProcessObjectRequest{
Bucket: oss.Ptr(bucketName), // 指定要操作的儲存空間名稱
Key: oss.Ptr(objectName), // 指定要處理的文檔名稱
AsyncProcess: oss.Ptr(process),
}
// 執行請求以非同步處理對象,並接收返回結果
result, err := client.AsyncProcessObject(context.TODO(), request)
if err != nil {
log.Fatalf("failed to async process object %v", err)
}
log.Printf("async process object result:%#v\n", result)
}
常見使用情境
相關文檔
關於非同步處理功能的更多資訊,請參見非同步處理。
關於非同步處理功能的API介面,請參見AsyncProcessObject。