1.零基础Nodejs快速入门——fs模块

于 2024-03-13 21:53:57 发布
阅读量1.0k 收藏 31
点赞数 19
分类专栏： Node.js快速入门 文章标签： node.js 前端 服务器
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_37002374/article/details/136692326
版权
本文详细介绍了Node.js中的fs模块，包括文件写入（异步与同步）、文件读取（读取File与FileSync）、文件移动与重命名、删除文件、文件夹操作（mkdir,readdir,rmdir）、查看资源状态以及处理相对路径和使用__dirname。通过实例演示了各种操作方法及其应用场景。
摘要由CSDN通过智能技术生成

fs 模块

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

本章节会介绍如下几个操作：

1.   文件写入

2.   文件读取

3.   文件移动与重命名

4.   文件删除

5.   文件夹操作

6.   查看资源状态

一、文件写入

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

方法

说明

writeFile

异步写入

writeFileSync

同步写入

append File / append FileSync

追加写入

createWriteStream

流式写入

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 append File / append FileSync 追加写入

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

语法:

fs .append File (file ,  data [ ,  options] ,  callback)

fs .append FileSync(file ,  data [ ,  options])  

返回值：  二者都为

实例代码：

 

fs.append File ( ' . /座右铭 .txt ' , '择其善者而从之，其不善者而改之。 ' ,  err  =>  {

if(err)  throw  er r;

console .log( '追加成功 ' )

}) ;

