Harmony简单下载_对象存储(OSS)-阿里云帮助中心

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

注意事项

关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。
要将文件下载到本地，您必须有oss:GetObject权限。具体操作，请参见为RAM用户授权自定义的权限策略。

示例代码

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

import Client, { RequestError } from '@aliyun/oss';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为STS临时访问凭证的Access Key ID
  accessKeyId: 'yourAccessKeyId',
  // 请替换为STS临时访问凭证的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 请替换为STS临时访问凭证的Security Token
  securityToken: 'yourSecurityToken',
  // 填写Bucket所在地域。以华东1（杭州）为例，Region填写为oss-cn-hangzhou
  region: 'oss-cn-hangzhou',
});

// 指定要操作的Bucket名称，请替换为您实际使用的Bucket名称
const bucket = 'yourBucketName';
// 指定要下载的对象（文件）名称，请替换为您实际要下载的对象名称
const key = 'yourObjectName';

/**
 * 下载文件。
 * 使用getObject方法从指定的Bucket和Key下载文件，文件内容通过res.data返回，数据类型为ArrayBuffer。
 */
const getObject = async () => {
  try {
    // 调用getObject方法下载指定的Bucket和Key的对象
    const res = await client.getObject({
      bucket, // Bucket名称
      key,    // 对象（文件）名称
    });

    // 获取文件内容，数据类型为ArrayBuffer
    const buf: ArrayBuffer = res.data!;

    // 打印下载结果
    console.log(JSON.stringify(res));
  } catch (err) {
    // 捕获请求过程中的异常信息
    if (err instanceof RequestError) {
      // 如果是已知类型的错误，则打印错误代码、错误消息、请求ID、状态码、EC码等信息
      console.log('code: ', err.code); // 错误代码
      console.log('message: ', err.message); // 错误消息
      console.log('requestId: ', err.requestId); // 请求ID
      console.log('status: ', err.status); // HTTP状态码
      console.log('ec: ', err.ec); // 错误码
    } else {
      // 打印其他未知类型的错误
      console.log('unknown error: ', err);
    }
  }
};

// 调用getObject函数执行文件下载操作
getObject();

常见使用场景

下载到本地文件

import Client, { RequestError } from '@aliyun/oss';
import { fileIo as fs } from '@kit.CoreFileKit';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为STS临时访问凭证的Access Key ID
  accessKeyId: 'yourAccessKeyId',
  // 请替换为STS临时访问凭证的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 请替换为STS临时访问凭证的Security Token
  securityToken: 'yourSecurityToken',
  // 填写Bucket所在地域。以华东1（杭州）为例，Region填写为oss-cn-hangzhou
  region: 'oss-cn-hangzhou',
});

// 指定要操作的Bucket名称，请替换为您实际使用的Bucket名称
const bucket = 'yourBucketName';
// 指定要下载的对象（文件）名称，请替换为您实际要下载的对象名称
const key = 'yourObjectName';

/**
 * 将文件内容通过流接收并保存到本地文件。
 * 使用getObject方法将文件内容通过流写入到指定的本地文件路径。
 */
const downloadToFile = async () => {
  // 创建一个写入流，用于将文件内容保存到本地
  const writeStream = await fs.createStream('yourFilePath', 'w'); // 请替换为实际的本地文件路径

  try {
    // 调用getObject方法下载文件，并通过writeStream接收文件内容
    const res = await client.getObject({
      bucket, // Bucket名称
      key,    // 对象（文件）名称
      writeStream, // 写入流，用于将文件内容保存到本地
    });

    // 注意：res.data为undefined，因为数据是通过流接收的
    console.log(JSON.stringify(res));
  } catch (err) {
    // 捕获请求过程中的异常信息
    if (err instanceof RequestError) {
      // 如果是已知类型的错误，则打印错误代码、错误消息、请求ID、状态码、EC码等信息
      console.log('code: ', err.code); // 错误代码
      console.log('message: ', err.message); // 错误消息
      console.log('requestId: ', err.requestId); // 请求ID
      console.log('status: ', err.status); // HTTP状态码
      console.log('ec: ', err.ec); // 错误码
    } else {
      // 打印其他未知类型的错误
      console.log('unknown error: ', err);
    }
  } finally {
    // 确保在操作完成后关闭写入流
    await writeStream.close();
  }
};

// 调用downloadToFile函数执行文件下载并保存到本地的操作
downloadToFile();