Node.js学习笔记——fs模块

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

本章节会介绍如下操作:

  1. 文件写入
  2. 文件读取
  3. 文件移动与重命名
  4. 文件删除
  5. 文件夹操作
  6. 查看资源状态

一、文件写入

文件写入就是将数据保存到文件中,我们可以使用如下几个方法来实现该效果。
在这里插入图片描述

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(err);
        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中的磁盘操作是由其他线程完成的,结果的处理有两种模式:

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

1.3.appendFile/appendFileSync追加写入

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

fs.appendFile(File,data[,options],callback])
fs.appendFileSync(File,data[,options])

返回值:二者都为undefined
示例代码:


//require是Node.js环境中的'全局'变量,用来导入模块
const fs=require('fs');

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

fs.appendFileSync('./座右铭.txt','\r\n温故而知新,可以为师矣');

1.4.createWriteStream流式写入

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

参数说明:

  1. path 文件路径
  2. options选项配置(可选)

返回值:Object
代码示例:


//require是Node.js环境中的'全局'变量,用来导入模块
const fs=require('fs');

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.写入文件的场景

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

  1. 下载文件
  2. 安装软件
  3. 保存程序日志,如Git
  4. 编辑器保存文件
  5. 视频录制

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

二、文件读取

文件读取顾名思义,就是通过程序从文件中取出其中的数据,我们可以采用以下几种方法:

在这里插入图片描述

2.1.readFile异步读取

语法: fs.readFile(path[, options], callback)
参数说明:
path 文件路径
options 选项配置
callback 回调函数

返回值:undefined

代码实例:

