Node.js 文件系統

Node.js 提供一組類似UNIX（POSIX）標準的文件操作API。 Node 導入文件系統模塊(fs)語法如下所示：

var fs = require("fs")

異步和同步

Node.js 文件系統（fs 模塊）模塊中的方法均有異步和同步版本，例如讀取文件內容的函數有異步的fs.readFile() 和同步的fs.readFileSync()。

異步的方法函數最後一個參數為回調函數，回調函數的第一個參數包含了錯誤信息(error)。

建議大家是用異步方法，比起同步，異步方法性能更高，速度更快，而且沒有阻塞。

實例

創建input.txt 文件，內容如下：

本教程官网地址：www.w3big.com
文件读取实例

創建file.js 文件, 代碼如下：

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

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

以上代碼執行結果如下：

$ node file.js 
同步读取: 本教程官网地址：www.w3big.com
文件读取实例

程序执行完毕。
异步读取: 本教程官网地址：www.w3big.com
文件读取实例

接下來，讓我們來具體了解下Node.js 文件系統的方法。

打開文件

語法

以下為在異步模式下打開文件的語法格式：

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

參數

參數使用說明如下：

• path -文件的路徑。

• flags -文件打開的行為。具體值詳見下文。

• mode -設置文件模式(權限)，文件創建默認權限為0666(可讀，可寫)。

• callback -回調函數，帶有兩個參數如：callback(err, fd)。

flags 參數可以是以下值：

實例

接下來我們創建file.js 文件，並打開input.txt 文件進行讀寫，代碼如下所示：

var fs = require("fs");

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

以上代碼執行結果如下：

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

獲取文件信息

語法

以下為通過異步模式獲取文件信息的語法格式：

fs.stat(path, callback)

參數

參數使用說明如下：

• path -文件路徑。

• callback -回調函數，帶有兩個參數如：(err, stats), stats是fs.Stats對象。

fs.stat(path)執行後，會將stats類的實例返回給其回調函數。 可以通過stats類中的提供方法判斷文件的相關屬性。 例如判斷是否為文件：

var fs = require('fs');

fs.stat('/Users/liuht/code/itbilu/demo/fs.js', function (err, stats) {
    console.log(stats.isFile()); 		//true
})

stats類中的方法有：

實例

接下來我們創建file.js 文件，代碼如下所示：

var fs = require("fs");

console.log("准备打开文件！");
fs.stat('input.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 file.js 
准备打开文件！
{ dev: 16777220,
  mode: 33188,
  nlink: 1,
  uid: 501,
  gid: 20,
  rdev: 0,
  blksize: 4096,
  ino: 40333161,
  size: 61,
  blocks: 8,
  atime: Mon Sep 07 2015 17:43:55 GMT+0800 (CST),
  mtime: Mon Sep 07 2015 17:22:35 GMT+0800 (CST),
  ctime: Mon Sep 07 2015 17:22:35 GMT+0800 (CST) }
读取文件信息成功！
是否为文件(isFile) ? true
是否为目录(isDirectory) ? false

寫入文件

語法

以下為異步模式下寫入文件的語法格式：

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

如果文件存在，該方法寫入的內容會覆蓋舊的文件內容。

參數

參數使用說明如下：

• path -文件路徑。

• data -要寫入文件的數據，可以是String(字符串)或Buffer(流)對象。

• options -該參數是一個對象，包含{encoding, mode, flag}。默認編碼為utf8, 模式為0666 ， flag 為'w'

• callback -回調函數，回調函數只包含錯誤信息參數(err)，在寫入失敗時返回。

實例

接下來我們創建file.js 文件，代碼如下所示：

var fs = require("fs");

console.log("准备写入文件");
fs.writeFile('input.txt', '我是通过写入的文件内容！',  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());
   });
});

以上代碼執行結果如下：

$ node file.js 
准备写入文件
数据写入成功！
--------我是分割线-------------
读取写入的数据！
异步读取文件数据: 我是通过写入的文件内容

