NodeJs-fs模块

目录

一、fs简介

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

主要介绍如下几个操作：

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

二、文件写入

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

方法说明
writeFile异步写入
writeFileSync同步写入
appendFile /appendFileSync追加写入
createWriteStream流式写入

2.1 writeFile 异步写入

语法： fs.writeFile(file, data[, options], callback)
参数说明：

  • file 文件名
  • data 待写入的数据
  • options 选项设置 （可选）
  • callback 写入回调

返回值： undefined

代码示例:

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

//2.写入文件（writeFile异步写入）
fs.writeFile('./file/writeFile.txt','三人行，则必有我师焉',err=>{
    //如果写入失败，则回调函数调用时，会传入错误对象，如写入成功，会传入 null
    if(err){
        console.log('写入失败');
        return
    }
    console.log('写入成功');
})

2.2 writeFileSync 同步写入

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

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

返回值： undefined

代码示例：

//写入文件，writeFileSync同步写入,没用回调函数
try {
    fs.writeFileSync('./file/writeFileSync.txt','你好啊世界');
} catch (error) {
    console.log(error);
}

Node.js 中的磁盘操作是由其他 线程 完成的，结果的处理有两种模式：

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

2.3 appendFile / appendFileSync 追加写入

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

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

返回值： 二者都为 undefined

实例代码：

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

// 2.appendFile异步追加写入
fs.appendFile('./file/appendFile.txt','异步追加写入,nodejs',err=>{
    if(err) throw err;
    console.log('异步追加成功');
})
console.log(1);

//3.appendFileSync同步追加写入
fs.appendFileSync('./file/appendFileSync.txt','同步追加写入,nodejs');

//4.writeFile实现追加写入
fs.writeFile('./file/writeFile.txt',',love love',{flag:'a'},err=>{
    if(err) throw err;
    console.log('异步追加成功');
})

2.4 createWriteStream 流式写入

语法： fs.createWriteStream(path[, options])
参数说明：

  • path 文件路径
  • options 选项配置（ 可选 ）

返回值： Object
代码示例：

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

//2.创建写入流对象
const ws = fs.createWriteStream('./file/stream.txt');

//3.write写入
ws.write('你好啊')
ws.write('手机接')

//4.关闭通道
ws.close();

程序打开一个文件是需要消耗资源的 ，流式写入可以减少打开关闭文件的次数。
流式写入方式适用于 大文件写入或者频繁写入 的场景, writeFile 适合于 写入频率较低的场景

三、文件读取

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

方法说明
readFile异步读取
readFileSync同步读取
createReadStream流式读取

3.1 readFile 异步读取

语法： fs.readFile(path[, options], callback)
参数说明：

  • path 文件路径
  • options 选项配置
  • callback 回调函数

返回值： undefined
代码示例：

//1.引入fs模块
const fs = require('fs');

//2.异步读取
fs.readFile('./file/appendFile.txt','utf-8',(err,data)=>{
    if(err){
        console.log("读取失败");
        return;
    }
    console.log(data.toString());
})

3.2 readFileSync 同步读取

语法： fs.readFileSync(path[, options])
参数说明：

  • path 文件路径
  • options 选项配置

返回值： string | Buffer
代码示例：

let data = fs.readFileSync('./座右铭.txt');
let data2 = fs.readFileSync('./座右铭.txt', 'utf-8');

3.3 createReadStream 流式读取

语法： fs.createReadStream(path[, options])
参数说明：

  • path 文件路径
  • options 选项配置

返回值： Object
代码示例：

//1.创建fs模块
const fs = require('fs');

//2.流式读取
const rs = fs.createReadStream('./file/appendFile.txt');

//3.每次取出 64k 数据只执行一次 data 回调
rs.on('data',data=>{
    console.log(data.toString())
})

//4.读取完毕后, 执行 end 回调
rs.on('end',()=>{
    console.log('读取完成');
})

四、文件移动与重命名

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

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

参数说明：

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

代码示例：

//1.引入fs模块
const fs = require('fs');
// 2.文件重命名rename renameSync(同步)
fs.rename('./file/test.txt','./file/hello.txt',err=>{
    if(err){
        console.log(err);
        return;
    }
    console.log('操作成功');
})

//3.文件移动
fs.renameSync('./file/hello.txt','./hello.txt');

五、文件删除

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

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

