Node.js-fs模块

于 2024-07-05 23:59:16 发布
阅读量1.1k 收藏 18
点赞数 34
分类专栏： Node.js 文章标签： node.js
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2203_75300307/article/details/140220503
版权

fs模块

fs全称为file system，称之为文件系统，是Node.js中的内置模块，可以对计算机中的磁盘进行操作。

1. 文件写入

文件写入就是将数据保存到文件中，我们可以使用如下几个方法来实现该效果

image.png

1.1 writeFile异步写入

  • 语法：fs.writeFile(file, data[, options], callback)

参数说明：

  • file 文件名
  • data 待写入的数据
  • options 选项设置 （可选）
  • callback 写入回调

返回值：undefined

  • 代码示例：
// require 是 Node.js 环境中的'全局'变量，用来导入模块
const fs = require('fs');

//将 『三人行，必有我师焉。』 写入到当前文件夹下的『座右铭.txt』文件中
fs.writeFile('./座右铭.txt', '三人行，必有我师焉。', err => {
//如果写入失败，则回调函数调用时，会传入错误对象，如写入成功，会传入 null
if(err) {
    console.log(写入失败);
    return;  //如果失败，则停止代码
}
    console.log('写入成功')；
});

1.2 writeFileSync 同步写入

  • 语法:fs.writeFileSync(file, data[, options])
  • 参数与 fs.writeFile 大体一致，只是没有 callback 参数
  • 返回值：undefined
  • 代码示例：
try {
    fs.writeFileSync('./座右铭.txt', '三人行，必有我师焉。');
} catch(e) {
    console.log(e);
}

Node.js 中的磁盘操作是由其他线程完成的，结果的处理有两种模式：

  • 同步处理 JavaScript 主线程会等待其他线程的执行结果，然后再继续执行主线程的代码，效率较低
  • 异步处理 JavaScript 主线程不会等待其他线程的执行结果，直接执行后续的主线程代码，效率较好

1.3 appendFile / appendFileSync 追加写入

  • appendFile 作用是在文件尾部追加内容，appendFile 语法与 writeFile 语法完全相同

  • 语法:

fs.appendFile(file, data[, options], callback)

fs.appendFileSync(file, data[, options])

  • 返回值：二者都为undefined

  • 实例代码：

//异步追加
fs.appendFile('./座右铭.txt','择其善者而从之，其不善者而改之。', err => {
if(err) {
    console.log('追加失败');
    return;
}
    console.log('追加成功')
});

//同步追加
//\r\n是换行符
fs.appendFileSync('./座右铭.txt','\r\n温故而知新, 可以为师矣');

1.4 createWriteStream 流式写入

  • 语法：fs.createWriteStream(path[, options])

  • 参数说明：

    • path 文件路径
    • options 选项配置（ 可选 ）
    • 返回值： Object

  • 代码示例：

let ws = fs.createWriteStream('./观书有感.txt');

ws.write('半亩方塘一鉴开\r\n');
ws.write('天光云影共徘徊\r\n');
ws.write('问渠那得清如许\r\n');
ws.write('为有源头活水来\r\n');

ws.end();
  • 程序打开一个文件是需要消耗资源的，流式写入可以减少打开关闭文件的次数。
  • 流式写入方式适用于大文件写入或者频繁写入的场景,writeFile适合于写入频率较低的场景

1.5 写入文件的场景

文件写入在计算机中是一个非常常见的操作，下面的场景都用到了文件写入

  • 下载文件
  • 安装软件
  • 保存程序日志，如 Git
  • 编辑器保存文件
  • 视频录制

当需要持久化保存数据的时候，应该想到文件写入

2. 文件读取

文件读取顾名思义，就是通过程序从文件中取出其中的数据，我们可以使用如下几种方式：

image.png

2.1 readFile 异步读取

语法：fs.readFile(path[, options], callback)

参数说明：

  • path 文件路径
  • options 选项配置
  • callback 回调函数

返回值：undefined

代码示例：

