下载文件到内存(C# SDK V2)

本文介绍如何通过简单下载方法将存储空间(Bucket)中的文件(Object)下载到本地内存,此方法操作简便,适合快速将云端存储的文件下载到本地内存中。

注意事项

本文示例代码以华东1(杭州)的地域IDcn-hangzhou为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的RegionEndpoint的对应关系,请参见OSS地域和访问域名

权限说明

阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限,需要阿里云账号或账号管理员通过RAM PolicyBucket Policy授予操作权限。

API

Action

说明

GetObject

oss:GetObject

下载Object。

oss:GetObjectVersion

下载Object时,如果通过versionId指定了Object的版本,则需要授予此操作的权限。

kms:Decrypt

下载Object时,如果Object的元数据包含X-Oss-Server-Side-Encryption: KMS,则需要此操作的权限。

示例代码

您可以使用以下代码将存储空间中的文件下载到本地内存中。

using OSS = AlibabaCloud.OSS.V2; // 为阿里云OSS SDK创建别名,简化后续使用

var region = "cn-hangzhou"; // 必须项,设置Bucket所在的区域(Region)。以华东1(杭州)为例,Region填写为cn-hangzhou
var bucket = "your bucket name";  // 必须项,设置目标Bucket名称 
var endpoint = null as string;  // 可选项,指定访问OSS服务的域名。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com
var key = "your object key"; // 必须项,指定下载的对象名称。格式(folder/objectName)

// 加载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); 

//调用GetObjectAsync方法,默认使用流式模式获取对象,此时仅下载响应头,内容以流的形式返回
var result = await client.GetObjectAsync(new OSS.Models.GetObjectRequest()
{
    Bucket = bucket,
    Key = key,
});

// 若需一次性将内容全部读取到内存,可使用此重载方法
//var result = await client.GetObjectAsync(new OSS.Models.GetObjectRequest() {
//    Bucket = bucket,
//    Key = key,
//},System.Net.Http.HttpCompletionOption.ResponseContentRead);

// 获取响应的内容流
using var body = result.Body;
// 读取数据
var reader = new StreamReader(body!);
// 将流中的全部内容读取为字符串(内容加载到内存中)
var data = reader.ReadToEnd();

// 打印结果信息 
Console.WriteLine("GetObject 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));  // 遍历并打印所有响应头

相关文档

关于简单下载文件到本地内存中的完整示例代码,请参见GetObject.cs