Node.js檔系統

Node實現檔I/O使用標準的POSIX函數的簡單包裝。Node檔系統(FS)模組可以使用以下語法輸入：

var fs = require("fs")

同步和非同步

在fs模組的每一個方法都有同步和非同步形式。非同步方法需要最後一個參數為完成回調函數和回調函數的第一個參數是錯誤的。它優選使用非同步方法來代替同步方法，前者從來不阻止程式的執行，作為第二使用。

示例

創建一個名為input.txt的檔有以下內容的文本

zaixian Point is giving self learning content
to teach the world in simple and easy way!!!!!

讓我們創建一個名為具有以下代碼main.js一個js檔。

var fs = require("fs");

// Asynchronous read
fs.readFile('input.txt', function (err, data) {
   if (err) {
       return console.error(err);
   }
   console.log("Asynchronous read: " + data.toString());
});

// Synchronous read
var data = fs.readFileSync('input.txt');
console.log("Synchronous read: " + data.toString());

console.log("Program Ended");

現在運行main.js看到的結果：

$ node main.js

驗證輸出

Synchronous read: zaixian Point is giving self learning content
to teach the world in simple and easy way!!!!!

Program Ended
Asynchronous read: zaixian Point is giving self learning content
to teach the world in simple and easy way!!!!!

以下部分將提供有關主要檔I/ O方法很好的例子。

打開一個檔

語法

以下是在非同步模式下打開檔的方法的語法：

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

參數

下麵是使用的參數的說明：

• path - 這是檔案名，包括路徑字串。

• flags - 標誌告知要打開的檔的行為。所有可能的值已經提及以下。

• mode - 這將設置檔模式(許可和粘性位)，但前提是在創建該檔。它默認為0666，讀取和寫入。

• callback - 這是回調函數得到兩個參數(err, fd)。

Flags

標誌進行讀/寫操作是：

示例

讓我們創建一個名為main.js一個js檔具有下麵的代碼，用於打開一個檔input.txt的讀寫。

var fs = require("fs");

// Asynchronous - Opening File
console.log("Going to open file!");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
  console.log("File opened successfully!");
});

現在運行main.js看到的結果：

$ node main.js

驗證輸出

Going to open file!
File opened successfully!

獲取檔資訊

語法

下麵是獲取一個檔有關的資訊的方法的語法：

fs.stat(path, callback)

語法

下麵是使用的參數的說明：

• path - 這是有檔案名，包括路徑字串。

• callback - 這是回調函數得到兩個參數(err, stats) ，其中統計數據是這是印在下面的例子中的fs.Stats類型的對象。

除了這些在下面的例子中列印的重要屬性， 還有可以用於檢查檔類型的fs.Stats類可用的有用的方法。這些方法列於下表中。

示例

讓我們創建一個名為main.js的js檔具有下麵的代碼：

var fs = require("fs");

console.log("Going to get file info!");
fs.stat('input.txt', function (err, stats) {
   if (err) {
       return console.error(err);
   }
   console.log(stats);
   console.log("Got file info successfully!");

   // Check file type
   console.log("isFile ? " + stats.isFile());
   console.log("isDirectory ? " + stats.isDirectory());
});

現在運行main.js看到結果：

$ node main.js

驗證輸出

Going to get file info!
{ dev: 1792,
  mode: 33188,
  nlink: 1,
  uid: 48,
  gid: 48,
  rdev: 0,
  blksize: 4096,
  ino: 4318127,
  size: 97,
  blocks: 8,
  atime: Sun Mar 22 2015 13:40:00 GMT-0500 (CDT),
  mtime: Sun Mar 22 2015 13:40:57 GMT-0500 (CDT),
  ctime: Sun Mar 22 2015 13:40:57 GMT-0500 (CDT) }
Got file info successfully!
isFile ? true
isDirectory ? false

寫入檔

語法

下麵是寫入到一個檔中的方法之一的語法：

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