讀取文件

語法

以下為異步模式下讀取文件的語法格式：

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

該方法使用了文件描述符來讀取文件。

參數

參數使用說明如下：

• fd -通過fs.open()方法返回的文件描述符。

• buffer -數據寫入的緩衝區。

• offset -緩衝區寫入的寫入偏移量。

• length -要從文件中讀取的字節數。

• position -文件讀取的起始位置，如果position的值為null，則會從當前文件指針的位置讀取。

• callback -回調函數，有三個參數err, bytesRead, buffer，err為錯誤信息， bytesRead表示讀取的字節數，buffer為緩衝區對象。

實例

input.txt 文件內容為：

本教程官网地址：www.w3big.com

接下來我們創建file.js 文件，代碼如下所示：

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

以上代碼執行結果如下：

$ node file.js 
准备打开已存在的文件！
文件打开成功！
准备读取文件：
42  字节被读取
本教程官网地址：www.w3big.com

關閉文件

語法

以下為異步模式下關閉文件的語法格式：

fs.close(fd, callback)

該方法使用了文件描述符來讀取文件。

參數

參數使用說明如下：

• fd -通過fs.open()方法返回的文件描述符。

• callback -回調函數，沒有參數。

實例

input.txt 文件內容為：

本教程官网地址：www.w3big.com

接下來我們創建file.js 文件，代碼如下所示：

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("文件关闭成功");
      });
   });
});

以上代碼執行結果如下：

$ node file.js 
准备打开文件！
文件打开成功！
准备读取文件！
本教程官网地址：www.w3big.com
文件关闭成功

截取文件

語法

以下為異步模式下截取文件的語法格式：

fs.ftruncate(fd, len, callback)

該方法使用了文件描述符來讀取文件。

參數

參數使用說明如下：

• fd -通過fs.open()方法返回的文件描述符。

• len -文件內容截取的長度。

• callback -回調函數，沒有參數。

實例

input.txt 文件內容為：

site:www.w3big.com

接下來我們創建file.js 文件，代碼如下所示：

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("截取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 file.js 
准备打开文件！
文件打开成功！
截取10字节后的文件内容。
文件截取成功。
读取相同的文件
site:www.r
文件关闭成功

刪除文件

語法

以下為刪除文件的語法格式：

fs.unlink(path, callback)

參數

參數使用說明如下：

• path -文件路徑。

• callback -回調函數，沒有參數。

實例

input.txt 文件內容為：

site:www.w3big.com

接下來我們創建file.js 文件，代碼如下所示：

var fs = require("fs");

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

以上代碼執行結果如下：

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

再去查看input.txt 文件，發現已經不存在了。

創建目錄

語法

以下為創建目錄的語法格式：

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

參數

參數使用說明如下：

• path -文件路徑。

• mode -設置目錄權限，默認為0777。

• callback -回調函數，沒有參數。

實例

接下來我們創建file.js 文件，代碼如下所示：

var fs = require("fs");

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

以上代碼執行結果如下：

$ node file.js 
创建目录 /tmp/test/
目录创建成功。

讀取目錄

語法

以下為讀取目錄的語法格式：

fs.readdir(path, callback)

參數

參數使用說明如下：

• path -文件路徑。

• callback -回調函數，回調函數帶有兩個參數err, files，err為錯誤信息，files為目錄下的文件數組列表。

實例

接下來我們創建file.js 文件，代碼如下所示：

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)

參數

參數使用說明如下：

• path -文件路徑。

• callback -回調函數，沒有參數。

實例

接下來我們創建file.js 文件，代碼如下所示：

var fs = require("fs");

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

以上代碼執行結果如下：

$ node file.js 
准备删除目录 /tmp/test
input.out
output.out
test
test.txt
读取 /tmp 目录
……

文件模塊方法參考手冊

以下為Node.js 文件模塊相同的方法列表：

更多內容，請查看官網文件模塊描述： File System 。