//导入 fs 模块
const fs = require('fs');

fs.readFile('./座右铭.txt', (err, data) => {
    if(err) {
        console.log('error');
        return;
}
        console.log(data);
});

fs.readFile('./座右铭.txt', 'utf-8',(err, data) => {

if(err) {
        console.log('error');
        return;
}
        console.log(data);
});

2.2 readFileSync 同步读取

语法：fs.readFileSync(path[, options])

参数说明：

  • path 文件路径
  • options 选项配置
  • 返回值：string | Buffer

代码示例：

let data = fs.readFileSync('./座右铭.txt');
let data2 = fs.readFileSync('./座右铭.txt', 'utf-8');

2.3 createReadStream 流式读取

语法：fs.createReadStream(path[, options])

参数说明：

  • path 文件路径
  • options 选项配置（ 可选 ）
  • 返回值：Object

代码示例：

//创建读取流对象
let rs = fs.createReadStream('./观书有感.txt');

//每次取出 64k 数据后执行一次 data 回调
rs.on('data', chunk => {
    console.log(data);
    console.log(data.length);
});

//读取完毕后, 执行 end 回调
rs.on('end', () => {
    console.log('读取完成')
})

2.4 读取文件应用场景

  • 电脑开机
  • 程序运行
  • 编辑器打开文件
  • 查看图片
  • 播放视频
  • 播放音乐
  • Git 查看日志
  • 上传文件
  • 查看聊天记录

2. 文件移动与重命名

在 Node.js 中，我们可以使用 rename 或 renameSync 来移动或重命名 文件或文件夹

语法：

fs.rename(oldPath, newPath, callback)

fs.renameSync(oldPath, newPath)

参数说明：

  • oldPath 文件当前的路径
  • newPath 文件新的路径
  • callback 操作后的回调

代码示例：

//异步操作
fs.rename('./观书有感.txt', './论语/观书有感.txt', (err) => {
if(err) {
    console.log('移动失败')
}
console.log('移动完成')
});

//同步操作
fs.renameSync('./座右铭.txt', './论语/我的座右铭.txt');

4. 文件删除

在 Node.js 中，我们可以使用 unlink 或 unlinkSync 来删除文件

语法：

fs.unlink(path, callback)

fs.unlinkSync(path)

参数说明：

  • path 文件路径
  • callback 操作后的回调

代码示例：

//导入文件操作包
const fs = require('fs');
//异步删除
fs.unlink('./test.txt', err => {
if(err) {
    console.log(err);
    return;
}
console.log('删除成功');
});

//同步删除
fs.unlinkSync('./test2.txt');

5. 文件夹操作

借助 Node.js 的能力，我们可以对文件夹进行 创建 、 读取 、 删除 等操作

image.png

5.1 mkdir 创建文件夹

在 Node.js 中，我们可以使用 mkdir 或 mkdirSync 来创建文件夹

语法：

fs.mkdir(path[, options], callback)

fs.mkdirSync(path[, options])

参数说明：

  • path 文件夹路径
  • options 选项配置（ 可选 ）
  • callback 操作后的回调

示例代码：

//异步创建文件夹
fs.mkdir('./page', err => {

if(err) {
    console.log('创建失败');
    return;
}
console.log('创建成功');
});

//递归异步创建
fs.mkdir('./1/2/3', {recursive: true}, err => {
if(err) {
    console.log('递归创建失败');
    return;
}
console.log('递归创建成功');
});

//递归同步创建文件夹
fs.mkdirSync('./x/y/z', {recursive: true});

5.2 readdir 读取文件夹

在 Node.js 中，我们可以使用** readdir** 或 readdirSync 来读取文件夹

语法：

fs.readdir(path[, options], callback)

fs.readdirSync(path[, options])

参数说明：

  • path 文件夹路径
  • options 选项配置（ 可选 ）
  • callback 操作后的回调

示例代码：

//异步读取
fs.readdir('./论语', (err, data) => {
if(err) {
    console.log(err);
    return;
}
console.log(data);
});

