17、Node.js 文件系统( fs 模块 )

Node.js fs 模块提供了一组类似 UNIX（POSIX）标准的文件操作 API

引入模块

var fs = require("fs")

异步和同步

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

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

建议使用异步方法，比起同步，异步方法性能更高，速度更快，而且没有阻塞

范例

我们先创建一个 demo.txt 内容如下

demo.txt

DDKK.COM 弟弟快看，程序员编程资料站，教程 
DDKK.COM 弟弟快看，程序员编程资料站官网地址为：ddkk.com

然后我们写一个脚本比较同步读取和异步读取的不同之处

main.js

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

var fs = require("fs");

// 异步读取
fs.readFile('demo.txt', function (err, data) {
   if (err) {
       return console.error(err);
   }
   console.log("异步读取: " + data.toString());
});

// 同步读取
var data = fs.readFileSync('demo.txt');
console.log("同步读取: " + data.toString());

console.log("程序执行完毕!");

运行以上 Node.js 脚本，输出结果如下

$ node main.js
同步读取: DDKK.COM 弟弟快看，程序员编程资料站，教程 
DDKK.COM 弟弟快看，程序员编程资料站官网地址为：ddkk.com

程序执行完毕!
异步读取: DDKK.COM 弟弟快看，程序员编程资料站，教程 
DDKK.COM 弟弟快看，程序员编程资料站官网地址为：ddkk.com

接下来我们详细了解下 Node.js fs 模块提供的方法

打开文件

Node.js fs.open() 可以打开或新建一个文件

语法

Node.js fs.open() 异步方式打开文件的语法如下

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

参数列表

flags 参数可以是以下值

范例

先使用以下命令删除刚刚创建的 demo.txt

$ rm demo.txt

然后我们写一个脚本，使用 fs.open 函数创建 demo.txt

main.js

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

var fs = require("fs");

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

运行以上 Node.js 脚本，输出结果如下

$ node main.js
准备打开文件！
文件打开成功

使用ls -lh demo.txt 命令，可以看到我们刚刚创建的文件

$ ls -lh demo.txt 
-rw-r--r-- 1 penglei staff 70 10 25 14:43 demo.txt

获取文件信息

Node.js fs.stat() 方法可以获取文件的信息，比如创建时间，大小等

语法

Node.js fs.stat 方法移步模式获取文件信息语法如下

fs.stat(path, callback)

fs.stat(path) 执行后，会将 stats 类的实例返回给其回调函数

参数列表

范例

我们继续使用 fs.open 创建的 demo.txt 文件，这次使用 fs.stat 方法来查看 demo.txt 的文件信息

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

var fs = require("fs");

console.log("准备打开文件！");
fs.stat('demo.txt', function (err, stats) {
   if (err) {
       return console.error(err);
   }
   console.log(stats);
   console.log("读取文件信息成功！");

   // 检测文件类型
   console.log("是否为文件(isFile) ? " + stats.isFile());
   console.log("是否为目录(isDirectory) ? " + stats.isDirectory());    
});

运行以上 Node.js 脚本，输出结果如下

$ node main.js   
准备打开文件！
Stats {
  dev: 16777220,
  mode: 33188,
  nlink: 1,
  uid: 501,
  gid: 20,
  rdev: 0,
  blksize: 4194304,
  ino: 8591512230,
  size: 70,
  blocks: 8,
  atimeMs: 1508914411388.6626,
  mtimeMs: 1508913809135.047,
  ctimeMs: 1508913809135.047,
  birthtimeMs: 1508913809134.8372,
  atime: 2017-10-25T06:53:31.389Z,
  mtime: 2017-10-25T06:43:29.135Z,
  ctime: 2017-10-25T06:43:29.135Z,
  birthtime: 2017-10-25T06:43:29.135Z }
读取文件信息成功！
是否为文件(isFile) ? true
是否为目录(isDirectory) ? false

stats 类

stats 类中的提供方法可以判断文件的相关属性，例如判断是否为文件

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

var fs = require('fs');

fs.stat('demo.txt', function (err, stats) {
    console.log(stats.isFile());         //true
})

运行以上 Node.js 范例，输出结果如下

$ node main.js
true

stats 类提供的方法有