参数说明：

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

代码示例：

//1.引入fs模块
const fs = require('fs');

//2.可以使用 unlink 或 unlinkSync 来删除文件
fs.unlink('./file/test.txt',err=>{
    if(err){
        console.log(err);
        return;
    }
    console.log('删除成功');
})

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


//3.还可以调用14.4版本新出的rm和rmSync来删除文件
fs.rm('./file/test.txt',err=>{
    if(err){
        console.log(err);
        return;
    }
    console.log('删除成功');
})

六、文件夹操作

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

方法说明
mkdir / mkdirSync创建文件夹
readdir / readdirSync读取文件夹
rmdir / rmdirSync删除文件夹

6.1 mkdir创建文件夹

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

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

参数说明：

  • path 文件夹路径
  • options 选项配置（ 可选 ）
  • callback 操作后的回调

示例代码：

//1.引入fs模块
const fs = require('fs');

//2.可以使用 mkdir 或 mkdirSync 来创建文件夹
fs.mkdir('./file',err=>{
     if(err) return;
     console.log('创建成功');
 })

//递归异步创建
fs.mkdir('./a/b/c',{recursive:true},err=>{
    if(err) return;
    console.log('创建成功');   
})

//递归同步创建
fs.mkdirSync('./c/b/a',{recursive:true});

6.2 readdir 读取文件夹

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

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

参数说明：

  • path 文件夹路径
  • options 选项配置（ 可选 ）
  • callback 操作后的回调

示例代码：

//1.引入fs模块
const fs = require('fs');
//2.可以使用 readdir 或 readdirSync 来读取文件夹
fs.readdir('./file',(err,data)=>{
    if(err) return;
    console.log(data);
})
//3.同步读取
let data = fs.readdirSync('./file');
console.log(data);

6.3 rmdir 删除文件夹

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

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

参数说明：

  • path 文件夹路径
  • options 选项配置（ 可选 ）
  • callback 操作后的回调

示例代码：

//1.引入fs模块
const fs = require('fs');
//2.可以使用 rmdir 或 rmdirSync 来删除文件
fs.rmdir('./a',{recursive:true},err=>{
    if(err) return;
    console.log('删除成功');
})
//3.现在版本可以用rm代替rmdir
fs.rm('./a',{recursive:true},err=>{
    if(err) return;
    console.log('删除成功');
})

//4.同步删除文件夹
fs.rmdirSync('./c',{recursive:true});

七、查看资源状态

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

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

参数说明：

  • path 文件夹路径
  • options 选项配置（ 可选 ）
  • callback 操作后的回调
//1.引入fs模块
const fs = require('fs');
//2.可以使用 stat 或 statSync 来查看资源的详细信息
//异步获取状态
fs.stat('./file',(err,data)=>{
    if(err) return;
    console.log(data.isDirectory())
})
//同步获取状态
let data = fs.statSync('./file/test.txt');
console.log(data);
/*
size 文件体积
birthtime 创建时间
mtime 最后修改时间
isFile 检测是否为文件
isDirectory 检测是否为文件夹
*/

结果值对象结构：

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

八、__dirname 和 path

8.1 __dirname

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

//1.引入fs模块
const fs = require('fs');
//2.__dirname 保存着 当前文件所在目录的绝对路径 ，可以使用 __dirname 与文件名拼接成绝对路径
console.log(__dirname);
//读取文件
let data = fs.readFileSync(__dirname+'\\file\\test.txt');
console.log(data.toString())

8.2 path 模块

可以使用path模块进行路径的拼接,path 模块提供了 操作路径 的功能，我们将介绍如下几个较为常用的几个 API：

API说明
path.resolve拼接规范的绝对路径 常用
path.sep获取操作系统的路径分隔符
path.parse解析路径并返回对象
path.basename获取路径的基础名称
path.dirname获取路径的目录名
path.extname获得路径的扩展名

代码示例：

const path = require('path');
//获取路径分隔符
console.log(path.sep);
//拼接绝对路径
console.log(path.resolve(__dirname, 'test'));
//解析路径
let pathname = 'D:/program file/nodejs/node.exe';
console.log(path.parse(pathname));
//获取路径基础名称
console.log(path.basename(pathname))
//获取路径的目录名
console.log(path.dirname(pathname));
//获取路径的扩展名
console.log(path.extname(pathname))