Node.js-fs文件操作模块

傷城~ 2023-06-21 10:26 23阅读 0赞

fs （file 文件 ，system 系统）模块就是文件系统操作模块，属于 Node.js 中的核心模块 ， 用于与文件进行交互。

#### 读写文件 ####

###### 读取文件内容 ######

**[fs.readFile(file\[,encoding\]\[,callback(err,data)\])][fs.readFile_file_encoding_callback_err_data]** 异步方式读取文件内容。

*  `fs` 通过 require() 方法导入的 fs 模块

参数：

*  `file` 需要读取的文件
 *  `encoding` 文件的字符编码，以何种编码解析数据（默认值为 null）
 *  `callback` 回调函数，用于接收文件内容。
    
        // fs 模块不是全局模块，使用时需要加载 fs 核心模块
        var fs = require('fs');
        // 读取指定文件中的内容
        fs.readFile('./data/hello.txt',function(error,data){ 
          console.log(error);
          // 未设置默认字符集时，输出的 data 内容为二进制数据流（返回原始的 buffer）
          console.log(data);
          // 通过 Buffer 对象的 toString() 方法将 data 解码成字符串（默认的字符编码为 utf8）
          console.log(data.toString());
        });
    
    **注意：**
    
     *  读取到文件时 err 为 null ，data 为读取到的数据；否则 err 为 错误对象，data 为 undefined；为了代码的可读性更强最好将 `encoding` 设为 `utf8` 。
    
     *  使用 `fs` 模块操作文件时，`fs` 模块方法中的路径如果是相对路径，这相对路径是相对于执行 node 命令的路径，当执行 node 命令的路径改变时，操作文件会失败；所以最好使用 `__dirname` 拼接为绝对路径。  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ4NjUzOQ_size_16_color_FFFFFF_t_70]

###### 向文件写入内容 ######

**[fs.writeFile(file,data\[,options\],callback)][fs.writeFile_file_data_options_callback]** 异步方式将数据写入文件，若文件不存在将会在指定目录下（目录必须存在）创建文件并写入数据，若文件存在则会被覆盖。

参数：

*  `file` 写入数据的文件路径
 *  `data` 需要写入的数据（可以是字符串也可以是 buffer）
 *  `potions` 对象（可设置字符编码）
 *  `callback` 回调函数，只包含错误信息参数(err)。
    
        var fs = require('fs');
        // 将数据写入指定文件中
        fs.writeFile('./data/hello.txt','通过 fs.writeFile()写入数据',function (error) { 
          console.log(error);
        });
    
    **注意**： 数据写入成功时 error 为 null 否则说明数据写入失败；当 data 是一个 buffer 时 encoding 会被忽略。

###### 向文件追加内容 ######

**[fs.appendFile(path, data\[, options\], callback)][fs.appendFile_path_ data_ options_ callback]**：该方法发会异步地将数据追加到指定文件中，不会覆盖原来的内容，如果文件不存在则会创建该文件。

参数：

*  `path` 文件路径
 *  `data` 要追加的内容
 *  `options` 该参数是一个对象可以指定字符编码，默认为 urf8；该参数一般用不到
 *  `callback` 追加完成后（不一定成功）执行的回调函数，该回调函数只有一个参数就是错误对象 error
    
        var fs = require('fs');
        // 将数据写入指定文件中
        fs.appendFile('./data/hello.txt', '\n通过 fs.appendFile()追加数据', function (error) { 
          console.log(error);
        });
    
    通过 `\n` 可进行换行

##### 删除文件 #####

[**fs.unlink(path, callback)**][fs.unlink_path_ callback]： 异步的删除文件，该方法只能删除文件不能删除目录。

参数

*  `path` 文件路径
 *  `callback` 删除失败执行的回调函数；该函数只有一个参数 err

const fs = require('fs')
    // 删除文件
    fs.unlink(__dirname + '/data/unlink.txt', function(err) { 
      // 删除失败时打印失败信息
      if (err) { 
        return console.log(err)
      }
      console.log('删除文件成功！')
    })

