美文网首页
6-2 Node.js 文件模块

6-2 Node.js 文件模块

作者: 陈小陌丿 | 来源:发表于2016-09-13 17:34 被阅读0次

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

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

    回顾一下什么是异步方法。

    • 因为JavaScript的单线程模型,执行IO操作时,JavaScript代码无需等待,而是传入回调函数后,继续执行后续JavaScript代码。
    // 获取远程 json 数据
    $.getJSON('http://example.com/ajax', function (data) { console.log('IO结果返回后执行...');});
    console.log('不等待IO结果直接执行后续代码...');
    
    • 而同步的IO操作则需要等待函数返回:
      // 根据网络耗时,函数将执行几十毫秒~几秒不等:
    // 获取远程 json 数据
    var data = getJSONSync('http://example.com/ajax');
    

    同步操作的好处是代码简单,缺点是程序将等待IO操作,在等待时间内,无法响应其它任何事件。而异步读取不用等待IO操作,但代码较麻烦。

    异步读文件

    异步读取文件使用的是 fs 模块中的 readFile 方法。

    手册地址
    https://nodejs.org/api/fs.html#fs_fs_readfile_file_options_callback

    最起码 要传入两个参数

    • 文件路径
    • 回调方法

    先创建一个 sample.txt 文本,内容如下

    黄河远上白云间,一片孤城万仞山。
    羌笛何须怨杨柳,春风不度玉门关。
    

    创建读取脚本 fs.js

    // 引入文件系统管理模块
    const FS = require('fs');
    
    // 读取文件
    FS.readFile('sample.txt', 'utf-8', function (err, data) {
        console.log("\n  ====== 读取文件内容 \n");
    
        // 如果报错的话就打印 错误
        if (err) {
            console.log(err);
        // 如果没有错误的话  就输出内容
        } else {
            console.log(data.toString());
        }
        console.log("\n");
    });
    //  当正常读取时,err参数为null,data参数为读取到的String。
    //  传入的回调函数接收两个参数,err  和 data
    //  当读取发生错误时,err参数代表一个错误对象,data为undefined。
    //  这也是Node.js标准的回调函数:第一个参数代表错误信息,第二个参数代表结果。后面我们还会经常编写这种回调函数。
    
    

    同步读文件

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

    案例

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

    异步写文件

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

    文档地址
    https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback

    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参数。

    同步写文件

    同步写入文件是通过fs.writeFileSync()实现的

    文档地址
    https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options

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

    获取文件信息 stat

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

    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);
            }
        }
    });
    

    stat 也有一个同步的函数 statSync

    var fs = require('fs');
    var data = fs.statSync('sample.txt');
    console.log(data);
    

    异步还是同步

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

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

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

    相关文章

      网友评论

          本文标题:6-2 Node.js 文件模块

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