fs.append FileSync( ' . /座右铭 .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() ;

1-5 写入文件的场景

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

   下载文件

  安装软件

  保存程序日志，如 Git

  视频录制

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

二、文件读取

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

 

方法

说明

read File

异步读取

read FileSync

同步读取

createReadStream

流式读取

2-1 read File 异步读取

语法：  fs . read File (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 read FileSync 同步读取

语法：  fs . read FileSync(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', 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   文件当前的路径
  •     callback   操作后的回调

代码示例：

fs. rename ( ' . /观书有感 .txt ' ,  ' . /论语/观书有感 .txt ' ,  (err)  =>{

if(err)  throw  er r;

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  er r;

console .log( '删除成功 ' ) ;

}) ;

fs.unlinkSync( ' . /test2 .txt ' ) ;

五、文件夹操作

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

方法

说明

mkdir / mkdirSync

创建文件夹

readdir / readdirSync

读取文件夹

rmdir / rmdirSync

删除文件夹

 

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) 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   操作后的回调

示例代码：

//异步读取

fs. readdir( ' . /论语 ' ,  (err ,  data)  =>  {

if(err)  throw  er r;

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) 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   操作后的回调

示例代码：

//异步获取状态
fs.stat('./data.txt', (err, data) => {
if(err) throw err;
console.log(data);
});
//同步获取状态
let data = fs.statSync('./data.txt');

结果值对象结构：

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

 

七、相对路径问题

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

  相对路径

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

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

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

  绝对路径

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

    /us r/bin                   Linux 系统下的绝对路径

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

八、__dirname

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

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

代码示例：

let  data  =  fs. read FileSync(__dirname  +  ' /data .txt ' ) ;

console .log(data) ;

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

九、练习

1.   编写一个 JS 文件，实现复制文件的功能

2.   文件重命名

平平爸爸请暴富
关注
  • 19
    点赞
  • 踩
  • 31
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
专栏目录
node.js中的fs.readdir方法使用说明
01-02
方法说明： 以异步的方式读取文件目录。 语法： 代码如下: fs.readdir(path, [callback(err,files)]) 由于该方法属于fs模块，使用前需要引入fs模块（var fs= require(“fs”) ） 接收参数： path  目录路径 callback   回调，传递两个参数 err 和 files，files是一个包含 “ 指定目录下所有文件名称的” 数组。 例子： 代码如下: var fs = require(‘fs’); fs.readdir(‘readdirtest’, function(err,files){  if(err){   cons
nodejs 通过readdir方法 遍历指定文件夹下所有的文件夹(更新版) 第二种方法会在遍历完成后回调
jsp13270124的博客
09-11 3463
var fs = require('fs'); // 指定是父级文件下的什么的文件夹 var dirfath = 'html1'; readDir(dirfath); function readDir(dirfather) { fs.readdir(dirfather, function(err, data) { if (err) { console.log('停止迭代'); ...
Node.js学习笔记（三）（fs模块）
小豆花儿的学习之路
06-30 191
fs.stat 文件信息 fs.mkdir 创建目录 fs.readdir 读取目录 fs.rmdir 删除目录 fs.writeFile 写入文件 fs.readFile 读取文件 fs.appendFile 追加文件 fs.rename 1、重命名 2、移动文件 fs.unlink 删除文件 fs.createReadStream 读取文件流 fs.createWriteStream 写入文件流 rs.pipe(ws) 管道流 const fs = require('fs'); fs.stat(.
NodeJS 之 fs 模块（文件操作）
两个月亮
01-21 4494
在大多数时候，你应该使用异步方法。异步方法对开发者更为友好，并且使用异步方法也更能发挥好 NodeJS 本身的优势。但也不能对同步方法一味的排斥，在某些情况下（例如读取配置文件并启动服务器），你应该使用同步方法。
Node.js-fs模块文件创建、删除、重命名、文件内容的写入、读取以及文件夹的相关操作
北斗星的爱886的博客
08-01 2712
node.js内置模块=>fs文件系统模块基础，用来操作文件及文件夹，增删改的基本使用。
NodeJS学习笔记之FS文件模块
10-24
在看nodejs介绍的过程中，nodejs对自己的异步I/O是重点突出的说明的。在fs模块中，nodejs提供了异步和同步两种读写方式
nodejs-fs模块
最新发布
04-21
Node.js的fs模块是核心模块之一，用于处理文件系统操作，包括读取、写入、创建、删除等。本文将全面解析fs模块的各种功能，并通过同步和异步两种方式介绍其用法。 **I. 同步与异步读取文件** 在Node.js中，读取...
详解nodejs 文本操作模块-fs模块（五）
10-20
本篇文章主要介绍了nodejs 文本操作模块-fs模块（五），这里再说最后一个我看来很重要的方法，监听文件或者目录的的方法watchFile。有兴趣的可以了解一下。
详解nodejs 文本操作模块-fs模块（三）
10-20
本篇文章主要介绍了nodejs 文本操作模块-fs模块（三），详细的讲诉了readFile，和writeFile方法，具有一定的参考价值，有兴趣的可以了解一下。
hudson.plugins.nodejs.tools.NodeJSInstaller 版本最高为17.9.0
04-13
用于解决jenkins安装nodeJs插件后不能选择nodejs版本，将该文件上传到服务器，然后 docker cp ./hudson.plugins.nodejs.tools.NodeJSInstaller 容器ID:/var/jenkins_home/updates 然后重启Jenkins
node.js中的fs.readFileSync方法使用说明
01-01
方法说明： 同步版的 fs.readFile() 。 语法： 代码如下: fs.readFileSync(filename, [encoding]) 由于该方法属于fs模块，使用前需要引入fs模块（var fs= require(“fs”) ） 接收参数： filename    文件路径 options      option对象，包含 encoding，编码格式，该项是可选的。 例子： 代码如下: var fs = require(‘fs’);   var contentText = fs.readFileSync(‘123.txt’,’utf-8′);   console.log(
NodeJs实现读取目录文件，以及文件批量生成
09-11
NodeJs实现读取目录文件(node dir_new list)，以及文件批量生成(node dir_new)
核心模块fs模块的文件 存入与读取
Qiemo_的博客
04-25 1116
理解核心模块 核心模块是Node内置的模块,需要通过唯一的标识名来进行获取 每一个核心模块基本上都是暴露了一个对象,里面包含一些方法供我们使用 一般在加载核心模块的时候,变量(或常量名)的起名最好和核心模块的标识名同名 例如: const fs = require('fs') console.log(fs) const path = require('path') console.log(path) fs模块(fs是FileSystem文件系统的简写)是Node.js核心模块中用来进行文件操作
node基础知识—— fs模块、path模块
老司机的后备箱
06-07 898
fs 模块是 Node.js 官方提供的、用来操作文件的模块。它提供了一系列的方法和属性，用来满足用户对文件的操作需求。 读取指定文件中的内容 1. fs.readFile()的语法格式 使用 fs.readFile() 方法，可以读取指定文件中的内容，语法格式如下： 参数1：必选参数，需要指定一个文件路径的字符串，表示要读取哪个路径对应的文件。 参数2：可选参数，表示以什么编码格式来读取文件。 参数3：必选参数，文件读取完成后，通过回调函数拿到读取的结果。 2. fs.readFile()的示例代码
nodeJs针对文件、文件夹的操作
hjdjhh的博客
06-08 2724
目录fs 读取操作文件引入与注意事项增fs.writeFile() 覆盖fs.appendFile() 追加fs.mkdir() 文件夹删fs.rm() 删除文件fs.rmdir() 删除文件夹改fs.rename() 查fs.exists() 判断文件或目录是否存在,返回bool值fs.readdir() 读取目录下的所有文件和子目录fs.readFile() 读取文件compressing 压缩、解压文件安装与引用使用压缩单个文件压缩文件夹解压文件解压含有中文名的文件引入 注意事项1 添加后缀 s
nodejs 遍历目录结构
haliofwu的专栏
07-05 5007
nodejs 的递归算法的应用。 var fs = require("fs") function walk(dir) { var children = [] fs.readdirSync(dir).forEach(function(filename){ var path = dir+"/"+filename var stat = fs.statS
nodejs核心模块fs删除文件_nodejs - fs模块 - 文件操作
weixin_34649105的博客
02-02 1265
1， fs.stat 检测是文件还是目录2， fs.mkdir 创建目录var fs = require('fs')fs.mkdir('./dir',function(err){if(err){console.log(err)return false}console.log('mkdir has been complete')})3， fs.writeFile 创建写入文件如果文件不存在会自动创...
Nodejs 检测指定目录下所有文件
m0_57835615的博客
07-26 867
在Nodejs中，文件系统提供了许多的文件操作方法，借助stat方法和readdir方法，我们可以检测某个指定目录及其下的所有文件或目录。 检测test目录： 完整代码： const fs = require('fs') let startRoute = './' let startName = 'test' let check = (route, name) => { let src = route + name
nodejs-操作文件系统读取写入文件
热门推荐
songmaolin_csdn的博客
10-24 3万+
我们通过fs这个模块来对文件系统进行操作，对于文件系统操作一般都有同步、异步方法，两者区别，同步等有返回结果时候，在继续执行后面的代码，异步是不等返回结果，直接执行后面的代码，待有返回结果时候，通过回调函数来做出处理。一般同步方法函数名在异步方法名字后面加Sync，如异步读取文件readFile,同步读取文件为readFileSync，大多数情况用异步方法、但是读取配置文件要用同步方法。 rea
Jering.Javascript.NodeJS调用nodejs npm的方法
03-22
可以使用以下代码来调用nodejs npm的方法： ``` var child_process = require('child_process'); child_process.exec('npm install <package-name>', function(error, stdout, stderr) { // 处理结果 }); ``` 其中，`<package-name>`是你想要安装的npm包的名称。这段代码会在Node.js中执行npm install命令，安装指定的npm包。你可以在回调函数中处理安装结果。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值