這種方法如果檔已經存在將會覆蓋檔。如果想寫入到現有的檔，那麼你應該使用其他的方法。

參數

下麵是使用的參數的說明：

• path - 這是有檔案名，包括路徑字串

• data - 這是字串或緩衝將被寫入到檔中

• options - 第三個參數是一個對象，它將於{編碼，模式，標誌}。默認編碼是UTF8，模式是八進制值0666和標誌 'w'

• callback - 這是回調函數獲取一個參數err，並用於在發生任何寫入錯誤返回錯誤。

示例

讓我們創建一個名為main.js的js檔具有下麵的代碼：

var fs = require("fs");

console.log("Going to write into existing file");
fs.writeFile('input.txt', 'Simply Easy Learning!',  function(err) {
   if (err) {
       return console.error(err);
   }
   console.log("Data written successfully!");
   console.log("Let's read newly written data");
   fs.readFile('input.txt', function (err, data) {
      if (err) {
         return console.error(err);
      }
      console.log("Asynchronous read: " + data.toString());
   });
});

現在運行main.js看到的結果：

$ node main.js

驗證輸出

Going to write into existing file
Data written successfully!
Let's read newly written data
Asynchronous read: Simply Easy Learning!

讀取檔

語法

以下是從檔讀取的方法之一的語法：

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

此方法將使用檔描述符來讀取檔，如果你想直接使用檔案名，那麼應該使用其他可用的方法來讀取檔。

參數

下麵是使用的參數的說明：

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

• buffer - 這是該數據將被寫入到緩衝器

• offset - 這是偏移量在緩衝器開始寫入處

• length - 這是一個整數，指定要讀取的位元組的數目

• position - 這是一個整數，指定從檔中開始讀取。如果位置為null，數據將從當前檔位置讀取。

• callback - 這是回調函數獲取三個參數，(err, bytesRead, buffer).

示例

讓我們創建一個名為main.js的js檔具有下麵的代碼：

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

console.log("Going to open an existing file");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
   console.log("File opened successfully!");
   console.log("Going to read the file");
   fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
      if (err){
         console.log(err);
      }
      console.log(bytes + " bytes read");

      // Print only read bytes to avoid junk.
      if(bytes > 0){
         console.log(buf.slice(0, bytes).toString());
      }
   });
});

現在運行main.js看到的結果：

$ node main.js

驗證輸出

Going to open an existing file
File opened successfully!
Going to read the file
97 bytes read
zaixian Point is giving self learning content
to teach the world in simple and easy way!!!!!

關閉檔

語法

以下是關閉一個打開的檔的方法之一的語法：

fs.close(fd, callback)

參數

下麵是使用的參數的說明：

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

• callback - 這是回調函數

示例

讓我們創建一個名為main.js的js檔具有下麵的代碼：

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

console.log("Going to open an existing file");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
   console.log("File opened successfully!");
   console.log("Going to read the file");
   fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
      if (err){
         console.log(err);
      }

      // Print only read bytes to avoid junk.
      if(bytes > 0){
         console.log(buf.slice(0, bytes).toString());
      }

      // Close the opened file.
      fs.close(fd, function(err){
         if (err){
            console.log(err);
         }
         console.log("File closed successfully.");
      });
   });
});

現在運行main.js看到的結果：

$ node main.js

驗證輸出

Going to open an existing file
File opened successfully!
Going to read the file
zaixian Point is giving self learning content
to teach the world in simple and easy way!!!!!

File closed successfully.

截斷檔

語法

下麵是要截斷的打開檔的方法的語法：

fs.ftruncate(fd, len, callback)

參數

下麵是使用的參數的說明：

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

• len - 這是後的檔將被截斷檔的長度。

• callback - 這是回調函數

示例

讓我們創建一個名為main.js的js檔具有下麵的代碼：

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

