Nodejs-fs

DJY
170 阅读5分钟

fs

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

文件写入

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

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);
}

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) throw err;
console.log('追加成功')
});
fs.appendFileSync('./座右铭.txt','\r\n温故而知新, 可以为师矣');

//writeFile实现追加写入
fs.writeFile('./座右铭.txt','love',{flag:'a'},err=>{
if(err) throw err;
console.log('追加成功')
});
​

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

  • 编辑器保存文件

  • 视频录制

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

文件读取

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

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


//创建读取流对象
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 查看日志
  • 上传文件
  • 查看聊天记录

2-5 写入流和读取流简便操作


const rs=fs.createReadStream('内容')；
const ws=fs.createWriteStream('内容')；
rs.pipe(ws);

文件移动与重命名

在 Node.js 中，我们可以使用rename 或renameSync 来移动或重命名 文件或文件夹
语法：fs.rename(oldPath, newPath, callback)
fs.renameSync(oldPath, newPath)
参数说明：

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

代码示例：


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)

fs.rm(path,callback)

fs.rmSync(path)

参数说明：

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

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

文件夹操作

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 err;
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');
avatar
文章
阅读
粉丝