写入文件

Node.js fs.writeFile() 方法可以向一个文件写入内容

语法

Node.js fs.writeFile 方法异步模式下写入文件的语法如下

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

如果文件已经存在，该方法写入的内容会覆盖旧的文件内容

参数列表

范例

我们使用 fs.writeFile 向 demo.txt 写入内容，然后再将其读出来

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

var fs = require("fs");

console.log("准备写入文件");
fs.writeFile('demo.txt', "DDKK.COM 弟弟快看，程序员编程资料站，教程 \nDDKK.COM 弟弟快看，程序员编程资料站官网: https://ddkk.com",  function(err) {
   if (err) {
       return console.error(err);
   }
   console.log("数据写入成功！");
   console.log("--------我是分割线-------------")
   console.log("读取写入的数据！");
   fs.readFile('demo.txt', function (err, data) {
      if (err) {
         return console.error(err);
      }
      console.log("异步读取文件数据: " + data.toString());
   });
});

运行以上 Node.js 脚本，输出结果如下

$ node main.js   
准备写入文件
数据写入成功！
--------我是分割线-------------
读取写入的数据！
异步读取文件数据: DDKK.COM 弟弟快看，程序员编程资料站，教程 
DDKK.COM 弟弟快看，程序员编程资料站官网: https://ddkk.com

读取文件

Node.js fs.read() 方法可以从一个打开的文件描述符中读取内容

语法

Node.js fs.read 方法异步模式下读取文件的语法如下

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

参数列表

范例

我们先用 cat 命令看一下 demo.txt 文件中的内容

$ cat demo.txt 
DDKK.COM 弟弟快看，程序员编程资料站，教程 
DDKK.COM 弟弟快看，程序员编程资料站官网: https://ddkk.com

接下来我们使用 fs.open 方法打开文件，然后使用 fs.read 方法读取其内容

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

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

console.log("准备打开已存在的文件！");
fs.open('demo.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());
      }
   });
});

运行以上 Node.js 脚本，输出结果如下

$ node main.js
准备打开已存在的文件！
文件打开成功！
准备读取文件：
67  字节被读取
DDKK.COM 弟弟快看，程序员编程资料站，教程 
DDKK.COM 弟弟快看，程序员编程资料站官网: https://ddkk.com

关闭文件

Node.js fs.close 方法可以关闭使用 fs.open 打开的文件

语法

Node.js fs.close 方法异步模式下关闭文件的语法如下

fs.close(fd, callback)

该方法使用了文件描述符关闭文件文件

参数列表

范例

我们先用 cat 命令看一下 demo.txt 文件中的内容

$ cat demo.txt 
DDKK.COM 弟弟快看，程序员编程资料站，教程 
DDKK.COM 弟弟快看，程序员编程资料站官网: https://ddkk.com

然后使用 fs.open 打开文件，使用 fs.read 读取内容，最后使用 fs.close 关闭打开的文件

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

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

console.log("准备打开文件！");
fs.open('demo.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("文件关闭成功");
      });
   });
});

运行以上 Node.js 脚本，输出结果如下

$ node main.js 
准备打开文件！
文件打开成功！
准备读取文件！
DDKK.COM 弟弟快看，程序员编程资料站，教程 
DDKK.COM 弟弟快看，程序员编程资料站官网: https://ddkk.com
文件关闭成功

截断文件

Node.js fs.ftruncate() 方法可以截断使用 fs.open 打开的文件

语法

Node.js fs.ftruncate() 方法异步模式下截取文件的语法如下

fs.ftruncate(fd, len, callback)

该方法使用了文件描述符来截断文件

参数列表

实例

我们先用 cat 命令看一下 demo.txt 文件中的内容

$ cat demo.txt 
DDKK.COM 弟弟快看，程序员编程资料站，教程 
DDKK.COM 弟弟快看，程序员编程资料站官网: https://ddkk.com

然后我们使用 fs.ftruncate 文件截断 demo.txt 10个字节后的内容

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

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

console.log("准备打开文件！");
fs.open('demo.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("文件关闭成功！");
         });
      });
   });
});

以上代码执行结果如下：

$ node main.js
准备打开文件！
文件打开成功！
截取10字节后的文件内容。
文件截取成功。
读取相同的文件
简单教�
文件关闭成功！