console.log("Going to open an existing file");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
   console.log("File opened successfully!");
   console.log("Going to truncate the file after 10 bytes");

   // Truncate the opened file.
   fs.ftruncate(fd, 10, function(err){
      if (err){
         console.log(err);
      }
      console.log("File truncated successfully.");
      console.log("Going to read the same file");
      fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
         if (err){
            console.log(err);
         }

         // Print only read bytes to avoid junk.
         if(bytes > 0){
            console.log(buf.slice(0, bytes).toString());
         }

         // Close the opened file.
         fs.close(fd, function(err){
            if (err){
               console.log(err);
            }
            console.log("File closed successfully.");
         });
      });
   });
});

現在運行main.js看到的結果：

$ node main.js

驗證輸出

Going to open an existing file
File opened successfully!
Going to truncate the file after 10 bytes
File truncated successfully.
Going to read the same file
zaixian
File closed successfully.

刪除檔

語法

以下是刪除檔的方法的語法：

fs.unlink(path, callback)

參數

下麵是使用的參數的說明：

• path - 這是檔案名，包括路徑

• callback - 這是回調函數

示例

讓我們創建一個名為main.js的js檔具有下麵的代碼：

var fs = require("fs");

console.log("Going to delete an existing file");
fs.unlink('input.txt', function(err) {
   if (err) {
       return console.error(err);
   }
   console.log("File deleted successfully!");
});

現在運行main.js看到的結果：

$ node main.js

驗證輸出

Going to delete an existing file
File deleted successfully!

創建目錄

語法

下麵是創建一個目錄的方法的語法：

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

參數

下麵是使用的參數的說明：

• path - 這是包括路徑的目錄名。

• mode - 這是要設置的目錄許可權。默認為0777。

• callback - 這是回調函數

示例

讓我們創建一個名為main.js的js檔具有下麵的代碼：

var fs = require("fs");

console.log("Going to create directory /tmp/test");
fs.mkdir('/tmp/test',function(err){
   if (err) {
       return console.error(err);
   }
   console.log("Directory created successfully!");
});

現在運行main.js看到的結果：

$ node main.js

驗證輸出

Going to create directory /tmp/test
Directory created successfully!

讀取目錄

語法

下麵是讀取一個目錄的方法的語法：

fs.readdir(path, callback)

參數

下麵是使用的參數的說明：

• path - 這是包括路徑的目錄名。

• callback - 這是回調函數得到兩個參數（err, files），其中檔的檔案名的目錄中的數組排除 '.' 和  '..'.

示例

讓我們創建一個名為main.js的js檔具有下麵的代碼：

var fs = require("fs");

console.log("Going to read directory /tmp");
fs.readdir("/tmp/",function(err, files){
   if (err) {
       return console.error(err);
   }
   files.forEach( function (file){
       console.log( file );
   });
});

現在運行main.js看到的結果：

$ node main.js

驗證輸出

Going to read directory /tmp
ccmzx99o.out
ccyCSbkF.out
employee.ser
hsperfdata_apache
test
test.txt

刪除目錄

語法

下麵是該方法刪除目錄的語法：

fs.rmdir(path, callback)

參數

下麵是使用的參數的說明：

• path - 這是包括路徑的目錄名。

• callback - 這是回調函數

示例

讓我們創建一個名為main.js的js檔具有下麵的代碼：

var fs = require("fs");

console.log("Going to delete directory /tmp/test");
fs.rmdir("/tmp/test",function(err){
   if (err) {
       return console.error(err);
   }
   console.log("Going to read directory /tmp");
   fs.readdir("/tmp/",function(err, files){
      if (err) {
          return console.error(err);
      }
      files.forEach( function (file){
          console.log( file );
      });
   });
});

現在運行main.js看到的結果：

$ node main.js

驗證輸出

Going to read directory /tmp
ccmzx99o.out
ccyCSbkF.out
employee.ser
hsperfdata_apache
test.txt