一、簡介

本文將介紹node.js文件系統（fs）和流（stream）的一些API已經參數使用情況。

二、目錄

文件系統將介紹以下方法：

1.fs.readFile

2.fs.writeFile

3.fs.open

4.fs.read

5.fs.stat

6.fs.close

7.fs.mkdir

8.fs.rmdir

9.fs.readdir

10.fs.unlink

stream流的四種類型readable，writable，duplex，transform以及stream對象的事件。

三、文件系統fs主要方法介紹

1、fs.readFile

readFile方法主要是讀取文件內容，異步操作。

var fs = require(‘fs‘)
fs.readFile(‘a.txt‘,function(err,data){
    if (err){
        return console.error(err);
    }else{
        console.log("異步讀取: " + data.toString());
    }
})

2、fs.writeFile

writeFile以異步的方式寫入文件，fs.writeFile(file, data[, options], callback)

var fs = require(‘fs‘)
console.log("準備寫入文件")
fs.writeFile(‘input.txt‘,"寫入的內容",function(err){
    if (err){
        return console.error(err);
    }else{
        console.log("寫入成功");
    }
})

3、fs.open()

在異步方式下打開文件，fs.open(path, flags[, mode], callback)

var fs = require("fs");
// 異步打開文件
console.log("準備打開文件");
fs.open(
 
‘a.txt‘, ‘r+‘, function(err, fd) {//r+是以讀寫模式打開，fd為返回的文件描述符
   if (err) {
       return console.error(err);
   }
  console.log("文件打開成功！");     
});

4、fs.read（）

此方法為異步方式下讀取文件，格式：fs.read(fd, buffer, offset, length, position, callback)

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

console.log("準備打開文件！");
fs.open(‘at.txt‘, ‘r+‘, function(err, fd) {
   if (err) {
       return console.error(err);
   }
   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());
      }
   });
});

5、fs.stat()

此方法為異步方式獲取文件信息，格式：fs.stat(path, callback)

fs.stat(‘fs.js‘, function (err, stats) {
    console.log(stats.isFile());         //true
})

異步返回的stats類的實例有很多方法，比如stats.isFile()判斷是否是文件，stats.isDirectory()判斷是否是目錄，。。。。。。

6、fs.close()

fs.close()是以異步的方式關閉文件，語法格式：fs.close(fd, callback)，參數如下：

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

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

7、fs.mkdir()

此方法為創建目錄，格式：fs.mkdir(path[, mode], callback)，參數如下：

path：路徑。

mode:目錄權限，默認0777.。

callback：回調，沒有參數。

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

8、fs.rmdir()

刪除目錄，語法格式：fs.rmdir(path,callback)

9、fs.readdir()

此方法為讀取目錄，語法格式：fs.readdir(path, callback)，callback回調函數有兩個參數，第一個是err，第二個為目錄下的文件數組files。

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

10、fs.unlink()

此方法作用為刪除文件，格式：fs.unlink(path, callback)

var fs = require("fs");

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

四、stream流類型與事件介紹

1、 stream：流是一個抽象接口，有四種流類型：

readable ：可讀；

writable ：可寫操作；

duplex ：可讀可寫操作；

transform ：操作被寫入數據，然後讀出結果。

所有的stream對象都是EventEmitter 的實例，常用事件有：

data：當有數據可讀觸發，

end：沒有數據可讀觸發，

error：發生錯誤時觸發，

finish：完成觸發。

2、從流中讀數據

var fs = require("fs");
var data = ‘‘;

// 創建可讀流
var readerStream = fs.createReadStream(‘input.txt‘);

// 設置編碼為 utf8。
readerStream.setEncoding(‘UTF8‘);

// 處理流事件 --> data, end, and error
readerStream.on(‘data‘, function(chunk) {
   data += chunk;
});

readerStream.on(‘end‘,function(){
   console.log(data);
});

readerStream.on(‘error‘, function(err){
   console.log(err.stack);
});

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

3、寫入流：

var fs = require("fs");
var data = ‘寫入流數據‘;

// 創建一個可以寫入的流，寫入到文件 output.txt 中
var writerStream = fs.createWriteStream(‘output.txt‘);

// 使用 utf8 編碼寫入數據
writerStream.write(data,‘UTF8‘);

// 標記文件末尾
writerStream.end();

// 處理流事件 --> data, end, and error
writerStream.on(‘finish‘, function() {
    console.log("寫入完成。");
});

writerStream.on(‘error‘, function(err){
   console.log(err.stack);
});

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

4、管道流（pipe）

var fs = require("fs");

// 創建一個可讀流
var readerStream = fs.createReadStream(‘input.txt‘);

// 創建一個可寫流
var writerStream = fs.createWriteStream(‘output.txt‘);

// 管道讀寫操作
// 讀取 input.txt 文件內容，並將內容寫入到 output.txt 文件中
readerStream.pipe(writerStream);

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

5、鏈式流

鏈式是通過連接輸出流到另外一個流並創建多個流操作鏈的機制。鏈式流一般用於管道操作。

接下來我們就是用管道和鏈式來壓縮和解壓文件。

//壓縮
var fs = require("fs");
var zlib = require(‘zlib‘);

// 壓縮 input.txt 文件為 input.txt.gz
fs.createReadStream(‘input.txt‘)
  .pipe(zlib.createGzip())
  .pipe(fs.createWriteStream(‘input.txt.gz‘));
console.log("文件壓縮完成。");


//解壓
var fs = require("fs");
var zlib = require(‘zlib‘);
// 解壓 input.txt.gz 文件為 input.txt
fs.createReadStream(‘input.txt.gz‘)
  .pipe(zlib.createGunzip())
  .pipe(fs.createWriteStream(‘input.txt‘));
console.log("文件解壓完成。");

五、總結

nodeJs文件系統（fs）與流（stream）