6-2 Node.js 文件模块

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只有一个执行线程。

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,519评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,842评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,544评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,742评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,646评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,027评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,169评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,324评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,268评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,299评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,996评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,591评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,911评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,288评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,871评论 2 341

推荐阅读更多精彩内容

  • Node.js是目前非常火热的技术,但是它的诞生经历却很奇特。 众所周知,在Netscape设计出JavaScri...
    w_zhuan阅读 3,606评论 2 41
  • Node.js是目前非常火热的技术,但是它的诞生经历却很奇特。 众所周知,在Netscape设计出JavaScri...
    Myselfyan阅读 4,060评论 2 58
  • 文件系统模块是一个封装了标准的 POSIX 文件 I/O 操作的集合。通过require('fs')使用这个模块。...
    保川阅读 771评论 0 0
  • 模块化公布自己的模块功能. 其他模块调用另外的模块. 公布方法 如果要输出一个键值对象{},可以利用exports...
    httIsHere阅读 507评论 0 0
  • 人的一生中总会遇到几个“傻瓜”,他们是最不值得怀念的,却偏偏留在了记忆的最深处。 上大学时,有一个关系还不错的女孩...
    雨天不见阅读 266评论 2 3