异步处理(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。
该文章对您有帮助吗?