【问题标题】:Node fs.readdir freezing in folders with too many files节点 fs.readdir 在文件过多的文件夹中冻结
【发布时间】:2019-12-09 22:39:42
【问题描述】:

在 Node.js 中我必须读取文件夹中的文件并为每个文件获取文件处理程序信息,这是我使用 fs.readdir 的最简单实现:

FileServer.prototype.listLocal = function (params) {
            var self = this;
            var options = {
                limit: 100,
                desc: 1
            };
            // override defaults
            for (var attrname in params) { options[attrname] = params[attrname]; }

            // media path is the media folder
            var mediaDir = path.join(self._options.mediaDir, path.sep);
            return new Promise((resolve, reject) => {
                fs.readdir(mediaDir, (error, results) => {
                    if (error) {
                        self.logger.error("FileServer.list error:%s", error);
                        return reject(error);
                    } else { // list files
                        // cut to max files
                        results = results.slice(0, options.limit);
                        // filter default ext
                        results = results.filter(item => {
                            return (item.indexOf('.mp3') > -1);
                        });
                        // format meta data
                        results = results.map(file => {
                            var filePath = path.join(self._options.mediaDir, path.sep, file);
                            var item = {
                                name: file,
                                path: filePath
                            };
                            const fd = fs.openSync(filePath, 'r');
                            var fstat = fs.fstatSync(fd);
                            // file size in bytes
                            item.size = fstat.size;
                            item.sizehr = self.formatSizeUnits(fstat.size);
                            // "Birth Time" Time of file creation. Set once when the file is created. 
                            item.birthtime = fstat.birthtime;
                            // "Modified Time" Time when file data last modified.
                            item.mtime = fstat.mtime;
                            // "Access Time" Time when file data last accessed.
                            item.atime = fstat.atime;
                            item.timestamp = new Date(item.mtime).getTime();
                            item.media_id = path.basename(filePath, '.mp3');

                            fs.closeSync(fd);//close file
                            return item;
                        });
                        if (options.desc) { // sort by most recent
                            results.sort(function (a, b) {
                                return b.timestamp - a.timestamp;
                            });
                        } else { // sort by older
                            results.sort(function (a, b) {
                                return a.timestamp - b.timestamp;
                            });
                        }
                        return resolve(results);
                    }
                })
            });
        }

这样对于每个文件,我都会得到一个项目数组

{
  "name": "sample121.mp3",
  "path": "/data/sample121.mp3",
  "size": 5751405,
  "sizehr": "5.4850 MB",
  "birthtime": "2018-10-08T15:26:08.397Z",
  "mtime": "2018-10-08T15:26:11.650Z",
  "atime": "2018-10-10T09:01:48.534Z",
  "timestamp": 1539012371650,
  "media_id": "sample121"
}

也就是说,问题是当要列出的文件夹有大量文件时,node.js fs.readdir 可能会冻结 Node I/O Loop,比如说从一万到十万甚至更多。 这是一个已知问题 - 请参阅 here 了解更多信息。 还计划以某种方式改进 fs.readdir,例如流式传输 - 请参阅 here 了解此内容。

与此同时,我正在寻找一个补丁,因为我的文件夹非常大。 由于问题是事件循环被冻结,有人提出了一个使用process.nextTick 的解决方案,我已经在这里集成了

FileServer.prototype.listLocalNextTick = function (params) {
            var self = this;
            var options = {
                limit: 100,
                desc: 1
            };
            // override defaults
            for (var attrname in params) { options[attrname] = params[attrname]; }

            // media path is the media folder
            var mediaDir = path.join(self._options.mediaDir, path.sep);
            return new Promise((resolve, reject) => {
                var AsyncArrayProcessor = function (inArray, inEntryProcessingFunction) {
                    var elemNum = 0;
                    var arrLen = inArray.length;
                    var ArrayIterator = function () {
                        inEntryProcessingFunction(inArray[elemNum]);
                        elemNum++;
                        if (elemNum < arrLen) process.nextTick(ArrayIterator);
                    }
                    if (elemNum < arrLen) process.nextTick(ArrayIterator);
                }
                fs.readdir(mediaDir, function (error, results) {
                    if (error) {
                        self.logger.error("FileServer.list error:%s", error);
                        return reject(error);
                    }
                    // cut to max files
                    results = results.slice(0, options.limit);
                    // filter default ext
                    results = results.filter(item => {
                        return (item.indexOf('.mp3') > -1);
                    });
                    var ProcessDirectoryEntry = function (file) {
                        // This may be as complex as you may fit in a single event loop
                        var filePath = path.join(self._options.mediaDir, path.sep, file);
                        var item = {
                            name: file,
                            path: filePath
                        };
                        const fd = fs.openSync(filePath, 'r');
                        var fstat = fs.fstatSync(fd);
                        // file size in bytes
                        item.size = fstat.size;
                        item.sizehr = self.formatSizeUnits(fstat.size);
                        // "Birth Time" Time of file creation. Set once when the file is created. 
                        item.birthtime = fstat.birthtime;
                        // "Modified Time" Time when file data last modified.
                        item.mtime = fstat.mtime;
                        // "Access Time" Time when file data last accessed.
                        item.atime = fstat.atime;
                        item.timestamp = new Date(item.mtime).getTime();
                        item.media_id = path.basename(filePath, '.mp3');
                        // map to file item
                        file = item;
                    }//ProcessDirectoryEntry
                    // LP: fs.readdir() callback is finished, event loop continues...
                    AsyncArrayProcessor(results, ProcessDirectoryEntry);
                    if (options.desc) { // sort by most recent
                        results.sort(function (a, b) {
                            return b.timestamp - a.timestamp;
                        });
                    } else { // sort by older
                        results.sort(function (a, b) {
                            return a.timestamp - b.timestamp;
                        });
                    }
                    return resolve(results);
                });
            });
        }//listLocalNextTick

