Node.js 文件係統

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

var fs = require("fs")

異步和同步

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

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

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

實例

創建 input.txt 文件,內容如下:

菜鳥教程官網地址:rb.wikimirror.xyz
文件讀取實例

創建 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 
同步讀取: 菜鳥教程官網地址:rb.wikimirror.xyz
文件讀取實例

程序執行完畢。
異步讀取: 菜鳥教程官網地址:rb.wikimirror.xyz
文件讀取實例

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


打開文件

語法

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

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

參數

參數使用說明如下:

  • path - 文件的路徑。

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

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

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

flags 參數可以是以下值:

Flag描述
r以讀取模式打開文件。如果文件不存在拋出異常。
r+ 以讀寫模式打開文件。如果文件不存在拋出異常。
rs以同步的方式讀取文件。
rs+以同步的方式讀取和寫入文件。
w以寫入模式打開文件,如果文件不存在則創建。
wx類似 'w',但是如果文件路徑存在,則文件寫入失敗。
w+以讀寫模式打開文件,如果文件不存在則創建。
wx+類似 'w+', 但是如果文件路徑存在,則文件讀寫失敗。
a以追加模式打開文件,如果文件不存在則創建。
ax類似 'a', 但是如果文件路徑存在,則文件追加失敗。
a+以讀取追加模式打開文件,如果文件不存在則創建。
ax+類似 'a+', 但是如果文件路徑存在,則文件讀取追加失敗。

實例

接下來我們創建 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類中的方法有:

方法描述
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。

實例

接下來我們創建 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 文件內容為:

菜鳥教程官網地址:rb.wikimirror.xyz

接下來我們創建 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  字節被讀取
菜鳥教程官網地址:rb.wikimirror.xyz

關閉文件

語法

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

fs.close(fd, callback)

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

參數

參數使用說明如下:

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

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

實例

input.txt 文件內容為:

菜鳥教程官網地址:rb.wikimirror.xyz

接下來我們創建 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 
準備打開文件!
文件打開成功!
準備讀取文件!
菜鳥教程官網地址:rb.wikimirror.xyz
文件關閉成功

截取文件

語法

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

fs.ftruncate(fd, len, callback)

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

參數

參數使用說明如下:

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

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

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

實例

input.txt 文件內容為:

site:rb.wikimirror.xyz

接下來我們創建 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:rb.wikimirror.xyz

接下來我們創建 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 文件模塊相同的方法列表:

序號方法 & 描述
1fs.rename(oldPath, newPath, callback)
異步 rename().回調函數沒有參數,但可能拋出異常。
2fs.ftruncate(fd, len, callback)
異步 ftruncate().回調函數沒有參數,但可能拋出異常。
3fs.ftruncateSync(fd, len)
同步 ftruncate()
4fs.truncate(path, len, callback)
異步 truncate().回調函數沒有參數,但可能拋出異常。
5fs.truncateSync(path, len)
同步 truncate()
6fs.chown(path, uid, gid, callback)
異步 chown().回調函數沒有參數,但可能拋出異常。
7fs.chownSync(path, uid, gid)
同步 chown()
8fs.fchown(fd, uid, gid, callback)
異步 fchown().回調函數沒有參數,但可能拋出異常。
9fs.fchownSync(fd, uid, gid)
同步 fchown()
10fs.lchown(path, uid, gid, callback)
異步 lchown().回調函數沒有參數,但可能拋出異常。
11fs.lchownSync(path, uid, gid)
同步 lchown()
12fs.chmod(path, mode, callback)
異步 chmod().回調函數沒有參數,但可能拋出異常。
13fs.chmodSync(path, mode)
同步 chmod().
14fs.fchmod(fd, mode, callback)
異步 fchmod().回調函數沒有參數,但可能拋出異常。
15fs.fchmodSync(fd, mode)
同步 fchmod().
16fs.lchmod(path, mode, callback)
異步 lchmod().回調函數沒有參數,但可能拋出異常。Only available on Mac OS X.
17fs.lchmodSync(path, mode)
同步 lchmod().
18fs.stat(path, callback)
異步 stat(). 回調函數有兩個參數 err, stats,stats 是 fs.Stats 對象。
19fs.lstat(path, callback)
異步 lstat(). 回調函數有兩個參數 err, stats,stats 是 fs.Stats 對象。
20fs.fstat(fd, callback)
異步 fstat(). 回調函數有兩個參數 err, stats,stats 是 fs.Stats 對象。
21fs.statSync(path)
同步 stat(). 返回 fs.Stats 的實例。
22fs.lstatSync(path)
同步 lstat(). 返回 fs.Stats 的實例。
23fs.fstatSync(fd)
同步 fstat(). 返回 fs.Stats 的實例。
24fs.link(srcpath, dstpath, callback)
異步 link().回調函數沒有參數,但可能拋出異常。
25fs.linkSync(srcpath, dstpath)
同步 link().
26fs.symlink(srcpath, dstpath[, type], callback)
異步 symlink().回調函數沒有參數,但可能拋出異常。 type 參數可以設置為 'dir', 'file', 或 'junction' (默認為 'file') 。
27fs.symlinkSync(srcpath, dstpath[, type])
同步 symlink().
28fs.readlink(path, callback)
異步 readlink(). 回調函數有兩個參數 err, linkString。
29fs.realpath(path[, cache], callback)
異步 realpath(). 回調函數有兩個參數 err, resolvedPath。
30fs.realpathSync(path[, cache])
同步 realpath()。返回絕對路徑。
31fs.unlink(path, callback)
異步 unlink().回調函數沒有參數,但可能拋出異常。
32fs.unlinkSync(path)
同步 unlink().
33fs.rmdir(path, callback)
異步 rmdir().回調函數沒有參數,但可能拋出異常。
34fs.rmdirSync(path)
同步 rmdir().
35fs.mkdir(path[, mode], callback)
S異步 mkdir(2).回調函數沒有參數,但可能拋出異常。 訪問權限默認為 0777。
36fs.mkdirSync(path[, mode])
同步 mkdir().
37fs.readdir(path, callback)
異步 readdir(3). 讀取目錄的內容。
38fs.readdirSync(path)
同步 readdir().返回文件數組列表。
39fs.close(fd, callback)
異步 close().回調函數沒有參數,但可能拋出異常。
40fs.closeSync(fd)
同步 close().
41fs.open(path, flags[, mode], callback)
異步打開文件。
42fs.openSync(path, flags[, mode])
同步 version of fs.open().
43fs.utimes(path, atime, mtime, callback)
 
44fs.utimesSync(path, atime, mtime)
修改文件時間戳,文件通過指定的文件路徑。
45fs.futimes(fd, atime, mtime, callback)
 
46fs.futimesSync(fd, atime, mtime)
修改文件時間戳,通過文件描述符指定。
47fs.fsync(fd, callback)
異步 fsync.回調函數沒有參數,但可能拋出異常。
48fs.fsyncSync(fd)
同步 fsync.
49fs.write(fd, buffer, offset, length[, position], callback)
將緩衝區內容寫入到通過文件描述符指定的文件。
50fs.write(fd, data[, position[, encoding]], callback)
通過文件描述符 fd 寫入文件內容。
51fs.writeSync(fd, buffer, offset, length[, position])
同步版的 fs.write()。
52fs.writeSync(fd, data[, position[, encoding]])
同步版的 fs.write().
53fs.read(fd, buffer, offset, length, position, callback)
通過文件描述符 fd 讀取文件內容。
54fs.readSync(fd, buffer, offset, length, position)
同步版的 fs.read.
55fs.readFile(filename[, options], callback)
異步讀取文件內容。
56fs.readFileSync(filename[, options])
57fs.writeFile(filename, data[, options], callback)
異步寫入文件內容。
58fs.writeFileSync(filename, data[, options])
同步版的 fs.writeFile。
59fs.appendFile(filename, data[, options], callback)
異步追加文件內容。
60fs.appendFileSync(filename, data[, options])
The 同步 version of fs.appendFile.
61fs.watchFile(filename[, options], listener)
查看文件的修改。
62fs.unwatchFile(filename[, listener])
停止查看 filename 的修改。
63fs.watch(filename[, options][, listener])
查看 filename 的修改,filename 可以是文件或目錄。返回 fs.FSWatcher 對象。
64fs.exists(path, callback)
檢測給定的路徑是否存在。
65fs.existsSync(path)
同步版的 fs.exists.
66fs.access(path[, mode], callback)
測試指定路徑用戶權限。
67fs.accessSync(path[, mode])
同步版的 fs.access。
68fs.createReadStream(path[, options])
返回ReadStream 對象。
69fs.createWriteStream(path[, options])
返回 WriteStream 對象。
70fs.symlink(srcpath, dstpath[, type], callback)
異步 symlink().回調函數沒有參數,但可能拋出異常。

更多內容,請查看官網文件模塊描述:File System