全部产品
Search
文档中心

对象存储 OSS:Node.js流式下载

更新时间:Dec 20, 2023

如果要下载的文件太大,或者一次性下载耗时太长,您可以通过流式下载,一次处理部分内容,直到完成文件的下载。

示例代码

以下代码用于流式下载examplebucket中的exampleobject.txt文件到本地D:\localpath路径下的examplefile.txt文件。

说明

使用getStream下载文件时,返回的Readable Stream用于流式地处理文件内容。

const OSS = require('ali-oss');
const fs = require('fs');

const client = new OSS({
  // yourRegion填写Bucket所在地域。以华东1(杭州)为例,Region填写为oss-cn-hangzhou。
  region: 'yourRegion',
  // 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
  // 填写Bucket名称。
  bucket: 'examplebucket',
});

async function getStream () {
  try {
    // 填写Object完整路径。Object完整路径中不能包含Bucket名称。
    const result = await client.getStream('exampleobject.txt');
    console.log(result);
    // 填写本地文件的完整路径。如果指定的本地文件存在会覆盖,不存在则新建。
    // 如果未指定本地路径,则下载后的文件默认保存到示例程序所属项目对应本地路径中。
    const writeStream = fs.createWriteStream('D:\\localpath\\examplefile.txt'); 
    result.stream.pipe(writeStream);
  } catch (e) {
    console.log(e);
  }
}

getStream()

相关文档

  • 关于流式下载的完整示例代码,请参见GitHub示例

  • 关于流式下载的API接口说明,请参见GetObject