Like Share Discussion Bookmark Smile

J.J. Huang   2020-01-30   Node.js   瀏覽次數:

Node.js | File System(文件篇)

簡介

fs模組提供了一種API,一組類似UNIX(POSIX)標準的文件操作標準。

可以使用以下指令訪問它:

1
const fs = require('fs');

異步和同步

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

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

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

input.txt文件,內容如下:

1
2
J.J.'s Blogs:https://morosedog.gitlab.io/
文件範例

file.js,程式如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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("執行完畢。");

執行結果如下:

1
2
3
4
5
6
$ node file.js
同步讀取: J.J.'s Blogs:https://morosedog.gitlab.io/
文件範例
程序執行完畢。
異步讀取: J.J.'s Blogs:https://morosedog.gitlab.io/
文件範例

打開文件

語法

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

1
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+’, 但是如果文件路徑存在,則文件讀取追加失敗。

實例

1
2
3
4
5
6
7
8
9
10
var fs = require("fs");

// 異步打開文件
console.log("準備打開文件!");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
  console.log("文件打開成功!");
});

執行結果如下:

1
2
3
$ node file.js
準備打開文件!
文件打開成功!

取得文件資訊

語法

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

1
fs.stat(path, callback)

參數

參數使用說明如下:

  • path:文件路徑。
  • callback:回調函數,帶有兩個參數如:(err, stats), statsfs.Stats對象。

返回值

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

例如判斷是否為文件:

1
2
3
4
5
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中的一種特殊

實例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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());
});

執行結果如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
$ node file.js
準備打開文件!
Stats {
dev: 16777220,
mode: 33188,
nlink: 1,
uid: 501,
gid: 20,
rdev: 0,
blksize: 4096,
ino: 6119379,
size: 57,
blocks: 8,
atimeMs: 1580293523185.2615,
mtimeMs: 1580293523171.4226,
ctimeMs: 1580293626830.4734,
birthtimeMs: 1578989017628.228,
atime: 2020-01-29T10:25:23.185Z,
mtime: 2020-01-29T10:25:23.171Z,
ctime: 2020-01-29T10:27:06.830Z,
birthtime: 2020-01-14T08:03:37.628Z
}
讀取文件訊息成功!
是否為文件(isFile) ? true
是否為目錄(isDirectory) ? false

寫入文件

語法

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

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

writeFile 直接打開文件默認是 w 模式,所以如果文件存在,該方法寫入的內容會覆蓋舊的文件內容。

參數

參數使用說明如下:

  • file:文件名或文件描述符。
  • data:要寫入文件的資料,可以是String(字符串)或Buffer(緩衝)對象。
  • options:該參數是一個對象,包含 {encoding, mode, flag}。默認編碼為utf8,模式為0666flag'w'
  • callback:回調函數,回調函數只包含錯誤訊息參數(err),在寫入失敗時返回。

實例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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());
   });
});

執行結果如下:

1
2
3
4
5
6
$ node file.js
準備寫入文件
資料寫入成功!
--------我是分割線-------------
讀取寫入的資料!
異步讀取文件資料: 我是通 過fs.writeFile 寫入文件的內容

input.txt 內容變為:

1
我是通 過fs.writeFile 寫入文件的內容

讀取文件

語法

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

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

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

參數

參數使用說明如下:

  • fd:通過fs.open()方法返回的文件描述符。
  • buffer:資料寫入的緩衝區。
  • offset:緩衝區寫入的寫入偏移量。
  • length:要從文件中讀取的字節數。
  • position:文件讀取的起始位置,如果position的值為null,則會從當前文件指針的位置讀取。
  • callback:回調函數,有三個參數errbytesReadbuffererr為錯誤訊息,bytesRead表示讀取的字節數,buffer為緩衝區對象。

實例

input.txt文件,內容如下:

1
J.J.'s Blogs:https://morosedog.gitlab.io/

file.js,程式如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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());
      }
   });
});

執行結果如下:

1
2
3
4
5
6
$ node file.js
準備打開已存在的文件!
文件打開成功!
準備讀取文件:
43 字節被讀取
J.J.'s Blogs:https://morosedog.gitlab.io/

關閉文件

語法

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

1
fs.close(fd, callback)

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

參數

參數使用說明如下:

  • fd:通過fs.open()方法返回的文件描述符。
  • callback:回調函數,沒有參數。

實例

input.txt文件,內容如下:

1
J.J.'s Blogs:https://morosedog.gitlab.io/

file.js,程式如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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("文件關閉成功");
      });
   });
});

執行結果如下:

1
2
3
4
5
6
$ node file.js
準備打開文件!
文件打開成功!
準備讀取文件!
J.J.'s Blogs:https://morosedog.gitlab.io/
文件關閉成功

截取文件

語法

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

1
fs.ftruncate(fd, len, callback)

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

參數

參數使用說明如下:

  • fd:通過fs.open()方法返回的文件描述符。
  • len:文件內容截取的長度。
  • callback:回調函數,沒有參數。

實例

input.txt文件,內容如下:

1
J.J.'s Blogs:https://morosedog.gitlab.io/

file.js,程式如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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("文件關閉成功!");
         });
      });
   });
});

執行結果如下:

1
2
3
4
5
6
7
8
$ node file.js
準備打開文件!
文件打開成功!
截取10字節內的文件內容,超出部分將被去除。
文件截取成功。
讀取相同的文件
J.J.'s Blo
文件關閉成功!

刪除文件

語法

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

1
fs.unlink(path, callback)

參數

參數使用說明如下:

  • path:文件路徑。
  • callback:回調函數,沒有參數。

實例

input.txt文件,內容如下:

1
J.J.'s Blogs:https://morosedog.gitlab.io/

file.js,程式如下:

1
2
3
4
5
6
7
8
9
var fs = require("fs");

console.log("準備刪除文件!");
fs.unlink('input.txt', function(err) {
   if (err) {
       return console.error(err);
   }
   console.log("文件刪除成功!");
});

執行結果如下:

1
2
3
$ node file.js
準備刪除文件!
文件刪除成功!

方法參考手冊

請直接至Node.js官方提供的File System Documentation查看。


註:以上參考了
Node.js 文件系统