javascript - 如何从 Node js api 返回 zip 文件并在客户端处理？

Question

我有一个 API，它使用归档器模块创建一个 zip 文件，我想在其中将 zip 作为响应传回并在客户端下载。

这是我创建 zip 的 API 的样子:

reports.get('/xxx/:fileName', async (req, res) => {

  var s3 = new AWS.S3();
  var archiver = require('archiver');

  var filenames = "xxx"
  var str_array = filenames.split(','); 

  for (var i = 0; i < str_array.length; i++) {

    var filename = str_array[i].trim();
    localFileName = './temp/' + filename.substring(filename.indexOf("/") + 1);

    file = fs.createWriteStream(localFileName, {flags: 'a', encoding: 'utf-8',mode: 0666});
    file.on('error', function(e) { console.error(e); });

    s3.getObject({
          Bucket: config.xxx,
          Key: filename
      })
      .on('error', function (err) {
          console.log(err);
      })
      .on('httpData', function (chunk) {
          file.on('open', function(){

            file.write(chunk);
          });
      })
      .on('httpDone', function () {
          file.end();
      })
      .send();
  }
    res.end("Files have been downloaded successfully")

    // create a file to stream archive data to.
    var output = fs.createWriteStream('example.zip');
    var archive = archiver('zip', {
      zlib: { level: 9 } // Sets the compression level.
    });

    // listen for all archive data to be written
    // 'close' event is fired only when a file descriptor is involved
    output.on('close', function() {
      console.log(archive.pointer() + ' total bytes');
      console.log('archiver has been finalized and the output file descriptor has closed.');
    });

    // This event is fired when the data source is drained no matter what was the data source.
    // It is not part of this library but rather from the NodeJS Stream API.
    // @see: https://nodejs.org/api/stream.html#stream_event_end
    output.on('end', function() {
      console.log('Data has been drained');
    });

    // good practice to catch warnings (ie stat failures and other non-blocking errors)
    archive.on('warning', function(err) {
      if (err.code === 'ENOENT') {
        // log warning
      } else {
        // throw error
        throw err;
      }
    });

    // good practice to catch this error explicitly
    archive.on('error', function(err) {
      throw err;
    });

    // pipe archive data to the file
    archive.pipe(output);

    // append files from a sub-directory, putting its contents at the root of archive
    archive.directory('./temp', false);

    // finalize the archive (ie we are done appending files but streams have to finish yet)
    // 'close', 'end' or 'finish' may be fired right after calling this method so register to them beforehand
    archive.finalize();

});

这里还提供了我的另一个 API 以供引用，以展示我习惯如何将数据发送回客户端:

reports.get('/xxx/:fileName', async (req, res) => {

  var s3 = new AWS.S3();

  var params = { 
    Bucket: config.reportBucket,
    Key: req.params.fileName,
    Expires: 60 * 5
  }

  try {
    s3.getSignedUrl('getObject', params, function (err, url) {
      if(err)throw err;
      res.json(url);
    });
  }catch (err) {
    res.status(500).send(err.toString());
  }
});

如何将 zip 作为响应发回并在客户端将其下载到磁盘？

Answer 1

由于 archive 是流式传输，我假设它可以通过管道(内衬)直接传输到响应 (res):

// Node.js v10+, if res is a proper stream
const {pipeline} = require('stream')
pipeline(archive, res)

// Alternatively (search for caveats of pipe vs. pipeline)
archive.pipe(res)

您可能应该在 res 上设置一些 HTTP header ，以告知浏览器 MIME 类型和可能的文件名:

res.set({
  'Content-Type': 'application/zip',
  'Content-Disposition': 'attachment; filename="zip"'
})