fs 模块

2023-10-26

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

//导入fs模块
const fs = require('fs')
//写入文件
fs.writeFile('./座右铭.txt', '三人行,必有我师焉', err => {
    //如果写入失败,则回调函数调用时,会传入错误对象,如写入成功,会传入 null
    if (err) {
        console.log('写入失败');
        return
    }
})

1-2. writeFileSync 同步写入

语法: fs.writeFileSync(file, data[, options])

参数与 fs.writeFile 大体一致,只是没有 callback 参数

返回值: undefined

//导入fs模块
const fs = require('fs')
try {
    fs.writeFileSync('./data.txt', 'text')
} catch (error) {
    console.log(error);
}
Node.js 中的磁盘操作是由其他 线程 完成的,结果的处理有两种模式:
同步处理 JavaScript 主线程 会等待 其他线程的执行结果,然后再继续执行主线程的代码,
效率较低
异步处理 JavaScript 主线程 不会等待 其他线程的执行结果,直接执行后续的主线程代码,
效率较好

1-3. appendFile / appendFileSync 追加写入

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

语法:

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

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

返回值: 二者都为 undefined

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

fs.appendFile('./座右铭.txt', ',择其善者而从之,其不善者而改之', err => {
    if (err) {
        console.log('写入失败');
        return
    }
    console.log('写入成功');
})
fs.appendFileSync('./座右铭.txt', '\r\n温故而知新, 可以为师矣');

1-4. createWriteStream 流式写入

语法:

fs.createWriteStream(path[, options])

参数说明:

  • path 文件路径

  • options 选项配置( 可选 )

返回值: Object

//导入fs模块
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.close();
程序打开一个文件是需要消耗资源的 ,流式写入可以减少打开关闭文件的次数。
流式写入方式适用于 大文件写入或者频繁写入 的场景, writeFile 适合于 写入频率较低的场景

1-5 写入文件的场景

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

  • 下载文件

  • 安装软件

  • 保存程序日志,如 Git

  • 编辑器保存文件

  • 视频录制

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

二、文件读取

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

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('读取失败');
        return
    }
    console.log(data.toString());
})

2-2 readFileSync 同步读取

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

参数说明:

  • path 文件路径

  • options 选项配置

返回值: string | Buffer


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

let data = fs.readFileSync('./座右铭.txt')
console.log(data.toString());

2-3 读取文件应用场景

  • 电脑开机

  • 程序运行

  • 编辑器打开文件

  • 查看图片

  • 播放视频

  • 播放音乐

  • Git 查看日志

  • 上传文件

  • 查看聊天记录

2-4 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('读取完成')
})

三、文件移动与重命名

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

语法:

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

参数说明:

  • oldPath 文件当前的路径

  • newPath 文件新的路径

  • callback 操作后的回调

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

四、文件删除

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

语法:

  • fs.unlink(path, callback)

  • fs.unlinkSync(path)

参数说明:

  • path 文件路径

  • callback 操作后的回调


