美文网首页
Node内置模块 - fs

Node内置模块 - fs

作者: 你喜欢吃青椒吗_c744 | 来源:发表于2019-08-23 10:43 被阅读0次

    学习于廖雪峰的官方网站

    Node.js内置的fs模块就是文件系统模块,负责读写文件

    和所有其它JavaScript模块不同的是,fs模块同时提供了异步和同步的方法。

    异步读取文件

    按照JavaScript的标准,异步读取一个文本文件的代码如下:

    'use strict';
    
    var fs = require('fs');
    
    fs.readFile('sample.txt', 'utf-8', function (err, data) {
        if (err) {
            console.log(err);
        } else {
            console.log(data);
        }
    });
    

    请注意,sample.txt文件必须在当前目录下,且文件编码为utf-8

    异步读取时,传入的回调函数接收两个参数,当正常读取时,err参数为null,data参数为读取到的String。当读取发生错误时,err参数代表一个错误对象,data为undefined。这也是Node.js标准的回调函数:第一个参数代表错误信息,第二个参数代表结果。后面我们还会经常编写这种回调函数。

    由于err是否为null就是判断是否出错的标志,所以通常的判断逻辑总是:

    if (err) {
        // 出错了
    } else {
        // 正常
    }
    

    如果我们要读取的文件不是文本文件,而是二进制文件,怎么办?

    下面的例子演示了如何读取一个图片文件:

    'use strict';
    
    var fs = require('fs');
    
    fs.readFile('sample.png', function (err, data) {
        if (err) {
            console.log(err);
        } else {
            console.log(data);
            console.log(data.length + ' bytes');
        }
    });
    

    当读取二进制文件时,不传入文件编码时,回调函数的data参数将返回一个Buffer对象。在Node.js中,Buffer对象就是一个包含零个或任意个字节的数组(注意和Array不同)。

    Buffer对象可以和String作转换,例如,把一个Buffer对象转换成String:

    // Buffer -> String
    var text = data.toString('utf-8');
    console.log(text);
    

    或者把一个String转换成Buffer:

    // String -> Buffer
    var buf = Buffer.from(text, 'utf-8');
    console.log(buf);
    

    同步读文件

    除了标准的异步读取模式外,fs也提供相应的同步读取函数。同步读取的函数和异步函数相比,多了一个Sync后缀,并且不接收回调函数,函数直接返回结果。

    'use strict';
    
    var fs = require('fs');
    
    var data = fs.readFileSync('sample.txt', 'utf-8');
    console.log(data);
    
    

    可见,原异步调用的回调函数的data被函数直接返回,函数名需要改为readFileSync,其它参数不变。

    如果同步读取文件发生错误,则需要用try...catch捕获该错误:

    try {
        var data = fs.readFileSync('sample.txt', 'utf-8');
        console.log(data);
    } catch (err) {
        // 出错了
    }
    

    写文件

    将数据写入文件是通过fs.writeFile()实现的:

    'use strict';
    
    var fs = require('fs');
    
    var data = 'Hello, Node.js';
    fs.writeFile('output.txt', data, function (err) {
        if (err) {
            console.log(err);
        } else {
            console.log('ok.');
        }
    });
    

    writeFile()的参数依次为文件名、数据和回调函数。如果传入的数据是String,默认按UTF-8编码写入文本文件,如果传入的参数是Buffer,则写入的是二进制文件。回调函数由于只关心成功与否,因此只需要一个err参数。

    readFile()类似,writeFile()也有一个同步方法,叫writeFileSync():

    'use strict';
    
    var fs = require('fs');
    
    var data = 'Hello, Node.js';
    fs.writeFileSync('output.txt', data);
    

    stat 返回文件详细信息

    如果我们要获取文件大小,创建时间等信息,可以使用fs.stat(),它返回一个Stat对象,能告诉我们文件或目录的详细信息:

    'use strict';
    
    var fs = require('fs');
    
    fs.stat('sample.txt', function (err, stat) {
        if (err) {
            console.log(err);
        } else {
            // 是否是文件:
            console.log('isFile: ' + stat.isFile());
            // 是否是目录:
            console.log('isDirectory: ' + stat.isDirectory());
            if (stat.isFile()) {
                // 文件大小:
                console.log('size: ' + stat.size);
                // 创建时间, Date对象:
                console.log('birth time: ' + stat.birthtime);
                // 修改时间, Date对象:
                console.log('modified time: ' + stat.mtime);
            }
        }
    });
    
    运行结果如下:
    isFile: true
    isDirectory: false
    size: 181
    birth time: Fri Dec 11 2015 09:43:41 GMT+0800 (CST)
    modified time: Fri Dec 11 2015 12:09:00 GMT+0800 (CST)
    

    stat()也有一个对应的同步函数statSync()。

    异步同步如何区别使用

    fs模块中,提供同步方法是为了方便使用。那我们到底是应该用异步方法还是同步方法呢?

    由于Node环境执行的JavaScript代码是服务器端代码,所以,绝大部分需要在服务器运行期反复执行业务逻辑的代码,必须使用异步代码,否则,同步代码在执行时期,服务器将停止响应,因为JavaScript只有一个执行线程。

    服务器启动时如果需要读取配置文件,或者结束时需要写入到状态文件时,可以使用同步代码,因为这些代码只在启动和结束时执行一次,不影响服务器正常运行时的异步执行。

    相关文章

      网友评论

          本文标题:Node内置模块 - fs

          本文链接:https://www.haomeiwen.com/subject/xokzsctx.html