###### 重命名文件 ######

[**fs.rename(oldPath, newPath, callback)**][fs.rename_oldPath_ newPath_ callback]： 异步的重命名文件；如果 `newPath` 已存在会覆盖原来的文件。

*  `olaPath` 旧的文件路径，包含文件名
 *  `newPath` 新的文件路径，包含文件名
 *  `callback` 重命名失败执行的回调函数，该函数只有一个参数 err

const fs = require('fs')
    // 重命名文件
    fs.rename(__dirname + 'data/hello.txt', __dirname + '/data/rename.txt', function(err) { 
      // 重命名失败时打印失败信息
      if (err) { 
        return console.log(err)
      }
      console.log('重命名文件成功！')
    })

###### 读取文件状态 ######

**[fs.stat(path\[, options\], callback)][fs.stat_path_ options_ callback]**：用于读取文件的状态，获取文件相关的信息

参数：

*  `path` 文件路径
 *  `option`
 *  `callback` 回调函数，在读取文件完成后执行的函数，该函数包含两个参数：
    
     *  err 读取失败时的错误信息对象
     *  stats 读取成功时的文件信息对象，通过该对象的相关属性和方法可以获取文件相关的信息

示例：

stat.js

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ4NjUzOQ_size_16_color_FFFFFF_t_70 1]  
相关常见属性：

*  `size` 文件的大小，单位为 Byte（字节）
 *  `birthtime` 文件创建的日期

相关常见方法：

*  `isFile()` 判断 stats 描述的是否为文件，是文件时返回 true 否则返回 false
 *  `isDirectory()` 判断 stats 描述的是否为目录，为目录时返回 true 否则返回 fasle

示例：

stat.js

const fs = require('fs')
    // 读取文件状态
    fs.stat(__dirname + '/data/hello.txt', function(err, stats) { 
      // 读取失败时打印失败信息
      if (err) { 
        return console.log(err.message)
      }
      // 打印文件信息
      console.log('文件大小：', stats.size)
      console.log('文件创建日期：', stats.birthtime)
      console.log('是否为文件：', stats.isFile())
      console.log('是否为目录：', stats.isDirectory())
    })

![在这里插入图片描述][20191217102437888.png]

###### 复制文件 ######

**[fs.copyFile(src, dest\[, flags\], callback)][fs.copyFile_src_ dest_ flags_ callback]**：该方法用于异步的将指定目录下的文件拷贝到目标目录中，如果目标目录中有同名的文件则会被覆盖。

参数：

*  `src` 源文件路径（包含文件名）
 *  `dest` 目标文件路径（包含文件名）
 *  `flags` 用于指定拷贝操作的修饰符，默认为 0
 *  `callback` 拷贝完成后执行的回调函数，该函数有一个存储错误信息的对象参数；拷贝成功时该参数的值为 null，拷贝失败该参数的值为错误信息

示例：

copyFile.js

const fs = require('fs')
    
    // 拷贝文件
    fs.copyFile(
      // 源文件路径
      __dirname + '/data/hello.txt',
      // 目标路径
      __dirname + '/data/newHello.txt',
      function(err) { 
        // 打印错误参数对象
        console.log(err)
      }
    )

![在这里插入图片描述][20191217114555833.png]

#### 目录操作 ####

###### 创建目录 ######

**[fs.mkdir(path\[, options\], callback)][fs.mkdir_path_ options_ callback]** 异步的创建目录（包括文件），通过该方法可以创建指定结构的目录。

参数：