//导入fs模块
const fs = require('fs')
fs.unlink('./data.txt', err => {
    if (err) {
        console.log('删除失败');
    }
    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 操作后的回调


//导入fs模块
const fs = require('fs')
fs.mkdir('./html', err => {
    if (err) {
        console.log('失败');
    }
    console.log('成功');
})

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

5-2 readdir 读取文件夹

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

语法:

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

参数说明:

  • path 文件夹路径

  • options 选项配置( 可选 )

  • callback 操作后的回调


//导入fs模块
const fs = require('fs')
fs.readdir('./', (err, data) => {
    if (err) {
        console.log('失败');
    }
    console.log('成功');
    console.log(data);
})

5-3 rmdir 删除文件夹

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

语法:

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

参数说明:

  • path 文件夹路径

  • options 选项配置( 可选 )

  • callback 操作后的回调

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

fs.rmdir('./1', { recursive: true }, err => {
    if (err) throw err;
    console.log('递归删除成功');
});
fs.rmdir('./html', err => {
    if (err) throw err;
    console.log('删除成功');
});

六、查看资源状态

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

语法:

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

  • fs.statSync(path[, options])

参数说明:

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

结果值对象结构:

  • size 文件体积

  • birthtime 创建时间

  • mtime 最后修改时间

  • isFile 检测是否为文件

  • isDirectory 检测是否为文件夹


//导入fs模块
const fs = require('fs')
fs.stat('./1.js', (err, data) => {
    if (err) {
        console.log('失败');
    }
    console.log(data);
    console.log(data.isFile());
    console.log(data.isDirectory());
})

七、相对路径问题

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

相对路径

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

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

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

绝对路径

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

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

相对路径中所谓的 当前目录 ,指的是 命令行的工作目录 ,而并非是文件的所在目录
所以当命令行的工作目录与文件所在目录不一致时,会出现一些 BUG

八、__dirname

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

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

代码示例:

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

Bug

path 模块

path 模块提供了 操作路径 的功能,我们将介绍如下几个较为常用的几个 API:

const path = require('path');
//获取路径分隔符
console.log(path.sep);
//拼接绝对路径
console.log(path.resolve(__dirname, 'test'));
//解析路径
let pathname = 'D:/programfile/nodejs/node.exe';
console.log(path.parse(pathname));
//获取路径基础名称
console.log(path.basename(pathname))
//获取路径的目录名
console.log(path.dirname(pathname));
//获取路径的扩展名
console.log(path.extname(pathname));
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

fs 模块 的相关文章

  • 将 Javascript 对象的属性从 string 更改为 int

    我有一个对象数组 每个对象具有三个属性 年份 总计 人均 例子 0 Object per capita 125 8 total 1007 2 year 2009 这些属性是字符串 我想创建一个循环来遍历数组并将它们转换为 int 我尝试了以
  • 可能未处理的承诺拒绝(id 0)类型错误 GET 或 HEAD 请求不允许主体

    import React from react import FlatList ActivityIndicator Text View from react native export default class FetchExample
  • FullCalendar-vue + Typescript:属性“getApi”不存在

    我尝试将 FullCalendar vue 与 Typescript 结合使用 但在访问其 API 时遇到错误 我的日历设置如下
  • 使用本地存储在从另一个表保存的 HTML TABLE 中打印 JSON,以便我在另一个页面上打印我的表

    在我的作业中 我必须使用用户输入中的数据并将数据保存在本地存储中 我必须以水平表格式将这些数据从本地存储打印到其他页面 为此 我编写了用于用户输入并将数据保存在本地存储中的代码 div p p div
  • 显示具有多个父代的 D3 树

    我目前有this http bl ocks org mbostock 4339083图已实现 我希望在描述具有多个父节点的子节点时保持结构和可折叠性 有没有办法做到这一点 我研究了力图 但我也想保留一组层次结构 这意味着 1 级的父级可以有
  • 在 Internet Explorer 中使用什么来监视 jscript 内存使用情况

    我们正在调试 GWT 应用程序 在 Firefox 中运行正常 在 IE6 0 中开始运行正常 但一段时间后 它就会崩溃并开始爬行 经过一些测试后 我们怀疑存在一些内存问题 使用了太多内存 内存泄漏等 除了使用taskmanager和pro
  • 从函数返回函数的目的是什么?

    阅读一些遗留代码 发现 A prototype setSize function var v1 new Vector2 return function size var halfSize v1 copy size multiplyScala
  • VueJS 中数据无法正确显示

    我的 VueJS 代码有一个小问题 在 输出 压缩的 GS1 数字链接 URI 部分中 When there is no result it should have nothing display like this I have remo
  • IntersectionObserver是否支持水平滚动观察?

    我制作了几个垂直滚动 IntersectionObserver 模块 但我对水平滚动感兴趣 根将是 div 观察目标将是 img 我想观察当 img 放大但 div 保持视口宽度时的变化 我什至不确定移动 Safari 是否会将缩放后的图片
  • JavaScript 验证和 PHP 验证?

    我正在使用 jquery 验证插件来验证空表单 我还应该在 PHP 中检查一下以确保 100 正确吗 或者用 javascript 验证就可以了 谢谢 您应该始终在服务器上进行验证 如果用户以某种方式不使用 Javascript 提交表单
  • 按下回车键时不刷新页面

    我遇到了一些问题 只要表单中有输入 回车键就会触发页面刷新 下面的代码 如果按下回车并且文本区域 input 中没有输入任何文本 则不会刷新页面 但是如果按下回车并且 input中有输入或者光标位于文本区域 我不确定是什么触发了它 因为 s
  • onclick 事件中未调用函数

    我想在每个 YouTube 链接的末尾添加一些 HTML 以在 litebox 中打开播放器 到目前为止 这是我的代码 document ready function var valid url new RegExp youtube com
  • 如何在另一个自定义 Hook 中使用返回值的自定义 Hook?

    我正在使用 React native 其中有一个名为的自定义 HookuseUser使用以下方法从 AWS Amplify 获取用户信息Auth getUserInfro方法 然后获取返回对象的一部分并用它设置一个状态变量 我还有另一个名为
  • 使用 JavaScript 移动页面上的按钮

    我的按钮可以移动 但奇怪的是 我无法弄清楚偏移是否有问题 我希望我的按钮随着鼠标光标移动 但现在它的移动方式不是我想要的 有时它会消失 另外 创建的新按钮是重叠的 我不知道如何解决这个问题并拥有更好的外观 var coorA var coo
  • 改变 JavaScript 中的顶部填充

    以下是我在 css 中设置顶部填充的方法 body font size font size px margin 0 padding 100px 0 20px 0 width 100 important 如何使用最简单的 javascript
  • 使用 Javascript 设置 cookie [重复]

    这个问题在这里已经有答案了 我正在尝试构建我的第一个移动应用程序 它需要连接到我的 mysql 数据库并使用 json 返回数据 这很好 目前我有一个登录系统 一旦确定用户名和密码存在 它就会返回一条成功消息 对于下一步 我想在我的页面上使
  • 用于选择特定 div 中具有特定类的锚元素的 jQuery 选择器是什么

    我有一些这样的代码 我想选择每个 a 带有类的标签status在 div 中foo div a class status a div 你可以这样做 foo find status a
  • $resource.query 返回分割字符串(字符数组)而不是字符串

    我正在使用像下面这样的 Angular resource angular module app factory data function resource var Con resource api data update method P
  • 仅当显式选择行时才关闭 ui-bootstrap typeahead

    我创建了这个jsBin http jsbin com livuqafe 2 edit来证明我遇到的问题 如果您转到此处 请尝试输入 五 并继续 你的自然反应是输入 五 然后按 Tab 如果你想要 五百 你可以向下箭头一次 但是 在这种情况下
  • 测量窗口偏移

    有没有一种方法可以测量 jQuery 中窗口的偏移量 以便我可以比较 固定 元素和相对定位元素的位置 我需要能够知道窗口滚动了多远 以便我可以使用该图来计算固定元素的高度 相对于视口顶部 和相对对象的高度 相对于顶部 之间的差异文件的内容

随机推荐

  • 微信开发者工具的版本控制

    注意事项 拉取代码时 应先关闭所有的编辑器代码页面 清理版本管理工具里的工作区 保存到本地 不管什么时候 需要把代码提交到线上的请先拉取一下线上代码 一 提交代码流程 先在 微信开发者工具 的 版本管理 中把代码存储在本地分支上 拉取线上分
  • 用js实现简单的满屏跳动的心

    用js实现简单的满屏跳动的心
  • 实施MES系统的成功率只有50%,你知道为什么吗?

    MES系统可以称之为生产制造产业生产和管理方法实现代化的管理中心 假如可以非常好的执行和运用MES 那么将有益于提升公司的生产率 降低消耗成本 但为什么会有些公司MES执行实际效果不佳呢 原因之一 我国制造业存在管理方法基础的先天发育不足
  • Android中LCD背光驱动

    分类 Linux驱动 Android系统 2013 06 17 16 28 287人阅读 评论 0 收藏 举报 目录 Android的Setting Android的背光JNI层 Android的背光HAL层 Linux的背光内核层 Lin
  • 【web基础】html常用标签+作品展示

    前言 小亭子正在努力的学习编程 接下来将开启javaEE的学习 分享的文章都是学习的笔记和感悟 如有不妥之处希望大佬们批评指正 同时如果本文对你有帮助的话 烦请点赞关注支持一波 感激不尽 说明 此部分是java web基础知识 学的不深 仅
  • python爬虫万能模板

    以下是一个简单的 Python 爬虫模板 可以用于爬取网页数据 python import requests from bs4 import BeautifulSoup 设置请求头 模拟浏览器访问 headers User Agent Mo
  • kubectl命令详解

    目录 一 kubectl命令详解 1 查看某个资源的详细信息 kubectl describe pod pod name n nameapace 2 查看指定命名空间中pod的基本信息 kubectl get pods n namespac
  • kubernetes自建单节点elasticsearch ,用做数据库

    apiVersion v1 kind ConfigMap metadata name es configmap namespace kube system data elasticsearch yml cluster name NAMESP
  • redis key以目录展示的算法 以及其他redis相关

    文章目录 前言 一 redis相关 二 目录展示算法 结果展示 前言 一般在开发中使用redis时 都会使用冒号进行key的分割 例如login token admin等等 最近被要求编写可视化redis管理的工具 要以树形文件夹目录展示r
  • 环境类传感器介绍

    经过前几篇的原理讲解 大家对市面上类似气体 PM2 5 火焰呀这类传感器有一定的了解 但是到采购环节就迷茫了 毕竟市面上的产品五花八门 挑的眼花缭乱 今天给大家介绍几款简单的传感器 如果大家有别的传感器 也可以采用 甲醛检测 ZE08 CH
  • unity2017Progressive Lightmapper,Navmesh,Timeline三大新特性总结

    今天看了刘国柱的unity2017新特性 keynote大会三大核心详解视频课程 以免忘记 所以总结了下 想要具体了解的话可以去51cto观看刘国柱的视频 一 更强大的图像处理 1 Progressive LightMapper 2 新灯光
  • 如何计算Map

    一 VOC07 11点计算法 在VOC2010以前 只需要选取当Recall gt 0 0 1 0 2 1共11个点时的Precision最大值 然后AP就是这11个Precision的平均值 在VOC2010及以后 需要针对每一个不同的R
  • MySQL查询条件中字符串包含空格的问题

    2013 11 27 wcdj 问题 最近在联调某个业务时发现使用的签名总是验证不过 在MySQL中查询了该业务的私钥配置和业务侧的配置是一样的 问题就出在SQL查询这里 最后将配置导出到本地发现私钥后面多了一个空格 将空格删除然后签名计算
  • table嵌套table

  • QT 打开txt文件以及出现的乱码问题

    在用QT实现记事本打开功能时 在导入txt文件后会出现乱码问题 这时需要对导入文件编码进行设置 代码如下 void MainWindow open QString fileName 弹出打开文件对话框 fileName QFileDialo
  • Vb仓库管理系统与实现(论文+源代码+开题报告+外文翻译+文献综述)

    随着科学技术的不断提高 计算机科学不断发展 其强大的功能已经被人们深刻认识 它已经进入了人类社会的各个领域并发挥着越来越重要的作用 作为计算机应用的一部分 使用计算机对产品库存信息进行管理 是一直必然的趋势 本文主要分析了库存管理系统的一些
  • 在iOS开发中使用FMDB

    我的第一个应用使用的数据库是操作sqlite3 熟悉了之后 还不愿意换了 说实话这个方法并不是很轻量级 繁琐 复杂的数据读取插入后果就是崩了 我知道很大一部分原因是因为我的线程没处理好 出现死锁 逻辑混乱导致的 所以我想使用更轻量级的数据库
  • 离散数学:主范式(主析取范式、主合取范式)

    求解主析取范式 主合取范式方法 1 真值表法 在表中列出变元值的全部可能 查表判断命题 命题结果真 变元值对应主析取范式 命题结果假 变元值对应主合取范式 2 等值演算法 命题化简 蕴涵等值式 A B A B 作用 去 矛盾律 A A 作用
  • Latex作者上标和通讯作者图标

    作者上标 author Lily textsuperscript 1 and Alexw textsuperscript 2 通讯作者图标 usepackage misc ifsym begin document institute Let
  • fs 模块

    fs 全称为 file system 称之为 文件系统 是 Node js 中的 内置模块 可以对计算机中的磁盘进行操作 本章节会介绍如下几个操作 1 文件写入 2 文件读取 3 文件移动与重命名 4 文件删除 5 文件夹操作 6 查看资源