JS-47-Node.js06-fs模块-读写文件

ruleslol

已于 2024-04-24 17:50:37 修改

阅读量1k

点赞数 16

分类专栏： JavaScript 文章标签： javascript node.js 笔记学习

于 2024-04-22 16:58:32 首次发布

本文链接：https://blog.csdn.net/qq_31532983/article/details/137966294

版权

JavaScript 专栏收录该内容

55 篇文章 2 订阅

订阅专栏

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

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

一、回顾：异步方法VS同步方法

1-1、异步方法

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

$.getJSON('http://example.com/ajax', function (data) {
    // 处理data
    console.log('IO结果返回后执行...');
});
console.log('不等待IO结果直接执行后续代码...');

1-2、同步方法

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

// 根据网络耗时，函数将执行几十毫秒~几秒不等:
var data = getJSONSync('http://example.com/ajax');

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

二、fs模块读文件

fs 模块是 Node.js 官方提供的、用来操作文件的模块。

fs.readFile() 方法，用来读取指定文件中的内容；
fs.writeFile() 方法，用来向指定的文件中写入内容。

2-1、异步读文件

1、fs.readFile() 的语法格式

const fs = require('fs');  
  
fs.readFile('/path/to/your/file', 'utf8', (err, data) => {  
  // 如果读取成功，则err的值为null
  if (err) {  
    console.error("读取文件时出错:", err);  
    return;  
  }  
    
  console.log("文件内容:", data);  
});

文件的编码格式，这里使用了 'utf8'，意味着文件内容将以 UTF-8 编码的字符串形式返回。如果你想要得到原始的二进制数据，可以省略这个参数，或者传入 'buffer'。

2、fs.readFile() 示例

按照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
var text = data.toString('utf-8');
console.log(text);

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

2-2、同步读文件

除了标准的异步读取模式外，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()实现的。

如果文件已经存在，该方法会覆盖文件内容；如果文件不存在，则会创建新文件。

3-1、异步写文件

1、fs.writeFile() 的语法格式

const fs = require('fs');  
  
const data = 'Hello, Node.js!';  
const filePath = '/path/to/your/file.txt';  
  
fs.writeFile(filePath, data, 'utf8', (err) => {  
  if (err) {  
    console.error("写入文件时出错:", err);  
    return;  
  }  
    
  console.log("文件写入成功!");  
});

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

3、使用读写方式，实现一个jpg图片的复制

'use strict'

var fs = require('fs');

fs.readFile('./img/flower.jpg', function(err, data){
    if(err){
        console.log('文件读取失败' + err.message);
    }

    console.log(data);

    // 将读出的buffer写入一个文件
    fs.writeFile('./img/writeflower.jpg', data, function(err){
        if(err){
            console.log('文件写入失败' + err.message);
        }
    });
});

结果如下：

注意：

图片的读写，使用buffer对象，若是使用utf8对象，则不能成功，输出的data数据都是乱码！

3-2、同步写文件

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

运行结果如下：

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

'use strict'

var fs = require('fs');
try {
    var stat = fs.statSync('output2.txt');
    console.log(`文件大小: ${stat.size} 字节`);  
    console.log(`文件类型: ${stat.isFile() ? '文件' : '目录'}`);  
    console.log(`创建时间: ${stat.ctime}`);  
} catch (error) {
    console.error(`获取文件状态出错: ${error}`);  
}