【nodeJs】fs文件模块

野性酷女 2022-05-24 13:23 272阅读 0赞

#### Node.js 文件系统（fs 模块）中的方法均有异步和同步版本,建议使用异步方法，比起同步，异步方法性能更高，速度更快，而且没有阻塞。 ####

本文只列举了一些常见的文件操作,更多请看官网：[https://nodejs.org/api/fs.html\#fs\_fs\_rename\_oldpath\_newpath\_callback][https_nodejs.org_api_fs.html_fs_fs_rename_oldpath_newpath_callback]  
1 . 导入文件系统模块(fs)

var fs = require("fs")

2 . 读取文件

// 异步读取
    fs.readFile('input.txt', function (err, data) {
       if (err) {
           return console.error(err);
       }
       console.log("异步读取: " + data.toString());
    });
    
    // 同步读取
    var data = fs.readFileSync('input.txt');
    console.log("同步读取: " + data.toString());
    
    console.log("程序执行完毕。");
    
    执行结果如下：
    同步读取: XXX
    程序执行完毕。
    异步读取:XXX

3 . 打开文件（异步）

fs.open(path, flags[, mode], callback)
    
    
    path - 文件的路径。
    
    flags - 文件打开的行为。具体值详见下文。
    
    mode - 设置文件模式(权限)，文件创建默认权限为 0666(可读，可写)。
    
    callback - 回调函数，带有两个参数如：callback(err, fd)。
    
    flags参数可以是以下值：
    
    r   以读取模式打开文件。如果文件不存在抛出异常。
    r+  以读写模式打开文件。如果文件不存在抛出异常。
    rs  以同步的方式读取文件。
    rs+ 以同步的方式读取和写入文件。
    w   以写入模式打开文件，如果文件不存在则创建。
    wx  类似 'w'，但是如果文件路径存在，则文件写入失败。
    w+  以读写模式打开文件，如果文件不存在则创建。
    wx+ 类似 'w+'， 但是如果文件路径存在，则文件读写失败。
    a   以追加模式打开文件，如果文件不存在则创建。
    ax  类似 'a'， 但是如果文件路径存在，则文件追加失败。
    a+  以读取追加模式打开文件，如果文件不存在则创建。
    ax+ 类似 'a+'， 但是如果文件路径存在，则文件读取追加失败。
    eg：
    
    var fs = require("fs");
    
    // 异步打开文件
    console.log("准备打开文件！");
    fs.open('input.txt', 'r+', function(err, fd) { 
       if (err) {
           return console.error(err);
       }
      console.log("文件打开成功！");     
    });

4 . 获取文件信息（异步）

fs.stat(path, callback)
    fs.stat(path)执行后，会将stats类的实例返回给其回调函数。可以通过stats类中的提供方法判断文件的相关属性。例如判断是否为文件：
    
    eg:
    var fs = require('fs');
    
    fs.stat('/Users/liuht/code/itbilu/demo/fs.js', function (err, stats) { 
        console.log(stats.isFile());         //true
    })
    
    stats类中的方法有：
    
    stats.isFile()  如果是文件返回 true，否则返回 false。
    stats.isDirectory() 如果是目录返回 true，否则返回 false。
    stats.isBlockDevice()   如果是块设备返回 true，否则返回 false。
    stats.isCharacterDevice()   如果是字符设备返回 true，否则返回 false。
    stats.isSymbolicLink()  如果是软链接返回 true，否则返回 false。
    stats.isFIFO()  如果是FIFO，返回true，否则返回 false。FIFO是UNIX中的一种特殊类型的命令管道。
    stats.isSocket()    如果是 Socket 返回 true，否则返回 false。

5 . 写入文件（异步）

fs.writeFile(file, data[, options], callback)
    
    
    file - 文件名或文件描述符。
    
    data - 要写入文件的数据，可以是 String(字符串) 或 Buffer(流) 对象。
    
    options - 该参数是一个对象，包含 {encoding, mode, flag}。默认编码为 utf8, 模式为 0666 ， flag 为 'w'
    
    callback - 回调函数，回调函数只包含错误信息参数(err)，在写入失败时返回。
    
    
    eg:
    var fs = require("fs");
    
    fs.writeFile('input.txt', '我是通 过fs.writeFile 写入文件的内容',  function(err) { 
       if (err) {
           return console.error(err);
       }
       console.log("数据写入成功！");
    
       console.log("读取写入的数据！");
       fs.readFile('input.txt', function (err, data) { 
          if (err) {
             return console.error(err);
          }
          console.log("异步读取文件数据: " + data.toString());
       });
    });
    
    执行结果：
    数据写入成功！
    读取写入的数据！
    异步读取文件数据: 我是通 过fs.writeFile

6 . 读取文件(异步)

fs.read(fd, buffer, offset, length, position, callback)
    
    
    fd - 通过 fs.open() 方法返回的文件描述符。
    
    buffer - 数据写入的缓冲区。
    
    offset - 缓冲区写入的写入偏移量。
    
    length - 要从文件中读取的字节数。
    
    position - 文件读取的起始位置，如果 position 的值为 null，则会从当前文件指针的位置读取。
    
    callback - 回调函数，有三个参数err, bytesRead, buffer，err 为错误信息， bytesRead 表示读取的字节数，buffer 为缓冲区对象。
    
    eg：
    var fs = require("fs");
    var buf = new Buffer(1024);
    
    console.log("准备打开已存在的文件！");
    fs.open('input.txt', 'r+', function(err, fd) {
       if (err) {
           return console.error(err);
       }
       console.log("文件打开成功！");
       console.log("准备读取文件：");
       fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
          if (err){
             console.log(err);
          }
          console.log(bytes + " 字节被读取");
    
          // 仅输出读取的字节
          if(bytes > 0){
             console.log(buf.slice(0, bytes).toString());
          }
       });
    });

7 . 关闭文件

fs.close(fd, callback)
    
    eg:
    var fs = require("fs");
    var buf = new Buffer(1024);
    
    console.log("准备打开文件！");
    fs.open('input.txt', 'r+', function(err, fd) {
       if (err) {
           return console.error(err);
       }
       console.log("文件打开成功！");
       console.log("准备读取文件！");
       fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
          if (err){
             console.log(err);
          }
    
          // 仅输出读取的字节
          if(bytes > 0){
             console.log(buf.slice(0, bytes).toString());
          }
    
          // 关闭文件
          fs.close(fd, function(err){
             if (err){
                console.log(err);
             } 
             console.log("文件关闭成功");
          });
       });
    });

8 . 创建目录

fs.mkdir(path[, mode], callback)
    path - 文件路径。
    
    mode - 设置目录权限，默认为 0777。
    
    callback - 回调函数，只有一个err参数
    
    eg：
    var fs = require("fs");
    
    console.log("创建目录 /tmp/test/");
    fs.mkdir("/tmp/test/",function(err){
       if (err) {
           return console.error(err);
       }
       console.log("目录创建成功。");
    });

9 .读取目录

fs.readdir(path, callback)
    
    
    path - 文件路径。
    
    callback - 回调函数，回调函数带有两个参数err, files，err 为错误信息，files 为 目录下的文件数组列表。
    
    eg:
    var fs = require("fs");
    
    console.log("查看 /tmp 目录");
    fs.readdir("/tmp/",function(err, files){ 
       if (err) {
           return console.error(err);
       }
       files.forEach( function (file){ 
           console.log( file );
       });
    });

[https_nodejs.org_api_fs.html_fs_fs_rename_oldpath_newpath_callback]: https://nodejs.org/api/fs.html#fs_fs_rename_oldpath_newpath_callback