//导入 fs 模块
const fs = require('fs');
fs.readFile('./座右铭.txt', (err, data) => {
    if (err) throw err;
    console.log(data);
});
fs.readFile('./座右铭.txt', 'utf-8', (err, data) => {
    if (err) throw err;
    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
代码示例:

//导入 fs 模块
const fs = require('fs');
//创建读取流对象
let rs = fs.createReadStream('./观书有感.txt');
//每次取出 64k 数据后执行一次 data 回调
rs.on('data', data => {
console.log(data);
console.log(data.length);
});
//读取完毕后, 执行 end 回调
rs.on('end', () => {
console.log('读取完成')
})

2.4.读取文件应用场景

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

三、文件移动与重命名

在Node.js中,我们可以使用rename或renameSync来移动或者重命名文件或文件夹。
语法:

fs.rename(oldPath, newPath, callback)
fs.renameSync(oldPath, newPath)

参数说明:
oldPath 文件当前的路径
newPath 文件新的路径
callback 操作后的回调

代码示例:

//导入 fs 模块
const fs = require('fs');
fs.rename('./观书有感.txt', './感.txt', (err) =>{
    if(err) throw err;
    console.log('移动完成')
    });
fs.renameSync('./座右铭.txt', './我的座右铭.txt');

四、文件删除

在Node.js中,我们可以使用unlink或者unlinkSync来删除文件
语法:

fs.unlink(path, callback)
fs.unlinkSync(path)

参数说明:
path 文件路径
callback 操作后的回调

代码示例:

const fs = require('fs');
fs.unlink('./test.txt', err => {
if(err) throw err;
console.log('删除成功');
});
fs.unlinkSync('./test2.txt');

五、文件夹操作

借助Node.js的能力,我们可以对文件夹进行创建、读取、删除等操作
在这里插入图片描述

5.1.mkdir创建文件夹

在Node.js中,我们可以使用mkdir或者mkdirSync来创建文件夹
语法:

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

参数说明:
path 文件夹路径
options 选项配置( 可选 )
callback 操作后的回调

示例代码:

const fs = require('fs');
//异步创建文件夹
fs.mkdir('./page', err => {
    if(err) throw err;
    console.log('创建成功');
    });
    //递归异步创建
    fs.mkdir('./1/2/3', {recursive: true}, err => {
    if(err) throw err;
    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 操作后的回调
示例代码:

const fs = require('fs');
//异步读取
fs.readdir('./1', (err, data) => {
    if(err) throw err;
    console.log(data);
    });
    //同步读取
    let data = fs.readdirSync('./x');
    console.log(data);

5.3.rmdir删除文件夹

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

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

参数说明:
path 文件夹路径
options 选项配置( 可选 )
callback 操作后的回调

示例代码:

const fs = require('fs');
//异步删除文件夹
fs.rmdir('./page', err => {
    if(err) throw err;
    console.log('删除成功');
    });
    //异步递归删除文件夹
    fs.rmdir('./1', {recursive: true}, err => {
    if(err) {
    console.log(err);
    }
    console.log('递归删除')
    });
    //同步递归删除文件夹
    fs.rmdirSync('./x', {recursive: true})

六、查看资源状态

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

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

参数说明:
path 文件夹路径
options 选项配置( 可选 )
callback 操作后的回调

示例代码:

const fs = require('fs');
fs.stat('./我的座右铭.txt', (err, data) => {
    if(err) throw err;
    console.log(data);
    });
    //同步获取状态
    let data = fs.statSync('./我的座右铭.txt');

结果值对象结构:

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

七、相对路径问题

fs模块对资源进行操作的时候,路径的写法有两种:

  • 相对路径
    ./座右铭.txt 当前目录下的座右铭.txt
    座右铭.txt 等效于上面的写法
    …/座右铭.txt 当前目录的上一级目录中的座右铭.txt
  • 绝对路径
    D:/Program Files windows 系统下的绝对路径
    /usr/bin Linux 系统下的绝对路径

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

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

八、__dirname

__dirname与require类似,都是Node.js环境中 的’全局’变量
__dirname保存着当前文件所在目录的绝对路径,可以使用__dirname与文件名拼接成绝对路径

代码示例:

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

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

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/5111.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

利用nginx实现动静分离的负载均衡集群实战

前言 大家好,我是沐风晓月,今天我们利用nginx来作为负载,实现两台apache服务器的动静分离集群实战; 本文收录于沐风晓月的专栏《linux基本功-系统服务实战》,更多内容可以关注我的博客: https://blog.csd…

Visual Studio 2015 + cmake编译QT5程序

概述 由于QT的集成开发环境QTCreate,在代码调试功能上远不及Visual Studio方便,因此,在Windows平台,可以使用Visual Studio来开发调试QT程序,本文章就主要介绍下,如何使用CMAKE编译QT5程序,并使…

【JAVA真的没出路了吗?】

2023年了,转行IT学习Java是不是已经听过看过很多次了。随之而来的类似学Java没出路、Java不行了、对Java感到绝望等等一系列的制造焦虑的话题也在网上层出不穷,席卷了一大片的对行业不了解的吃瓜群众或是正在学习中的人。如果是行外人真的会被这种言论轻…

【教程】使用ChatGPT制作基于Tkinter的桌面时钟

目录 描述 代码 效果 说明 下载 描述 给ChatGPT的描述内容: python在桌面上显示动态的文字,不要显示窗口边框。窗口背景和标签背景都是透明的,但标签内的文字是有颜色。使用tkinter库实现,并以class的形式书写,方…

GPS时间序列分析---剔除跳跃点,拟合时间序列

通常利用GPS时间序列进行数据分析时,会遇到大地震的发生,这个时候会导致GPS的观测结果出现很大的跳跃值,这对后续的数据处理和分析带来了困难。这里分享一个最近了解的,可以用于处理这一问题的工具包---TSAnalyzer。下面主要介绍该…

Adobe:当创意工作遇上生成式AI

放眼全球IT行业,当前最炙手可热的领域是什么?答案显然只有一个:因为ChatGPT而火爆全球的生成式AI(Artificial Intelligence Generated Content,简称AIGC),又称人工智能生成内容。那么当创意设计…

再学一下Feign的原理

简介 Feign是Spring Cloud Netflix组件中的一个轻量级Restful的HTTP服务客户端,它简化了服务间调用的方式。 Feign是一个声明式的web service客户端.它的出现使开发web service客户端变得更简单.使用Feign只需要创建一个接口加上对应的注解, 比如FeignClient注解。…

Go分布式爬虫学习笔记(十四)

文章目录14_context为什么需要Context?级联退出Context 的使用方法。context.ValuecontextContext 最佳实践Context 底层原理14_context Never start a goroutine without knowing how it will stop。 如果你不知道协程如何退出,就不要使用它。 为什么需要Context?…

家政服务系统APP小程序需具备哪些功能?

由于工作忙碌或者是懒人经济作祟,现代人对于家政服务的需求直线上升。而且互联网技术深入生活的方方面面,让上门家政服务系统开发成为很多线下家政公司转型互联网的方式,那么开发一款家政服务系统APP小程序需具备哪些功能呢? …

逻辑回归 算法推导与基于Python的实现详解

文章目录1 逻辑回归概述2 逻辑回归公式推导与求解2.1 公式推导2.2公式求解3 基于Python的实现3.1可接收参数3.2 完整代码示例1 逻辑回归概述 逻辑回归(Logistic Regression)是一种用于分类问题的统计学习方法。它基于线性回归的原理,通过将线…

【软考——系统架构师】架构、系分、软设的区别和联系

🔎这里是【软考——系统架构师】,关注我考试轻松过线 👍如果对你有帮助,给博主一个免费的点赞以示鼓励 欢迎各位🔎点赞👍评论收藏⭐️ 文章目录👀三科相同点👀三科不同点--上午题&am…

CISAW-CISDR灾难备份与恢复专业级认证

证书样板: 认证机构 中国网络安全审查技术与认证中心(英文缩写为:CCRC,原为中国信息安全认证中心)于 2006 年由中央机构编制委员会办公室批准成立,为国家市场监督管理总局直属事业单位。依据《网络安全法》 《网络安…

Java每日一练(20230401)

目录 1. 合并K个升序链表 🌟🌟🌟 2. 最长有效括号 🌟🌟🌟 3. 分割回文串 🌟🌟 🌟 每日一练刷题专栏 🌟 Golang每日一练 专栏 Python每日一练 专栏 …

Linux系统一键安装最新内核并开启 BBR 脚本

本脚本适用环境 系统支持:CentOS 6,Debian 8,Ubuntu 16 虚拟技术:OpenVZ 以外的,比如 KVM、Xen、VMware 内存要求:≥128M 更新日期:2022 年 5 月 11 日 关于本脚本 1、本脚本已在 蓝易云 上…

后端Springboot框架搭建APi接口开发(第二章)

上一章我讲述了如何使用Mybatis操作数据库。这一章我讲述如何利用Sptring框架搭建API接口 第一节:封装SqlSessionFactory工具类 在API操作数据库大量调用SqlSessionFactory,因此应将SqlSessionFactory封装成工具类供方法随时调用 在文件结构中的util文…

前端直接生成GIF动态图实践

前言去年在博客中发了两篇关于GIF动态生成的博客,GIF图像动态生成-JAVA后台生成和基于FFmpeg的Java视频Mp4转GIF初探,在这两篇博客中都是采用JAVA语言在后台进行转换。使用JAVA的同学经过自己的改造和开发也可以应用在项目上。前段时间有朋友私下问&…

MySQL主从复制、读写分离(MayCat2)实现数据同步

文章目录1.MySQL主从复制原理。2.实现MySQL主从复制(一主两从)。3.基于MySQL一主两从配置,完成MySQL读写分离配置。(MyCat2)1.MySQL主从复制原理。 MySQL主从复制是一个异步的复制过程,底层是基于Mysql数据…

设计模式之门面模式(C++)

作者:翟天保Steven 版权声明:著作权归作者所有,商业转载请联系作者获得授权,非商业转载请注明出处 一、门面模式是什么? 门面模式是一种结构型的软件设计模式,也叫外观模式,它提供了统一的接口去…

程序员的天花板到底有多高?

程序员是很多人眼里的职业天花板,毕竟薪资水平、发展前景摆在那里,而且,一个又会debug又会修电脑(划掉),还会费心为你制造浪漫的程序员,有谁不喜欢呢? 但现实中很多程序员都焦虑担忧…

从0使用TCP手撸http服务器六

html模板设计: 上篇我们说到通过路由去返回不同的html页面,如果每一个页面都是一个数组的话,那么我们可能需要很多数组,里面很多内容都是一样的,这样子会浪费我们单片机很多flash,我们需要把共同的部分固定…