*  `path` 需要创建的文件目录
 *  `callback` 回调函数，目录创建完成（完成并不代表成功）后执行的回调函数。
    
        // 导入 fs 模块
        var fs = require('fs')
        
        /* 创建文件目录 */
        // 创建一级目录
        fs.mkdir('./mkdir', function(error) { 
          if (error) console.log(error)
          else { 
            console.log('一级文件夹创建成功！')
        
            // 创建 二级 目录 1
            fs.mkdir('./mkdir/temp', function(error) { 
              if (error) console.log(error)
              else console.log('二级文件夹创建成功1！')
            })
            // 创建 二级 目录 2
            fs.mkdir('./mkdir/temp2', function(error) { 
              if (error) console.log(error)
              else console.log('二级文件夹创建成功2！')
            })
            // 创建 二级 目录 3
            fs.mkdir('./mkdir/temp3', function(error) { 
              if (error) console.log(error)
              else console.log('二级文件夹创建成功3！')
        
              // 在 二级 目录 3 中创建 index.html 文件
              fs.mkdir('./mkdir/temp3/index.html', function(error) { 
                if (error) console.log(error)
                else console.log('index.html 文件创建成功！')
              })
            })
        
            // 创建 二级 目录 4
            fs.mkdir('./mkdir/temp4', function(error) { 
              if (error) console.log(error)
              else console.log('二级文件夹创建成功4！')
            })
        
            // 创建三级目录
            fs.mkdir('./mkdir/temp/childTemp', function(error) { 
              if (error) console.log(error)
              else console.log('三级文件夹创建成功！')
            })
          }
        })
    
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ4NjUzOQ_size_16_color_FFFFFF_t_70 2]  
    **注意：** 创建文件目录时必须要一级一级的创建（第一级创建后才能创建第二级），否则无法创建。

###### 读取目录 ######

**[fs.readdir(path\[, options\], callback)][fs.readdir_path_ options_ callback]** 异步的读取指定目录下的内容（文件和文件夹，只读取一级目录中的内容）

参数：

*  `path` 需要读取内容的路径
 *  `callback` 回调函数；该函数有两个参数 err 和 files
    
     *  err 错误信息
     *  files 目录中的文件夹名称的数组（以数组的形式存储指定目录下的内容）。

var fs = require('fs');
    // 读取指定目录下的内容
    fs.readdir(__dirname,function (err, files) { 
       console.log(files); 
    });

![在这里插入图片描述][20191217153154346.png]

[fs.readFile_file_encoding_callback_err_data]: http://nodejs.cn/api/fs.html#fs_fs_readfile_path_options_callback
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ4NjUzOQ_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191216214928574.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ4NjUzOQ==,size_16,color_FFFFFF,t_70
[fs.writeFile_file_data_options_callback]: http://nodejs.cn/api/fs.html#fs_fs_writefile_file_data_options_callback
[fs.appendFile_path_ data_ options_ callback]: http://nodejs.cn/api/fs.html#fs_fs_appendfile_path_data_options_callback
[fs.unlink_path_ callback]: http://nodejs.cn/api/fs.html#fs_fs_unlink_path_callback
[fs.rename_oldPath_ newPath_ callback]: http://nodejs.cn/api/fs.html#fs_fs_rename_oldpath_newpath_callback
[fs.stat_path_ options_ callback]: http://nodejs.cn/api/fs.html#fs_fs_stat_path_options_callback
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ4NjUzOQ_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20191217093017379.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ4NjUzOQ==,size_16,color_FFFFFF,t_70
[20191217102437888.png]: https://img-blog.csdnimg.cn/20191217102437888.png
[fs.copyFile_src_ dest_ flags_ callback]: http://nodejs.cn/api/fs.html#fs_fs_copyfile_src_dest_flags_callback
[20191217114555833.png]: https://img-blog.csdnimg.cn/20191217114555833.png
[fs.mkdir_path_ options_ callback]: http://nodejs.cn/api/fs.html#fs_fs_mkdir_path_options_callback
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ4NjUzOQ_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20191213193645911.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ4NjUzOQ==,size_16,color_FFFFFF,t_70
[fs.readdir_path_ options_ callback]: http://nodejs.cn/api/fs.html#fs_fs_readdir_path_options_callback
[20191217153154346.png]: https://img-blog.csdnimg.cn/20191217153154346.png