本文已参与「新人创作礼」活动，一起开启掘金创作之路。

让前端觉得如获神器的不是NodeJS能做网络编程，而是NodeJS能够操作文件。小至文件查找，大至代码编译，几乎没有一个前端工具不操作文件。换个角度讲，几乎也只需要一些数据处理逻辑，再加上一些文件操作，就能够编写出大多数前端工具。本章将介绍与之相关的NodeJS内置模块。

fs模块

Node.js 提供一组类似 UNIX（POSIX）标准的文件操作API。 Node 导入文件系统模块(fs)语法如下所示：

 var fs = require("fs")

异步和同步

Node.js 文件系统（fs 模块）模块中的方法均有异步和同步版本，例如读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。

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

 var fs = require("fs");
 ​
 // 异步读取 不会阻塞程序执行 读取完毕执行回调函数
 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());

文件操作

打开文件

以下为在异步模式下打开文件的语法格式：

 fs.open(path, flags[, mode], callback)

flags - 文件打开的行为。具体值与C语言操作文件差不多，由r、w、a等配合组成。

Flag	描述
r	以读取模式打开文件。如果文件不存在抛出异常。
r+	以读写模式打开文件。如果文件不存在抛出异常。
rs	以同步的方式读取文件。
rs+	以同步的方式读取和写入文件。
w	以写入模式打开文件，如果文件不存在则创建。
wx	类似 'w'，但是如果文件路径存在，则文件写入失败。
w+	以读写模式打开文件，如果文件不存在则创建。
wx+	类似 'w+'， 但是如果文件路径存在，则文件读写失败。
a	以追加模式打开文件，如果文件不存在则创建。
ax	类似 'a'， 但是如果文件路径存在，则文件追加失败。
a+	以读取追加模式打开文件，如果文件不存在则创建。
ax+	类似 'a+'， 但是如果文件路径存在，则文件读取追加失败。

实例：

 var fs = require("fs");
 ​
 // 异步打开文件
 fs.open('input.txt', 'r+', function(err, fd) {
    if (err) {
        return console.error(err);
    }
   console.log("文件打开成功！");     
 });

获取文件信息

以下为通过异步模式获取文件信息的语法格式：

 fs.stat(path, callback)

实例：

 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。

写入文件

以下为异步模式下写入文件的语法格式：

 fs.writeFile(file, data[, options], callback)

writeFile 直接打开文件默认是 w 模式，所以如果文件存在，该方法写入的内容会覆盖旧的文件内容。

实例：

 var fs = require("fs");
 ​
 console.log("准备写入文件");
 fs.writeFile('input.txt', '我是通 过fs.writeFile 写入文件的内容',  function(err) {
    if (err) {
        return console.error(err);
    }
    console.log("数据写入成功！");
    console.log("--------我是分割线-------------")
    console.log("读取写入的数据！");
    fs.readFile('input.txt', function (err, data) {
       if (err) {
          return console.error(err);
       }
       console.log("异步读取文件数据: " + data.toString());
    });
 });

读取文件

以下为异步模式下读取文件的语法格式：

 fs.read(fd, buffer, offset, length, position, callback)

实例：

 var fs = require("fs");
 var buf = new Buffer.alloc(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());
       }
    });
 });

关闭文件

以下为异步模式下关闭文件的语法格式：

fs.close(fd, callback)

实例：

var fs = require("fs");
var buf = new Buffer.alloc(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("文件关闭成功");
      });
   });
});

截取文件

以下为异步模式下截取文件的语法格式：

fs.ftruncate(fd, len, callback)

实例：

var fs = require("fs");
var buf = new Buffer.alloc(1024);

console.log("准备打开文件！");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
   console.log("文件打开成功！");
   console.log("截取10字节内的文件内容，超出部分将被去除。");
   
   // 截取文件
   fs.ftruncate(fd, 10, function(err){
      if (err){
         console.log(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("文件关闭成功！");
         });
      });
   });
});

删除文件

以下为删除文件的语法格式：

fs.unlink(path, callback)

实例：

var fs = require("fs");

console.log("准备删除文件！");
fs.unlink('input.txt', function(err) {
   if (err) {
       return console.error(err);
   }
   console.log("文件删除成功！");
});

创建目录

以下为创建目录的语法格式：

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

实例：

var fs = require("fs");
// tmp 目录必须存在
console.log("创建目录 /tmp/test/");
fs.mkdir("/tmp/test/",function(err){
   if (err) {
       return console.error(err);
   }
   console.log("目录创建成功。");
});

读取目录

以下为读取目录的语法格式：

fs.readdir(path, callback)

实例：

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

结果：

$ node file.js 
查看 /tmp 目录
input.out
output.out
test
test.txt

删除目录

以下为删除目录的语法格式：

fs.rmdir(path, callback)

实例：

var fs = require("fs");
// 执行前创建一个空的 /tmp/test 目录
console.log("准备删除目录 /tmp/test");
fs.rmdir("/tmp/test",function(err){
   if (err) {
       return console.error(err);
   }
   console.log("读取 /tmp 目录");
   fs.readdir("/tmp/",function(err, files){
      if (err) {
          return console.error(err);
      }
      files.forEach( function (file){
          console.log( file );
      });
   });
});

对于上述方法的同步，几乎都是方法名加上Sync，例如：

fs.writeFileSync(filename, data[, options]): 同步版的 fs.writeFile。

同步方法没有回调函数作为参数，直接使用变量接收结果即可，因为同步方法会阻塞程序的运行。