//同步读取
let data = fs.readdirSync('./论语');
console.log(data);

5.3 rmdir 删除文件夹

在 Node.js 中，我们可以使用 rmdir 或 rmdirSync 来删除文件夹

语法：

fs.rmdir(path[, options], callback)

fs.rmdirSync(path[, options])

参数说明：

  • path 文件夹路径
  • options 选项配置（ 可选 ）
  • callback 操作后的回调

示例代码：

//异步删除文件夹
fs.rmdir('./page', err => {
if(err) {
    console.log('删除失败');
    return;
}
console.log('删除成功');
});

//异步递归删除文件夹
fs.rmdir('./1', {recursive: true}, err => {
if(err) {
    console.log(err);
    return;
}
console.log('递归删除')
});

//同步递归删除文件夹
fs.rmdirSync('./x', {recursive: true})

注意：

DeprecationWarning: In future versions of Node.js, fs.rmdir(path, { recursive: true }) will be removed. Use fs.rm(path, { recursive: true }) instead

  1. 递归删除不推荐使用，因为以后recursive这个选项配置可能会删除
  2. 推荐使用rm，代码如下
//异步递归删除文件夹
fs.rm('./1', {recursive: true}, err => {
if(err) {
    console.log(err);
    return;
}
console.log('删除成功')
});

6. 查看资源状态

在 Node.js 中，我们可以使用 stat 或 statSync 来查看资源的详细信息

语法：

fs.stat(path[, options], callback)

fs.statSync(path[, options])

参数说明：

  • path 文件夹路径
  • options 选项配置（ 可选 ）
  • callback 操作后的回调

示例代码：

//异步获取状态
fs.stat('./data.txt', (err, data) => {

if(err) {
    console.log(err);
    return;
}
console.log(data);
});

//同步获取状态
let data = fs.statSync('./data.txt');

结果值对象结构：

  • size 文件体积
  • birthtime 创建时间
  • mtime 最后修改时间
  • isFile 检测是否为文件
  • isDirectory 检测是否为文件夹
  • …

7. 相对路径问题

fs 模块对资源进行操作时，路径的写法有两种：

相对路径

  • ./座右铭.txt 当前目录下的座右铭.txt

  • 座右铭.txt 等效于上面的写法

  • …/座右铭.txt 当前目录的上一级目录中的座右铭.txt

绝对路径

  • D:/Program Files windows 系统下的绝对路径

  • /usr/bin Linux 系统下的绝对路径

相对路径中所谓的 当前目录 ，指的是 命令行的工作目录 ，而并非是文件的所在目录

所以当命令行的工作目录与文件所在目录不一致时，会出现一些 BUG

8. __dirname

__dirname 与 require 类似，都是 Node.js 环境中的’全局’变量

__dirname 保存着 当前文件所在目录的绝对路径 ，可以使用 __dirname 与文件名拼接成绝对路径

代码示例：

let data = fs.readFileSync(__dirname + '/data.txt');
console.log(data);

使用 fs 模块的时候，尽量使用 __dirname 将路径转化为绝对路径，这样可以避免相对路径产生的
Bug

9. 练习

实现把单数字序号开头的文件名前面加上’0’以便排序

// 导入 fs 模块
const fs = require('fs');

// 读取 code 文件夹
const files = fs.readdirSync('./code');

