Node.js 檔案系統

Node.js 檔案系統

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

var fs = require("fs")

非同步和同步

Node.js 檔案系統（fs 模組）模組中的方法均有非同步和同步版本，例如讀取檔案內容的函式有非同步的 fs.readFile() 和同步的 fs.readFileSync()。

非同步的方法函式最後一個引數為回撥函式，回撥函式的第一個引數包含了錯誤資訊(error)。

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

例項

建立 input.txt 檔案，內容如下：

入門教學官網地址：www.itread01.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 = https://www.itread01.com/nodejs/fs.readFileSync('input.txt');
console.log("同步讀取: " + data.toString());

console.log("程式執行完畢。");

以上程式碼執行結果如下：

$ node file.js 
同步讀取: 入門教學官網地址：www.itread01.com
檔案讀取例項

程式執行完畢。
非同步讀取: 入門教學官網地址：www.itread01.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(file, data[, options], callback)

writeFile 直接開啟檔案預設是 w 模式，所以如果檔案存在，該方法寫入的內容會覆蓋舊的檔案內容。

引數

引數使用說明如下：

• file - 檔名或檔案描述符。

• 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', '我是通 過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());
   });
});

以上程式碼執行結果如下：

$ node file.js 
準備寫入檔案
資料寫入成功！
--------我是分割線-------------
讀取寫入的資料！
非同步讀取檔案資料: 我是通 過fs.writeFile 寫入檔案的內容

讀取檔案

語法

以下為非同步模式下讀取檔案的語法格式：

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.itread01.com

接下來我們建立 file.js 檔案，程式碼如下所示：

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

以上程式碼執行結果如下：

$ node file.js 
準備開啟已存在的檔案！
檔案開啟成功！
準備讀取檔案：
42  位元組被讀取
入門教學官網地址：www.itread01.com

關閉檔案

語法

以下為非同步模式下關閉檔案的語法格式：

fs.close(fd, callback)

該方法使用了檔案描述符來讀取檔案。

引數

引數使用說明如下：

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

• callback - 回撥函式，沒有引數。

例項

input.txt 檔案內容為：

入門教學官網地址：www.itread01.com

接下來我們建立 file.js 檔案，程式碼如下所示：

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("檔案關閉成功");
      });
   });
});

以上程式碼執行結果如下：

$ node file.js 
準備開啟檔案！
檔案開啟成功！
準備讀取檔案！
入門教學官網地址：www.itread01.com
檔案關閉成功

擷取檔案

語法

以下為非同步模式下擷取檔案的語法格式：

fs.ftruncate(fd, len, callback)

該方法使用了檔案描述符來讀取檔案。

引數

引數使用說明如下：

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

• len - 檔案內容擷取的長度。

• callback - 回撥函式，沒有引數。

例項

input.txt 檔案內容為：

site:www.itread01.com

接下來我們建立 file.js 檔案，程式碼如下所示：

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("檔案關閉成功！");
         });
      });
   });
});

以上程式碼執行結果如下：

$ node file.js 
準備開啟檔案！
檔案開啟成功！
擷取10位元組內的檔案內容，超出部分將被去除。
檔案擷取成功。
讀取相同的檔案
site:www.r
檔案關閉成功

刪除檔案

語法

以下為刪除檔案的語法格式：

fs.unlink(path, callback)

引數

引數使用說明如下：

• path - 檔案路徑。

• callback - 回撥函式，沒有引數。

例項

input.txt 檔案內容為：

site:www.itread01.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[, options], callback)

引數

引數使用說明如下：

• path - 檔案路徑。

• options 引數可以是：

  • recursive - 是否以遞迴的方式建立目錄，預設為 false。
  • mode - 設定目錄許可權，預設為 0777。

• callback - 回撥函式，沒有引數。

例項

接下來我們建立 file.js 檔案，程式碼如下所示：

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

以上程式碼執行結果如下：

$ node file.js 
建立目錄 /tmp/test/
目錄建立成功。

可以新增 recursive: true 引數，不管建立的目錄 /tmp 和 /tmp/a 是否存在：

fs.mkdir('/tmp/a/apple', { recursive: true }, (err) => {
  if (err) throw err;
});

讀取目錄

語法

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

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");
// 執行前建立一個空的 /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 );
      });
   });
});

以上程式碼執行結果如下：

$ node file.js 
準備刪除目錄 /tmp/test
讀取 /tmp 目錄
……

檔案模組方法參考手冊

以下為 Node.js 檔案模組相同的方法列表：

更多內容，請檢視官網檔案模組描述：File System。