nodejs---fs模块，文件读写操作详解，自定义一个文件写入方法

2024-06-07 14:28
文章标签 模块 自定义 方法 详解 nodejs fs 写入 读写操作

本文主要是介绍nodejs---fs模块，文件读写操作详解，自定义一个文件写入方法，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

fs模块导入

Node.js 同时支持 CommonJS 和 ES 模块系统（自 Node.js v12 以来）

// 两种模块导入方式
import * as fs from 'fs';// Es6:这种方式需要在package.json中配置"type": "module"
const fs = require('fs');// commonJs:如果你只有一个单文件js那么你还是要使用这种方式导入

是否使用ES6的导入方式，取决于你是否有一个配置文件，或者就使用require导入

fs的读写文件方法

fs提供的文件操作方法包含3中模式：回调式，阻塞式，promise式

这里使用stat（）方法举例，

检查文件信息 stat（）

const fs = require('fs');// commonJs
const txt = '../public/file.txt'// 回调式
fs.stat(txt, (err, stats) => {if(err){console.log(err.message);}console.log(stats.isFile());
})// 阻塞式
try {const stats = fs.statSync(txt);
} catch (err) {console.error(err);
}
console.log(stats.isFile());// promise式
async function example() {try {const stats = await fs.stat(txt);} catch (err) {console.log(err);}console.log(stats.isFile());
}
example();

使用后面两种方法时需要使用try，catch来捕获错误，

这里要注意 ：如果不存在txt路径的文件，会产生错误，这种错误式 被捕获的err提示的，并非式致命错误（直接终止程序），它会提示你没有这个文件，而后面对这个文件的操作也会无法执行，

读取文件内容 readFile（）

// 读取文件, 读取文件内容，并返回一个字符串
fs.readFile(txt, 'utf8', (err, data) => {if(err){console.log(err.message);}console.log(data);
})

参数：文件路径，读取格式（默认式二进制流格式），回调参数，err错误信息，data读取的数据

同样的，readFile也支持三种模式：回调式，阻塞式，promise式，这里仅展示回调式

写入文件writeFile（）

// 写入文件， 写入文件内容，
fs.writeFile(txt, 'hello world', (err) => {if(err){console.log(err.message);}console.log('写入成功');
})

参数：文件路径，写入的内容，回调参数，err错误信息

同样的，writeFile也支持三种模式：回调式，阻塞式，promise式，这里仅展示回调式

追加内容appendFile（）

fs.appendFile(txt, 'hello world', (err) => {if(err){console.log(err.message);}console.log('追加成功');
})

参数：文件路径，写入的内容，回调参数，err错误信息

同样的，appendFile也支持三种模式：回调式，阻塞式，promise式，这里仅展示回调式

注意 writeFile会覆盖原内容，从起始位置开始写入，appendFile不覆盖原内容，从末尾位置开始写入

文件夹操作

判断一个文件夹是否存在
使用 fs.existsSync(),这里exists不推荐使用了，事实上，对于文件夹的操作都建议使用阻塞式，因为文件都必须在文件夹下操作，文件夹没有被获取的话，文件操作就无法正常执行
新建一个文件夹
使用 fs.mkdir() 或 fs.mkdirSync()  创建新文件夹
读取目录的内容
使用 fs.readdir() 或 fs.readdirSync() 读取目录的内容。
重命名文件夹
使用 fs.rename() 或 fs.renameSync()  重命名文件夹。
删除文件夹
使用 fs.rmdir() 或 fs.rmdirSync() 删除文件夹。

新建一个文件夹

这里展示如何新建一个文件夹，其他方法类似，想了解更多可以参考：在 Node.js 中使用文件夹 (nodejs.cn)

const fs = require('fs');
const path = "./public/";try {// 如果没有public文件夹则创建if (!fs.existsSync(path)) {fs.mkdirSync(path);}
} catch (err) {console.error(err);
}

封装一个setFile方法

了解了基本的读写操作后我们可以封装一个方法，

该函数接收一个文件名和一个文件内容作为参数，并将文件内容写入指定的文件中(没有则创建)，路径是当前目录下新建一个public文件夹，并将文件至于public下面。