// 遍历数组
files.forEach(item => {
    // 拆分文件名
    let data = item.split('-');
    let [num, name] = data;
    // 判断
    if(Number(num) < 10) {
        num = '0' + num;
    }
    // 创建新的文件名
    let newName = num + '-' + name;
    // 重命名
    fs.renameSync(`./code/${item}`, `./code/${newName}`);
})
Muko_0x7d2
关注
  • 34
    点赞
  • 踩
  • 18
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Nodejs——fs文件系统模块
LSH_的个人博客
06-28 9141
它提供了丰富的函数和方法，可以进行文件的读取、写入、复制、删除等操作，同时也支持目录的创建、遍历和修改等操作。使用fs模块，你可以在Node.js环境中轻松地与文件系统交互。使用 fs 模块的时候，尽量使用 __dirname 将路径转化为绝对路径，这样可以避免相对路径产生的。相对路径中所谓的 当前目录 ，指的是 命令行的工作目录 ，而并非是文件的所在目录。在 Node.js 中，我们可以使用。在 Node.js 中，我们可以使用。在 Node.js 中，我们可以使用。
Node.js内置模块之fs模块
cn33333的博客
10-25 2375
fs.copyFile('要拷贝文件名', '文件名', err => {})fs.readFile('文件名', (err, data) => {})参数二:写入的内容的文件路径(写入时不存在这个文件,会自动帮你创建)参数一:写入的文件路径(写入时不存在这个文件,会自动帮你创建)参数一:写入的文件路径(写入时不存在这个文件,会自动帮你创建)fs.unlink('文件名', err => {})参数三:回调函数(完成的回调函数)参数三:回调函数(完成的回调函数)参数三:回调函数(完成的回调函数)
nodejs---fs模块，文件读写操作详解，自定义一个文件写入方法
I_am_shy的博客
06-07 1023
Node.js 同时支持 CommonJS 和 ES 模块系统（自 Node.js v12 以来）是否使用ES6的导入方式，取决于你是否有一个配置文件，或者就使用require导入。
Nodejs之fs（文件系统）模块
夕山雨的博客
08-02 9133
目录一、fs模块简介 一、fs模块简介 fs（file system）模块是nodejs提供的用于访问主机文件系统的功能模块，它使得运行于nodejs环境下的JavaScript具备直接读写本地文件的能力。 fs模块是nodejs的核心模块之一，只要安装了nodejs，就可以直接使用fs模块，不需要单独安装。引入fs模块非常简单： let fs = require('fs'); 接下来就可以调用fs模块的相关接口直接读写文件系统。 fs模块主要提供了以下的接口类： fs.Dir，目录类。可理解为文件夹。
[Nodejs] node的fs模块
local_752的专栏
07-26 4111
node的fs模块
NodeJs-fs模块
蓝朽的小世界
08-31 844
fs和path模块学习
node.js-14.8
最新发布
06-21
2. **ES 模块支持**：Node.js 13 开始逐步引入原生支持 ES 模块，14.8 版本可能会提供更稳定的支持，允许开发者使用 `import` 和 `export` 语法进行模块化开发，这是向现代 JavaScript 靠拢的重要一步。 3. **错误...
node-v16.15.1-win-x64.zip
06-02
4. **模块系统**：Node.js拥有丰富的内置模块和第三方模块，如http模块用于创建HTTP服务器，fs模块用于文件系统操作，path模块处理文件路径等。npm（Node Package Manager）是其配套的包管理器，方便开发者安装、...
Node.js-textract从各种文件抽取文本的Node.js模块
08-09
Node.js-textract是一个强大的开源模块，专为在Node.js环境中从多种类型的文件中提取文本而设计。这个模块的出现解决了开发者在处理非纯文本格式文件时的痛点，它能够高效地从HTML、PDF、Microsoft Office文档（如...
Node.js-user-home-得到用户的主目录的路径
08-10
在Node.js中，虽然可以使用内置的`os`模块来获取一些系统信息，但`os.homedir()`方法是在相对较晚的版本中添加的，对于较旧的Node.js版本，可能不适用。而`user-home`库则是一个独立的包，它提供了对旧版本Node.js的...
Node.js-互联网的标准库
08-09
Node.js是一个基于Chrome V8引擎的JavaScript运行环境，它允许开发者使用JavaScript进行服务器端编程，而且提供了丰富的标准库，这些库极大地简化了网络应用的开发。 Node.js的标准库包括了对HTTP、TCP、DNS、文件...
node-v16.15.0-win-x64.zip
04-27
Node.js 核心库包含了许多内置模块，如`fs`用于文件系统操作，`http`和`https`用于网络通信，`path`处理文件路径等。 **npm (Node Package Manager)** npm 是Node.js的包管理器，也是迄今为止最大的开源软件库生态...
node-v20.10.0-x64.zip
11-27
2. **模块系统**：Node.js采用CommonJS规范，拥有内置的模块系统，如`fs`（文件系统）模块用于读写文件，`http`模块用于创建HTTP服务器，以及`path`模块处理文件路径等。此外，npm（Node Package Manager）是最大的...
node-v18.14.0-darwin-arm64.tar.gz
02-15
3. **模块系统**：Node.js 自带一套内置模块，如 `http`、`fs` 和 `path`，并且可以通过 npm (Node Package Manager) 安装第三方模块，极大地扩展了其功能。 4. **npm**：npm 是世界上最大的开源软件包仓库，拥有数...
javaScript-Node.js-course
07-11
7. 文件系统模块：学习Node.js内置的fs模块，用于读写文件和目录，这是进行服务器端操作的基础。 8. HTTP服务器：构建基本的HTTP服务器，理解http模块的工作原理，为创建Web应用打下基础。 9. 模块系统：学习Node....
Node.js-ssh2-一个SSH2客户端和服务器node.js模块
08-09
**Node.js SSH2 模块详解** 在 IT 领域，Node.js 是一个非常流行的 JavaScript 运行环境，它允许开发者使用 JavaScript 进行后端开发。在 Node.js 的生态系统中，`ssh2` 是一个强大的库，它提供了一个SSH2协议的...
Nodejs—fs 文件系统模块
m0_59451453的博客
05-24 276
fs 模块是 Node.js 官方提供的、用来操作文件的模块。它提供了一系列的方法和属性，用来满足用户对文件的操作需求。例如：fs.readFile() 方法，用来读取指定文件中的内容fs.writeFile() 方法，用来向指定的文件中写入内容。
Nodejs入门（一）fs模块
m0_71927557的博客
07-26 1373
包含nodejs之fs模块，文件操作、文件夹操作、查看资源状态、以及fs实践
Node 读取 + 写入 + 路径问题
qq_53283188的博客
05-18 981
学习目标 ◆ 能够知道什么是 Node.js ◆ 能够知道 Node.js 可以做什么 ◆ 能够说出 Node.js 中的 JavaScript 的组成部分 ◆ 能够使用 fs 模块读写操作文件 ◆ 能够使用 path 模块处理路径 ◆ 能够使用 http 模块写一个基本的 web 服务器 文章目录学习目标一、Node二、fs 文件系统1. fs 文件系统模块2. 读取 fs.readFile()3. 写入 fs.writeFile()三、fs 路径问题使用 __dirname 解决路径拼接问题
node.js fs模块用法
05-18
Node.js 的 fs 模块是用来操作文件系统的。它提供了对文件的读写、复制、重命名、删除等操作。 以下是一些常见的 fs 模块用法示例： 1. 读取文件内容 ``` const fs = require('fs'); fs.readFile('file.txt', 'utf8', (err, data) => { if (err) throw err; console.log(data); }); ``` 2. 写入文件内容 ``` const fs = require('fs'); fs.writeFile('file.txt', 'Hello world!', (err) => { if (err) throw err; console.log('File written successfully!'); }); ``` 3. 复制文件 ``` const fs = require('fs'); fs.copyFile('source.txt', 'destination.txt', (err) => { if (err) throw err; console.log('File copied successfully!'); }); ``` 4. 重命名文件 ``` const fs = require('fs'); fs.rename('oldname.txt', 'newname.txt', (err) => { if (err) throw err; console.log('File renamed successfully!'); }); ``` 5. 删除文件 ``` const fs = require('fs'); fs.unlink('file.txt', (err) => { if (err) throw err; console.log('File deleted successfully!'); }); ``` 以上仅是 fs 模块的一些基本用法示例，实际中还有很多其他的用法，可以参考 Node.js 官方文档进行学习和使用。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值