nodejs----fs文件系统、利用fs及path进行文件操作

r囧r小猫 2022-12-11 13:35 320阅读 0赞

### 目录 ###

*  Node.js fs----文件系统
 *   *  fs----基本操作
     *  创建文件
     *  读取文件
     *  写入文件
     *  总结

我们平时在创建文件时，直接点击按钮新建或者右键新建文件夹，那么我们应该如何利用NodeJS代码来创建文件呢？

# Node.js fs----文件系统 #

`fs` 模块可用于与文件系统进行交互  
所有的文件系统操作都具有同步的、回调的、以及基于 promise 的形式。

> 异步的方法函数最后一个参数为回调函数，回调函数的第一个参数包含了错误信息(error)。

## fs----基本操作 ##

异步创建文件目录  
`fs.mkdir(path[, options], callback)`

// 创建 `/目录1/目录2/目录3`，不管 `/目录1` 和 `/目录1/目录2` 是否存在。
    fs.mkdir('/目录1/目录2/目录3', {  recursive: true }, (err) => { 
      if (err) throw err;
    });

同步创建文件目录  
`fs.mkdirSync(path[, options])`

检查文件属性（异步操作）  
`fs.stat(path[, options], callback)`: 回调有两个参数 (err, stats)，其中 stats 是`fs.Stats` 对象。

`stats.isFile()`:如果 fs.Stats 对象描述普通的文件，则返回 true。  
`stats.isDirectory()`:如果 fs.Stats 对象描述文件系统目录，则返回 true。

>     一般回调函数中的第一个参数是错误对象  如果为null 表示没有错误，否则有错误

输出**console.log(stats)** 之后，会打印出：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1BJTElwaWxpcGFsYQ_size_16_color_FFFFFF_t_70_pic_center]

*  atime ----文件访问的时间
 *  ctime ----文件的状态、信息发生变化的时间
 *  mtime ----文件数据发生变化的时间
 *  birthtime ----文件的创建时间

检查文件属性（同步操作）

`fs.statSync(path[, options])`

读取文件（异步操作）

`fs.readFile(path[, options], callback)`:异步地读取文件的全部内容。

fs.readFile('文件名', (err, data) => { 
      if (err) throw err;
      console.log(data);
    });

读取文件（同步操作）  
`fs.readFileSync(path[, options])`

写入文件（异步操作）  
`fs.writeFile(file, data[, options], callback)`:当 file 是文件名时，则异步地写入数据到文件（如果文件已存在，则覆盖文件）。 data 可以是字符串或 buffer。

//data为字符串类型
    fs.writeFile('文件.txt', '写入内容', 'utf8', callback);
    
    //data为Buffer类型
    let buf = Buffer.from('nihao');
    fs.writeFile('文件.txt', buf, 'utf8', callback);

## 创建文件 ##

我们平时在创建文件时，直接点击按钮新建或者右键新建文件夹，那么我们应该如何利用NodeJS代码来创建文件呢？  
**步骤一：导入需用的模块**

//require()导入模块
    //导入路径操作模块
    const path = require('path');
    //导入文件操作系统 模块
    const fs = require('fs');

**步骤二：初始化文件目录**

//创建项目 存储的目录地址
    let root = 'C:\\Users\\star0\\Desktop\\NodeJS';
    //初始化
    let initData = { 
        projectName:'mydemo',
        data:[
            {  name:'img',type:'dir'},
            {  name: 'css', type: 'dir'},
            {  name: 'js', type: 'dir'},
            {  name:'index.html',type:'file'}
           
        ]
    
    }

**步骤三：创建项目的根路径**

fs.mkdir(path.join(root,initData.projectName),(err)=>{ 
        if(err){ 
            return;
        }
    });

**步骤四：创建子路径及文件**

initData.data.forEach((item)=>{ 
        if (item.type=='dir') { 
            //创建子目录
             fs.mkdirSync(path.join(root,initData.projectName,item.name))
        } else if(item.type=='file'){ 
            //创建文件 并写入内容
            fs.writeFileSync(path.join(root,initData.projectName,item.name),fileContent)
        }
    })
    let fileContent=` <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Document</title> </head> <body> </body> </html> `;

最终效果图：![在这里插入图片描述][2020100113014651.png_pic_center]

## 读取文件 ##

**步骤一：创建两个文件**  
一个js文件用来写代码，另一个为可读文件(例子中采用txt文件，并在txt文件中写入内容)  
![在这里插入图片描述][20201010181635513.png_pic_center]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1BJTElwaWxpcGFsYQ_size_16_color_FFFFFF_t_70_pic_center 1]

**步骤二：导入所需用到的模块**

const fs = require ('fs');
    const path = require('path');

**步骤三：利用path.join()方法拼接txt文件路径**

let strpath = path.join(__dirname,'data.txt');

**步骤四：利用fs.readFile()方法进行读文件操作**

//第一种：
     fs.readFile(strpath,(err,data)=>{ 
         if (err) return;
    
        console.log(data.toString());
        
     });
     //第二种：
      fs.readFile(strpath,utf8,,(err,data)=>{ 
         if (err) return;
    
        console.log(data);
        
     });

**最终结果为：**  
![在这里插入图片描述][20201010181849452.png_pic_center]

## 写入文件 ##

接着读取文件的代码开始，我们可以直接使用`fs.writeFile()`方法进行写入文件的操作

let strpath_01 = path.join(__dirname,'data.txt');
     fs.writeFile(strpath_01,'吃不吃','utf8',(err)=>{ 
         if(!err){ 
             console.log('成功写入文件')
         }
     })

最终结果：  
![在这里插入图片描述][20201010183103134.png_pic_center]  
![在这里插入图片描述][20201010183113922.png_pic_center]

## 总结 ##

1.在创建目录的存储地址时，我们使用的是双斜杠，这是因为：我们是把路径当成是一个字符串传进去的,在字符串中斜杠“\\”被当做转义字符识别,所以要用“\\ \\”才能表示一个斜杠;  
2. 文件类型：`dir`指向的是当前执行的父级路径,`file`指向的是当前执行脚本路径;  
3. 在vscode软件上运行代码时，在创建文件时会报错`file already exists`,这是因为已经创建子目录之后，在创建文件时，代码不会再次创建子目录，解决方法：第一种可以直接注释创建子目录代码语句，第二种可以再添加if-else语句进行判断。  
4. 同步操作更消耗时间

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1BJTElwaWxpcGFsYQ_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/14945ee2461d4017b9f19bc7a7e96990.png
[2020100113014651.png_pic_center]: /images/20221123/65360a77bdca4649ad54d829b1f6486e.png
[20201010181635513.png_pic_center]: /images/20221123/81b072da3344405eb126d8796d9bf034.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1BJTElwaWxpcGFsYQ_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/7e34b517b5de401bad5879fe63e02b6e.png
[20201010181849452.png_pic_center]: /images/20221123/869b7b34ee074cb0a9e502edf5094de0.png
[20201010183103134.png_pic_center]: /images/20221123/93e7a04ea41b46c1b7cdad2c5b4abfbe.png
[20201010183113922.png_pic_center]: /images/20221123/0d8a4e33e992431889f95016d7751202.png