非同步處理(x-oss-async-process)是指程式執行一個任務時,不需要等待該任務完成就能繼續執行其他任務。本文介紹如何使用C# SDK V2進行非同步處理文檔轉換的情境。
注意事項
本文範例程式碼以華東1(杭州)的地區IDcn-hangzhou為例,預設使用外網Endpoint,如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱。
範例程式碼
以下代碼展示了如何使用C# SDK V2進行文檔格式轉換,將其轉換為需要的輸出類型。
using System.Text;
using OSS = AlibabaCloud.OSS.V2; // 為阿里雲OSS SDK建立別名,簡化後續使用
var region = "cn-hangzhou"; // 必須項,設定Bucket所在的地區(Region)。以華東1(杭州)為例,Region填寫為cn-hangzhou
var endpoint = null as string; // 可選項,指定訪問OSS服務的網域名稱。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com
var bucket = "your bucket name"; // 必須項,Bucket名稱
var key = "your object key"; // 必須項,需轉換的目標對象名稱
// 載入OSS SDK的預設配置,此配置會自動從環境變數中讀取憑證資訊(如AccessKey)
var cfg = OSS.Configuration.LoadDefault();
// 顯式設定使用環境變數擷取憑證,用於身分識別驗證(格式:OSS_ACCESS_KEY_ID、OSS_ACCESS_KEY_SECRET)
cfg.CredentialsProvider = new OSS.Credentials.EnvironmentVariableCredentialsProvider();
// 設定配置的Bucket地區
cfg.Region = region;
// 若已指定了endpoint,則覆蓋預設的endpoint
if(endpoint != null)
{
cfg.Endpoint = endpoint;
}
// 使用配置資訊建立OSS用戶端執行個體
using var client = new OSS.Client(cfg);
// 指定儲存轉換後檔案的目標Bucket
var targetBucket = bucket!;
// 指定轉換後檔案的Key,添加"process-"首碼以便區分
var targetKey = $"process-{key}";
// 構建文檔處理樣式字串,定義文檔轉換處理參數
// 此處配置將源Docx文檔轉換為PNG圖片的處理規則
// 格式說明:doc/convert,target_{目標格式},source_{源格式}
var style = "doc/convert,target_png,source_docx";
// 將目標Bucket名稱進行Base64編碼
var targetNameBase64 = Convert.ToBase64String(Encoding.UTF8.GetBytes(targetBucket));
// 將目標Key進行Base64編碼
var targetKeyBase64 = Convert.ToBase64String(Encoding.UTF8.GetBytes(targetKey));
// 構建完整的處理指示:
// 1. 先應用文檔轉換樣式(doc/convert)
// 2. 使用sys/saveas操作儲存結果
// - b_{base64編碼的Bucket名稱} 指定目標Bucket
// - o_{base64編碼的Key} 指定目標Key
// - /notify 啟用非同步處理模式
var process = $"{style}|sys/saveas,b_{targetNameBase64},o_{targetKeyBase64}/notify";
// 調用AsyncProcessObjectAsync方法執行文檔轉換
var result = await client.AsyncProcessObjectAsync(new OSS.Models.AsyncProcessObjectRequest()
{
Bucket = bucket,
Key = key,
Process = process
});
// 列印結果資訊
Console.WriteLine("AsyncProcessObject done"); // 提示操作完成
Console.WriteLine($"StatusCode: {result.StatusCode}"); // HTTP狀態代碼
Console.WriteLine($"RequestId: {result.RequestId}"); // RequestId,用於阿里雲排查問題
Console.WriteLine("Response Headers:"); // 回應標頭資訊
result.Headers.ToList().ForEach(x => Console.WriteLine(x.Key + " : " + x.Value)); // 遍曆並列印所有回應標頭
Console.WriteLine($"ProcessResult: {result.ProcessResult}"); // 輸出處理結果相關文檔
關於非同步處理功能的更多資訊,請參見非同步處理。
關於非同步處理功能的完整範例程式碼,請參見AsyncProcessObject.cs。