我们看到截取出现了乱码，是因为截取使用字节来统计，一个中文是三个字节

然后使用 cat 命令查看 demo.txt 内容如下

$ cat demo.txt 
简单教?% 

删除文件

Node.js fs.unlink() 方法可以删除一个文件

语法

Node.js fs.unLink方法异步模式删除文件语法如下

fs.unlink(path, callback)

参数列表

范例

假设当前目录下存在 demo.txt 文件，使用 ls -lh demo.txt 命令显示如下

$ ls -lh demo.txt 
-rw-r--r-- 1 penglei staff 10 10 25 15:25 demo.txt

接下来我们使用 fs.unLink删除 demo.txt

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

var fs = require("fs");

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

运行以上 Node.js 脚本，输出结果如下

$ node main.js   
准备删除文件！
文件删除成功

使用ls -lh demo.txt 命令发现文件已经被删除了

$ ls -lh demo.txt
gls: cannot access 'demo.txt': No such file or directory

创建目录

Node.js fs.mkdir() 方法可以创建目录

语法

Node.js fs.mkdir 方法异步模式创建目录语法如下

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

参数列表

范例

我们使用 fs.mkdir() 方法在当前目录下创建目录 demo_fs_mkdir

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

var fs = require("fs");

console.log("创建目录 ./demo_fs_mkdir");
fs.mkdir("./demo_fs_mkdir",function(err){
   if (err) {
       return console.error(err);
   }
   console.log("目录创建成功。");
});

运行以上 Node.js 脚本，输出结果如下

$ node main.js   
创建目录 ./demo_fs_mkdir
目录创建成功。

使用ls -lh demo_fs_mkdir 命令显示结果如下

$ ls -lh demo_fs_mkdir
total 0

读取目录

Node.js fs.readdir() 方法可以读取目录

语法

Node.js fs.readdir 异步读取目录语法如下

fs.readdir(path, callback)

参数列表

范例

我们使用 fs.readdir 方法读取 /tmp 目录

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

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.js 脚本，输出结果如下

$ node main.js        
查看 /tmp 目录
.adobeLockFile
.keystone_install_lock
0162D6A1-5043-4F41-9668-BFB97FC03E65_IN
0162D6A1-5043-4F41-9668-BFB97FC03E65_OUT
F7C71944B49B446081C0603DE90E4855_IN
F7C71944B49B446081C0603DE90E4855_OUT
adobegc.log
com.adobe.AdobeIPCBroker.ctrl-luojianguo
com.apple.launchd.4RKRpFihtd
com.apple.launchd.jWXPKDhtci
lilo.70012
mongodb-27017.sock
mysql.sock
powerlog
zxpsignMfJEiIgnH9vRzzC0
zxpsignXH6f4knomrLBbcno
zxpsignmKRyJ0GQ5ihCZGgU
zxpsignnidXdFMd3VQOHKH7

删除目录

Node.js fs.rmdir 方法可以删除一个空目录

语法

Node.js fs.rmdir 方法异步模式删除目录的语法格式

fs.rmdir(path, callback)

参数列表

范例

我们使用 fs.rmdir 方法删除前面使用 fs.mkdir 方法创建的目录

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

var fs = require("fs");

console.log("准备删除目录 ./demo_fs_mkdir");
fs.rmdir("./demo_fs_mkdir",function(err){
   if (err) {
       return console.error(err);
   }
   console.log("读取 ./demo_fs_mkdir 目录");
   fs.readdir("./demo_fs_mkdir",function(err, files){
      if (err) {
          return console.error(err);
      }
      files.forEach( function (file){
          console.log( file );
      });
   });
});

运行以上 Node.js 脚本，输出结果如下

$ node main.js       
准备删除目录 ./demo_fs_mkdir
读取 ./demo_fs_mkdir 目录
{ Error: ENOENT: no such file or directory, scandir './demo_fs_mkdir'
  errno: -2,
  code: 'ENOENT',
  syscall: 'scandir',
  path: './demo_fs_mkdir' }

fs 模块方法参考手册

下表列出了 fs 模块提供的方法

更多内容，请查看官网文件模块描述： File System