使用节点fs从AWS S3存储桶读取文件

79

我正在尝试使用以下命令读取aws s3存储桶中的文件 

fs.readFile(file, function (err, contents) {
  var myLines = contents.Body.toString().split('\n')
})

我已经能够使用节点aws-sdk下载和上传文件，但是我对如何简单地读取文件和解析内容感到困惑。

这是我从s3中读取文件的示例：

var s3 = new AWS.S3();
var params = {Bucket: 'myBucket', Key: 'myKey.csv'}
var s3file = s3.getObject(params)
node.js  amazon-web-services  amazon-s3  fs 
— 乔尔
source
4
contents.Body.toString（）代替contents.Body
— Jason

Answers:

90

您有几种选择。您可以包括一个回调作为第二个参数，该参数将与任何错误消息和对象一起调用。该示例直接来自AWS文档：

s3.getObject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

或者，您可以将输出转换为流。AWS文档中还有一个示例：

var s3 = new AWS.S3({apiVersion: '2006-03-01'});
var params = {Bucket: 'myBucket', Key: 'myImageFile.jpg'};
var file = require('fs').createWriteStream('/path/to/file.jpg');
s3.getObject(params).createReadStream().pipe(file);
— 挖
source
如果我还希望使用Promise来更好地进行整体异步处理，该怎么办？
— verveguy
16
@verveguy您可以使用以下各项：new Promise((resolve, reject) => {s3.getObject(params).createReadStream().on('end', () => { return resolve(); }).on('error', (error) => { return reject(error); }).pipe(file)});
— Gustavo Straube
1
@verveguy根据运行的节点版本，aws-sdk版本> 2.3.0将使用本机Promise。您还可以显式配置您要使用的Promise库。 if (typeof Promise === 'undefined') { console.log("Using Bluebird for Promises"); AWS.config.setPromisesDependency(require('bluebird')); }
— alexhb
我们如何知道pipe（）是否已结束，以便在本地写入文件后可以对文件执行其他任务？
— usama
46

这样可以做到：

new AWS.S3().getObject({ Bucket: this.awsBucketName, Key: keyName }, function(err, data)
{
    if (!err)
        console.log(data.Body.toString());
});
— 赖雪
source
23

由于您似乎想逐行处理S3文本文件。这是使用标准readline模块和AWS的createReadStream（）的Node版本

const readline = require('readline');

const rl = readline.createInterface({
    input: s3.getObject(params).createReadStream()
});

rl.on('line', function(line) {
    console.log(line);
})
.on('close', function() {
});
— 杰森
source
1
我认为该end事件被称为close。nodejs.org/api/readline.html#readline_event_close
— Jonathan
3
如果要处理压缩的源文件，也可以s3.getObject(params).createReadStream().pipe(zlib.createGunzip())用作InputStream ...
— Tobi，
8

这是我用来从s3检索和解析json数据的示例。 

    var params = {Bucket: BUCKET_NAME, Key: KEY_NAME};
    new AWS.S3().getObject(params, function(err, json_data)
    {
      if (!err) {
        var json = JSON.parse(new Buffer(json_data.Body).toString("utf8"));

       // PROCESS JSON DATA
           ......
     }
   });
— 德文德拉
source
8

我还不知道为什么，但是createReadStream/pipe方法对我不起作用。我试图下载一个较大的CSV文件（300MB +），却出现重复的行。这似乎是一个随机的问题。每次下载最终文件的大小都会有所不同。

我最终基于AWS JS SDK示例使用了另一种方法：

var s3 = new AWS.S3();
var params = {Bucket: 'myBucket', Key: 'myImageFile.jpg'};
var file = require('fs').createWriteStream('/path/to/file.jpg');

s3.getObject(params).
    on('httpData', function(chunk) { file.write(chunk); }).
    on('httpDone', function() { file.end(); }).
    send();

这样，它就像一个魅力。

— 古斯塔沃·斯特劳布（Gustavo Straube）
source
4

如果要节省内存并希望将每一行作为json对象获取，则可以使用fast-csv创建readstream并将每一行作为json对象读取，如下所示：

const csv = require('fast-csv');
const AWS = require('aws-sdk');

const credentials = new AWS.Credentials("ACCESSKEY", "SECRETEKEY", "SESSIONTOKEN");
AWS.config.update({
    credentials: credentials, // credentials required for local execution
    region: 'your_region'
});
const dynamoS3Bucket = new AWS.S3();
const stream = dynamoS3Bucket.getObject({ Bucket: 'your_bucket', Key: 'example.csv' }).createReadStream();

var parser = csv.fromStream(stream, { headers: true }).on("data", function (data) {
    parser.pause();  //can pause reading using this at a particular row
    parser.resume(); // to continue reading
    console.log(data);
}).on("end", function () {
    console.log('process finished');
});
— 甘加达尔
source
4

我更喜欢Buffer.from(data.Body).toString('utf8')。它支持编码参数。对于其他AWS服务（例如Kinesis Streams），可能有人希望将'utf8'编码替换为'base64'。

new AWS.S3().getObject(
  { Bucket: this.awsBucketName, Key: keyName }, 
  function(err, data) {
    if (!err) {
      const body = Buffer.from(data.Body).toString('utf8');
      console.log(body);
    }
  }
);
— 科斯丁
source
3

从S3下载非常大的文件时，我遇到了完全相同的问题。

AWS文档中的示例解决方案不起作用：

var file = fs.createWriteStream(options.filePath);
        file.on('close', function(){
            if(self.logger) self.logger.info("S3Dataset file download saved to %s", options.filePath );
            return callback(null,done);
        });
        s3.getObject({ Key:  documentKey }).createReadStream().on('error', function(err) {
            if(self.logger) self.logger.error("S3Dataset download error key:%s error:%@", options.fileName, error);
            return callback(error);
        }).pipe(file);

尽管此解决方案将起作用：

    var file = fs.createWriteStream(options.filePath);
    s3.getObject({ Bucket: this._options.s3.Bucket, Key: documentKey })
    .on('error', function(err) {
        if(self.logger) self.logger.error("S3Dataset download error key:%s error:%@", options.fileName, error);
        return callback(error);
    })
    .on('httpData', function(chunk) { file.write(chunk); })
    .on('httpDone', function() { 
        file.end(); 
        if(self.logger) self.logger.info("S3Dataset file download saved to %s", options.filePath );
        return callback(null,done);
    })
    .send();

由于某种原因，该createReadStream尝试不会触发或回调。看到这里。endcloseerror

我也使用该解决方案将存档记录到gzip，因为第一个（AWS示例）在这种情况下也不起作用：

        var gunzip = zlib.createGunzip();
        var file = fs.createWriteStream( options.filePath );

        s3.getObject({ Bucket: this._options.s3.Bucket, Key: documentKey })
        .on('error', function (error) {
            if(self.logger) self.logger.error("%@",error);
            return callback(error);
        })
        .on('httpData', function (chunk) {
            file.write(chunk);
        })
        .on('httpDone', function () {

            file.end();

            if(self.logger) self.logger.info("downloadArchive downloaded %s", options.filePath);

            fs.createReadStream( options.filePath )
            .on('error', (error) => {
                return callback(error);
            })
            .on('end', () => {
                if(self.logger) self.logger.info("downloadArchive unarchived %s", options.fileDest);
                return callback(null, options.fileDest);
            })
            .pipe(gunzip)
            .pipe(fs.createWriteStream(options.fileDest))
        })
        .send();
— 洛雷托帕里西
source
2

对于新版本的sdk，接受的答案不起作用-它不等待对象被下载。以下代码段将对新版本有所帮助：

// dependencies

const AWS = require('aws-sdk');

// get reference to S3 client

const s3 = new AWS.S3();

exports.handler = async (event, context, callback) => {

var bucket = "TestBucket"

var key = "TestKey"

   try {

      const params = {
            Bucket: Bucket,
            Key: Key
        };

       var theObject = await s3.getObject(params).promise();

    } catch (error) {
        console.log(error);
        return;
    }  
}
— 里彭·巴尼克（Ripon Banik）
source
var theObject =等待s3.getObject（params）.promise（）这是正确的方法。谢谢
— 欢乐
0

如果您希望避免回调，则可以使用sdk .promise（）函数，如下所示：

const s3 = new AWS.S3();
const params = {Bucket: 'myBucket', Key: 'myKey.csv'}
const response = await s3.getObject(params).promise() // await the promise
const fileContent = getObjectResult.Body.toString('utf-8'); // can also do 'base64' here if desired

我敢肯定，这里提到的其他方法也有其优点，但这对我很有用。源自此线程（请参阅AWS的最新回复）：https : //forums.aws.amazon.com/thread.jspa? threadID =116788

— 莱安德
source
1
最后一行中的getObjectResult是什么？
— Felipe Deveza
0 
var fileStream = fs.createWriteStream('/path/to/file.jpg');
var s3Stream = s3.getObject({Bucket: 'myBucket', Key: 'myImageFile.jpg'}).createReadStream();

// Listen for errors returned by the service
s3Stream.on('error', function(err) {
    // NoSuchKey: The specified key does not exist
    console.error(err);
});

s3Stream.pipe(fileStream).on('error', function(err) {
    // capture any errors that occur when writing data to the file
    console.error('File Stream:', err);
}).on('close', function() {
    console.log('Done.');
});

参考：https : //docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/requests-using-stream-objects.html

— psuhas
source
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.