/*** @param {文件名称} baseName * @param {写入的内容} content * @param {内容是否覆盖} b 默认为false,不覆盖*/setFile(baseName,content,b)
module.exports.setFile = function (baseName, content, b = false) {// 如果没有public文件夹则创建try {if (!fs.existsSync(path)) {fs.mkdirSync(path);console.log("文件夹 public 创建成功");}} catch (err) {console.log(err);}// 判断文件是否存在，在open之前判断,回调结果在open之后fs.stat(path + baseName, (err) => {if (err) {// 文件不存在,产生错误// console.log(err);console.log(`文件 ${baseName} 创建成功`);}})if (!b) {// 不覆盖内容// fs.readFile(path + baseName, "utf-8",(err, data) => {//   if (err) {//     console.error(err);//   }//   // 读取出原来的内容拼接//   content = data + content;//   fs.writeFile(path + baseName, content, (err) => {//     if (err) {//       console.error(err);//     }//     console.log("写入成功");//   })// })fs.appendFile(path + baseName, content, (err) => {if (err) {console.error(err);} else {console.log("写入成功");}})} else {fs.writeFile(path + baseName, content, (err) => {if (err) {console.error(err);} else {console.log("写入成功");}})}}

在同目录下新建一个useSetFile.js导入这个方法

// 导出的模块是整个文件，需要通过属性引入使用里面的方法
const setFile = require('./setFile');const file = 'file.txt';
const content = 'Hello, World!';setFile.setFile(file, content);

在控制台执行node useSetFile.js

 

可以看到目录下多了一个public文件夹和file.txt文件，并且写入了两个hello,world!

数据流缓冲区读写---open,close,read,write方法

出来file后缀的文件操作方法，fs模块还有基于数据流的读写方法，关于二进制数据流可以参考：

js二进制数据，文件---ArrayBuffer，二进制数组_js arraybuffer()-CSDN博客

// 打开文件，'w+/a+' 获得读，写权限，文件流起始位置在开头/末尾（a相比于a+没有读取权限）， 如果文件不存在则创建，读取文件后会覆盖原有文件
fs.open(txt, 'a', (err, fd) => {if(err){console.log(err.message);}// 关闭文件， 关闭文件后才能进行其他操作fs.close(fd, (err) => {if(err){console.log(err.message);}console.log('文件关闭成功');})
})
/*** fd, 使用fs.open打开成功后返回的文件描述符* buffer, 一个Buffer对象，v8引擎分配的一段内存* offset, 整数，从缓存区中读取/写入时的初始位置，以字节为单位* length, 整数，从缓存区中读取/写入数据的字节数* position, 整数，写入/读取文件初始位置；* callback(err, written, buffer), 写入操作执行完成后回调函数，written实际写入字节数，buffer被读取的缓存区对象*/
fs.write(fd, buffer, offset, length, position, callback);
fs.read(fd, buffer, offset, length, position, callback);

整体的使用结构为

open->read/write->close

open开始拿到fd，fd为一个整数，表示打开文件返回的文件描述符，window中又称文件句柄

后续操作以fd为文件标志进行操作

const fs = require('fs');
const path = __dirname+"/public/buffer.txt";// __dirname 当前文件所在目录的绝对路径
const buffer = new Buffer.from("你好");  //每一个汉字utf8编码是3个字节，英文是1个字节fs.open(path, 'a+', (err, fd) => {fs.write(fd,buffer,0,6,0, (err) => {// 0，6，0的含义，0，6从buffer中读取6个字节，0是开始读取的位置，0是写入的位置，写入文件的起始位置  if(err){console.log(err);}else{console.log("写入成功");}})fs.read(fd,buffer,0,6,0, (err, bytes) => {// 0，6，0的含义，0，6从buffer中写入6个字节，0是开始写入的位置，0是读取的位置，读取文件的起始位置if(err){console.log(err);}else{if(bytes > 0){console.log(buffer.slice(0, bytes).toString());//打印buffer中的内容fs.read(fd,buffer,0,6,null, (err, bytes) => {// 再次读取fd中的内容时，不标记出读取位置，默认为上次读取结束的位置，'a+'表示每次将位置放置在文件末尾if(err){console.log(err);}else{if(bytes > 0){console.log(buffer.slice(0, bytes).toString());}}})}fs.close(fd, (err) => {//结束本次文件读写if(err){console.log(err);}else{console.log("关闭文件成功");}})}})});

这种方式的逻辑更加精细，可以控制数据流缓存区的位置进行读写，

值得注意的是，read和write两个方法中的3个整数参数，前两个是指定给buffer数据流缓冲区的 ，最后一个是文件的位置，当你进行read读取时，是对文件进行读取，在将读取的内容写入buffer，

当你进行write写入时，是对buffer进行读取，在将读取的内容写入文件 ，两者正好相反但是参数格式一致

完整代码总结和目录结构展示

file.js

// 两种模块导入方式
// import * as fs from 'fs';// Es6:这种方式需要在package.json中配置"type": "module"
const fs = require('fs');// commonJs
const path = require('path');const txt = '../public/file.txt'
const txtMsg = [path.dirname(txt),// 父级文件夹path.basename(txt),// 文件名，包括后缀path.extname(txt) // 文件后缀(扩展名)
]let f = 0 ;txtMsg.forEach(item => {console.log(item);
})// 同一代码块的回调执行顺序是 fs.open -> fs.close ->fs.stat -> fs.writeFile -> fs.readFile 打开文件，关闭文件，查看文件，写入文件，读取文件
// 打开文件，'w+/a+' 获得读，写权限，文件流起始位置在开头/末尾（a相比于a+没有读取权限）， 如果文件不存在则创建，读取文件后会覆盖原有文件
fs.open(txt, 'a', (err, fd) => {if(err){console.log(err.message);}f = fd;console.log(fd); 
})// 读取文件, 读取文件内容，并返回一个字符串
fs.readFile(txt, 'utf8', (err, data) => {if(err){console.log(err.message);}console.log(data);
}) // 写入文件， 写入文件内容，
fs.writeFile(txt, 'hello world', (err) => {if(err){console.log(err.message);}console.log('写入成功');
})// 追加文件内容
fs.appendFile(txt, 'hello world', (err) => {if(err){console.log(err.message);}console.log('追加成功');
})// 关闭文件， 关闭文件后才能进行其他操作
fs.close(f, (err) => {if(err){console.log(err.message);}console.log('文件关闭成功');
})// 文件信息
fs.stat(txt, (err, stats) => {if(err){console.log(err.message);}console.log(stats.isFile());
})// 每次执行此文件，会先打开txt.txt文件，(此时内容已清空)关闭文件，写入内容，再读取文件内容

setFile.js

// 封装一个setFile函数，该函数接收一个文件名和一个文件内容作为参数，并将文件内容写入指定的文件中(没有则创建)，路径是当前目录下新建一个public文件夹，并将文件至于public下面。
// setFile(baseName,content,b)const fs = require('fs');
const path = "./public/";/*** @param {文件名称} baseName * @param {写入的内容} content * @param {内容是否覆盖} b 默认为false,不覆盖*/module.exports.setFile = function (baseName, content, b = false) {// 如果没有public文件夹则创建try {if (!fs.existsSync(path)) {fs.mkdirSync(path);console.log("文件夹 public 创建成功");}} catch (err) {console.log(err);}// 判断文件是否存在，在open之前判断,回调结果在open之后fs.stat(path + baseName, (err) => {if (err) {// 文件不存在,产生错误// console.log(err);console.log(`文件 ${baseName} 创建成功`);}})if (!b) {// 不覆盖内容// fs.readFile(path + baseName, "utf-8",(err, data) => {//   if (err) {//     console.error(err);//   }//   // 读取出原来的内容拼接//   content = data + content;//   fs.writeFile(path + baseName, content, (err) => {//     if (err) {//       console.error(err);//     }//     console.log("写入成功");//   })// })fs.appendFile(path + baseName, content, (err) => {if (err) {console.error(err);} else {console.log("写入成功");}})} else {fs.writeFile(path + baseName, content, (err) => {if (err) {console.error(err);} else {console.log("写入成功");}})}
}

useSetFile.js

// 导出的模块是整个文件，需要通过属性引入使用里面的方法
const setFile = require('./setFile');const file = 'file.txt';
const content = 'Hello, World!';setFile.setFile(file, content);

buffer.js

const fs = require('fs');
const path = __dirname+"/public/buffer.txt";// __dirname 当前文件所在目录的绝对路径
const buffer = new Buffer.from("你好");  //每一个汉字utf8编码是3个字节，英文是1个字节fs.open(path, 'a+', (err, fd) => {fs.write(fd,buffer,0,6,0, (err) => {// 0，6，0的含义，0，6从buffer中读取6个字节，0是开始读取的位置，0是写入的位置，写入文件的起始位置  if(err){console.log(err);}else{console.log("写入成功");}})fs.read(fd,buffer,0,6,0, (err, bytes) => {// 0，6，0的含义，0，6从buffer中写入6个字节，0是开始写入的位置，0是读取的位置，读取文件的起始位置if(err){console.log(err);}else{if(bytes > 0){console.log(buffer.slice(0, bytes).toString());//打印buffer中的内容fs.read(fd,buffer,0,6,null, (err, bytes) => {// 再次读取fd中的内容时，不标记出读取位置，默认为上次读取结束的位置，'a+'表示每次将位置放置在文件末尾if(err){console.log(err);}else{if(bytes > 0){console.log(buffer.slice(0, bytes).toString());}}})}fs.close(fd, (err) => {//结束本次文件读写if(err){console.log(err);}else{console.log("关闭文件成功");}})}})});

目录结构

这篇关于nodejs---fs模块，文件读写操作详解，自定义一个文件写入方法的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1039429。

相关文章

JAVA中整型数组、字符串数组、整型数和字符串 的创建与转换的方法

JAVA中整型数组、字符串数组、整型数和字符串 的创建与转换的方法

《JAVA中整型数组、字符串数组、整型数和字符串的创建与转换的方法》本文介绍了Java中字符串、字符数组和整型数组的创建方法,以及它们之间的转换方法,还详细讲解了字符串中的一些常用方法,如index... 目录一、字符串、字符数组和整型数组的创建1、字符串的创建方法1.1 通过引用字符数组来创建字符串1.2
阅读更多...
Python中构建终端应用界面利器Blessed模块的使用

Python中构建终端应用界面利器Blessed模块的使用

《Python中构建终端应用界面利器Blessed模块的使用》Blessed库作为一个轻量级且功能强大的解决方案,开始在开发者中赢得口碑,今天,我们就一起来探索一下它是如何让终端UI开发变得轻松而高... 目录一、安装与配置：简单、快速、无障碍二、基本功能：从彩色文本到动态交互1. 显示基本内容2. 创建链
阅读更多...
Java调用Python代码的几种方法小结

Java调用Python代码的几种方法小结

《Java调用Python代码的几种方法小结》Python语言有丰富的系统管理、数据处理、统计类软件包,因此从java应用中调用Python代码的需求很常见、实用,本文介绍几种方法从java调用Pyt... 目录引言Java core使用ProcessBuilder使用Java脚本引擎总结引言python
阅读更多...
Mysql 中的多表连接和连接类型详解

Mysql 中的多表连接和连接类型详解

《Mysql中的多表连接和连接类型详解》这篇文章详细介绍了MySQL中的多表连接及其各种类型,包括内连接、左连接、右连接、全外连接、自连接和交叉连接,通过这些连接方式,可以将分散在不同表中的相关数据... 目录什么是多表连接？1. 内连接（INNER JOIN）2. 左连接（LEFT JOIN 或 LEFT
阅读更多...
Apache Tomcat服务器版本号隐藏的几种方法

Apache Tomcat服务器版本号隐藏的几种方法

《ApacheTomcat服务器版本号隐藏的几种方法》本文主要介绍了ApacheTomcat服务器版本号隐藏的几种方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需... 目录1. 隐藏HTTP响应头中的Server信息编辑 server.XML 文件2. 修China编程改错误
阅读更多...
Java中switch-case结构的使用方法举例详解

Java中switch-case结构的使用方法举例详解

《Java中switch-case结构的使用方法举例详解》：本文主要介绍Java中switch-case结构使用的相关资料,switch-case结构是Java中处理多个分支条件的一种有效方式,它... 目录前言一、switch-case结构的基本语法二、使用示例三、注意事项四、总结前言对于Java初学者
阅读更多...
Linux内核之内核裁剪详解

Linux内核之内核裁剪详解

《Linux内核之内核裁剪详解》Linux内核裁剪是通过移除不必要的功能和模块,调整配置参数来优化内核,以满足特定需求,裁剪的方法包括使用配置选项、模块化设计和优化配置参数,图形裁剪工具如makeme... 目录简介一、 裁剪的原因二、裁剪的方法三、图形裁剪工具四、操作说明五、make menuconfig
阅读更多...
使用Python实现大文件切片上传及断点续传的方法

使用Python实现大文件切片上传及断点续传的方法

《使用Python实现大文件切片上传及断点续传的方法》本文介绍了使用Python实现大文件切片上传及断点续传的方法,包括功能模块划分（获取上传文件接口状态、临时文件夹状态信息、切片上传、切片合并）、整... 目录概要整体架构流程技术细节获取上传文件状态接口获取临时文件夹状态信息接口切片上传功能文件合并功能小
阅读更多...
Oracle Expdp按条件导出指定表数据的方法实例

Oracle Expdp按条件导出指定表数据的方法实例

《OracleExpdp按条件导出指定表数据的方法实例》：本文主要介绍Oracle的expdp数据泵方式导出特定机构和时间范围的数据,并通过parfile文件进行条件限制和配置,文中通过代码介绍... 目录1.场景描述 2.方案分析3.实验验证 3.1 parfile文件3.2 expdp命令导出4.总结
阅读更多...
Node.js 中 http 模块的深度剖析与实战应用小结

Node.js 中 http 模块的深度剖析与实战应用小结

《Node.js中http模块的深度剖析与实战应用小结》本文详细介绍了Node.js中的http模块,从创建HTTP服务器、处理请求与响应,到获取请求参数,每个环节都通过代码示例进行解析,旨在帮... 目录Node.js 中 http 模块的深度剖析与实战应用一、引言二、创建 HTTP 服务器：基石搭建（一
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2