这似乎避免了最初的问题,但我不能再将文件列表映射到我之前使用文件处理程序的项目,因为在文件列表上运行 AsyncArrayProcessor 时,每个文件条目上的 ProcessDirectoryEntry process.nextTick 的异步性质导致我无法取回 results 数组修改为之前的 listLocal 函数,我刚刚对 results 数组进行了迭代 array.map。 如何修补 listLocalNextTick 使其行为类似于 listLocal 但保持 process.nextTick 方法?

[更新]

根据建议的解决方案,这是迄今为止最好的实现:

       /**
         * Scan files in directory
         * @param {String} needle 
         * @param {object} options 
         * @returns {nodeStream}
         */
        scanDirStream : function(needle,params) {
            var options = {
                type: 'f',
                name: '*'
            };
            for (var attrname in params) { options[attrname] = params[attrname]; }
            return new Promise((resolve, reject) => {
                var opt=[needle];
                for (var k in options) {
                    var v = options[k];
                    if (!Util.empty(v)) {
                        opt.push('-' + k);
                        opt.push(v);
                    }
                };
                var data='';
                var listing = spawn('find',opt)
                listing.stdout.on('data', _data => {
                    var buff=Buffer.from(_data, 'utf-8').toString();
                    if(buff!='') data+=buff;
                })
                listing.stderr.on('data', error => {
                    return reject(Buffer.from(error, 'utf-8').toString());
                });
                listing.on('close', (code) => {
                    var res = data.split('\n');
                    return resolve(res);
                });
            });

使用示例:

scanDirStream(mediaRoot,{
        name: '*.mp3'
    })
    .then(results => {
        console.info("files:%d", results);
    })
    .catch(error => {
        console.error("error %s", error);
    });

这最终可以修改为在监听目录中获取新文件时在每个stdout.on 事件中添加一个滴答回调。

【问题讨论】:

    标签: javascript node.js fs


    【解决方案1】:

    我已经为它创建了一个 find 包装器,但您可以以相同的方式使用 dir 或 ls。

    const { spawn } = require('child_process');
    
    /**
     * findNodeStream
     * @param {String} dir 
     * @returns {nodeStream}
     */
    const findNodeStream = (dir,options) => spawn('find',[dir,options].flat().filter(x=>x));
    
    /**
     * Usage Example:
      let listing = findNodeStream('dir',[options])
      listing.stdout.on('data', d=>console.log(d.toString()))
      listing.stderr.on('data', d=>console.log(d.toString()))
      listing.on('close', (code) => {
        console.log(`child process exited with code ${code}`);
      });
    */
    

    这允许您流式传输分块的目录,而不是像 fs.readdir 那样作为一个整体。

    重要

    NodeJS > 12.11.1 将支持异步 readdir 以 fs{Promises}.opendir() 的形式登陆 cbd8d71 (https://github.com/nodejs/node/commit/cbd8d715b2286e5726e6988921f5c870cbf74127),它返回一个 fs.Dir,它公开了一个异步迭代器。多田

    https://nodejs.org/api/fs.html#fs_fspromises_opendir_path_options

    const fs = require('fs');
    
    async function print(path) {
      const dir = await fs.promises.opendir(path);
      for await (const dirent of dir) {
        console.log(dirent.name);
      }
    }
    print('./').catch(console.error);
    

    【讨论】:

    • 谢谢。我已经用这种方法更新了代码。我知道在 Node.js 11 中还有一些改进仍处于试验阶段,但我确实尝试过。
    猜你喜欢
    • 2015-05-08
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2016-01-23
    • 2023-03-13
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多