DIV CSS 佈局教程網

NodeJS 學習筆記:FS 文件模塊與 Stream 的協同
編輯:關於JavaScript     

文件系統模塊是對標準 POSIX 文件 I/O 操作方法的一層簡單包裝,透過 require("fs") 取得。模塊中的每個方法幾乎都備有異步與同步兩個版本。

一、異步與同步的差別

異步方法的最後一個形參是完成時的回調函式,而回調的第一個參數慣例上是錯誤物件:操作正確時它是 null 或 undefined。同步版本則相反,一旦出錯就直接拋出異常,需要用 try...catch 攔下來,否則程式會中斷。

先建立一個測試檔 bb.txt,內容是「大家好,我是大雄君!」。

讀取:

var fs = require("fs");
fs.readFile("bb.txt", "utf8", function (error, data) {
  if (error) throw error;
  console.log(data);
});

這裡最關鍵的一點:讀檔一定要指定編碼,否則回傳的是 Buffer 而非字串,印出來就是一串看不懂的內容:

寫入:

var fs = require("fs");
var txt = "大家要好好學習 NodeJS 啊!!!";
fs.writeFile("bb.txt", txt, function (err) {
  if (err) throw err;
  console.log("File Saved !");
});

幾個常用的檔案操作:

// 刪除檔案
fs.unlink('bb.txt', function () {
  console.log('success');
});

// 修改檔名
fs.rename('bb.txt', 'bigbear.txt', function (err) {
  console.log('rename success');
});

// 查看檔案狀態
fs.stat('bb.txt', function (err, stat) {
  console.log(stat);
});

// 判斷檔案是否存在
fs.exists('bb.txt', function (exists) {
  console.log(exists);
});

二、FS 與 Stream 的聯繫

Stream 天生帶著異步特性。我們可以把一個檔案切成若干個指定大小的 chunk 逐塊讀取,每讀到一塊就立刻輸出,直到讀完為止——這就像 HTTP/1.1 的 Transfer-Encoding: chunked。chunk 可以是任何形式,NodeJS 預設用 Buffer 以換取更好的效能。而 Node 的 Stream 還具備一個源自 Unix 的超級特性:pipe(管道)。

還記得 Http 那篇的第一個程式嗎?改寫一下,讓它回傳一個真正的 HTML 檔:

先建立 bb.html:

<html>
  <head>
    <style type="text/css">
      div {
        margin-top: 50px;
        width: 100%;
        margin: 0px;
        height: 120px;
        line-height: 120px;
        color: #fff;
        font-size: 22px;
        background: #ff9900;
        text-align: center;
      }
    </style>
  </head>
  <body>
    <div>Hello, 大熊!</div>
  </body>
</html>

再改寫伺服器程式:

var http = require('http');
var fs = require("fs");
var server = http.createServer(function (req, res) {
  fs.readFile("bb.html", "utf-8", function (err, data) {
    if (err) {
      res.writeHead(500, { 'Content-Type': 'text/plain' });
      res.end('指定檔案不存在,或伺服器發生錯誤!');
    } else {
      res.writeHead(200, { 'Content-Type': 'text/html' });
      res.write(data);
      res.end();
    }
  });
});
server.listen(8888);
console.log("http server running on port 8888 ...");

到這裡都還順利。但換個情境想想:如果要送的不是幾百字的小檔案,而是一段 1080p、長達兩小時、約 4GB 出頭的 MP4 影片呢?readFile 的工作方式是「整份讀進記憶體」,這個量級顯然吃不消。這正是 stream 上場的時候:

fs.createReadStream(__dirname + '/video.mp4').pipe(res);

一行取代一整段。總結來說,先前的寫法雖然能跑,但伺服器必須先把整份檔案快取到記憶體;檔案一大、併發一高,記憶體立刻成為瓶頸,而且使用者得等整份快取完成才看得到內容。還好 (req, res) 兩者本身就是 Stream,用 fs.createReadStream() 取代 fs.readFile() 即可迎刃而解。

三、綜合範例:檔案上傳

這個例子示範如何把 HTTP 伺服器、路由與請求處理拆成獨立模塊,並用 formidable 處理表單上傳。

server.js

var http = require('http');
var url = require('url');

function start(route, handler) {
  function onRequest(request, response) {
    var pathname = url.parse(request.url).pathname;
    route(pathname, handler, response, request);   // 交由路由分派
  }
  http.createServer(onRequest).listen(3000);
  console.log('server is starting');
}
exports.start = start;

route.js

function route(pathname, handler, response, request) {
  console.log('about to route a request for ' + pathname);
  if (typeof handler[pathname] === 'function') {
    return handler[pathname](response, request);
  } else {
    console.log('no request handler found for ' + pathname);
    response.writeHead(404, { 'Content-Type': 'text/html' });
    response.write('404 Not Found!');
    response.end();
  }
}
exports.route = route;

requestHandler.js

var querystring = require('querystring'),
    fs = require('fs'),
    formidable = require('formidable');

function start(response, request) {
  console.log('start module');
  var body = '<html>' +
    '<head>' +
    '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />' +
    '</head>' +
    '<body>' +
    '<form action="/upload" enctype="multipart/form-data" method="post">' +
    '<input type="file" name="upload" multiple="multiple">' +
    '<input type="submit" value="Submit text" />' +
    '</form>' +
    '</body>' +
    '</html>';
  response.writeHead(200, { 'Content-Type': 'text/html' });
  response.write(body);
  response.end();
}

function upload(response, request) {
  console.log('upload module');
  var form = new formidable.IncomingForm();
  form.parse(request, function (error, fields, files) {
    fs.renameSync(files.upload.path, '/tmp/test.png');
    response.writeHead(200, { 'Content-Type': 'text/html' });
    response.write('You\'ve sent: <br />');
    response.write('<img src="/show" />');
    response.end();
  });
}

function show(response, request) {
  console.log('show module');
  fs.readFile('/tmp/test.png', 'binary', function (error, file) {
    if (error) {
      response.writeHead(200, { 'Content-Type': 'text/html' });
      response.write(error);
      response.end();
    } else {
      response.writeHead(200, { 'Content-Type': 'image/png' });
      response.write(file, 'binary');
      response.end();
    }
  });
}

exports.start = start;
exports.upload = upload;
exports.show = show;

index.js

var server = require('./server');
var router = require('./router');
var requestHandler = require('./requestHandler');

var handler = {};
handler['/'] = requestHandler.start;
handler['/start'] = requestHandler.start;
handler['/upload'] = requestHandler.upload;
handler['/show'] = requestHandler.show;

server.start(router.route, handler);

這個結構把「伺服器啟動」「路由分派」「業務處理」三者剝離開來,日後新增功能只要往 handler 表裡添一行即可,不必去動伺服器本體。

四、重點回顧

理解 FS 與 Stream 之間的協作關係;熟練使用 FS 相關 API;注意同步與異步兩種風格在錯誤處理上的差異;最後,把檔案上傳這個範例的代碼組織方式反覆咀嚼——真正的功力往往體現在如何拆分模塊、如何在不斷重構中收斂出清爽的結構。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved