node中fs内置模块

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

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

回顾一下什么是异步方法。因为JavaScript的单线程模型，执行IO操作时，JavaScript代码无需等待，而是传入回调函数后，继续执行后续JavaScript代码。比如jQuery提供的getJSON()操作：

$.getJSON('http://example.com/ajax', function (data) {

    console.log('IO结果返回后执行...');

});

console.log('不等待IO结果直接执行后续代码...');

而同步的IO操作则需要等待函数返回：

// 根据网络耗时，函数将执行几十毫秒~几秒不等:

var data = getJSONSync('http://example.com/ajax');

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

异步读文件

按照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后缀，并且不接收回调函数，函数直接返回结果。

用fs模块同步读取一个文本文件的代码如下：

'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.');

    }

});

如果将路径写成output/output.txt,那么output文件夹必须在项目工程目录下存在，否则会写入失败，也就是，node不会自动创建output文件夹

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

'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()，请试着改写上述异步代码为同步代码。

//同步获取文件信息

var txtInfo=fs.statSync("output/output1.txt");

console.log(txtInfo);

异步还是同步

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

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

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

下面是练习代码：

'use strict'

var fs=require('fs');//引入fs模块

// 异步读取文件

fs.readFile('txt/test1.txt','utf-8',function(err,data){

    if(err){

        console.log(err);

    }else{

        console.log(data);

    }

})

//异步读取图片   (二进制文件)

fs.readFile("images/touxiang.png",function(err,data){

    if(err){

        console.log(err)

    }else{

        console.log(data);

        console.log(data.length + ' bytes');

        //将buffer对象转化为字符串

        var text = data.toString('utf-8');

        console.log(text);

        // String -> Buffer

        var buf = Buffer.from(text, 'utf-8');

        console.log(buf);

    }

})

try{

    // 同步读取文件

    var dataSync=fs.readFileSync("txt/test1.txt",'utf-8');

    console.log(dataSync)

}catch(err){

    console.log(err)

    console.log("出错了")

}

// 异步写入文件

var dataWrite = 'Hello, Node.js!!';

//根目录下必须存在output文件夹，否则写入会失败

fs.writeFile("output/output1.txt",dataWrite,function(err){

    if(err){

        console.log("写入出错了");

    }else{

        console.log("文件写入成功");

    }

})

//同步写入文件

try{

    fs.writeFileSync("output/output1.txt",dataWrite);

}catch(err){

    console.log("文件同步写入失败");

}

//获取文件信息stat

fs.stat("output/output1.txt",function(err,stat){

    if(err){

        console.log("获取文件信息失败");

        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对象

            console.log(stat);

        }

    }

})

//同步获取文件信息

var txtInfo=fs.statSync("output/output1.txt");

console.log(txtInfo);

巴特西

node中fs内置模块

异步读文件

同步读文件

写文件

stat

异步还是同步

最新文章

热门文章