Node.js創(chuàng)建HTTP文件服務(wù)器的使用示例

HelloWorld示例只有演示意義，這次我們來(lái)搞一個(gè)實(shí)際的例子：文件服務(wù)器。我們使用Node.js創(chuàng)建一個(gè)HTTP協(xié)議的文件服務(wù)器，你可以使用瀏覽器或其它下載工具到文件服務(wù)器上下載文件。

為了讀取文件，我們會(huì)用到File System模塊（名字是”fs”），Stream，我們還要分析URL，區(qū)別HTTP方法，還會(huì)用到EventEmitter。

文件服務(wù)器FileServer的代碼

先上代碼吧，依然是簡(jiǎn)單的：

// 引入http模塊
var http = require("http"); 
var fs = require("fs");

// 創(chuàng)建server，指定處理客戶端請(qǐng)求的函數(shù)
http.createServer(
  function(request, response) {
    //判斷HTTP方法，只處理GET 
    if(request.method != "GET"){
      response.writeHead(403);
      response.end();
      return null;
    }

    //此處也可使用URL模塊來(lái)分析URL(https://nodejs.org/api/url.html)
    var sep = request.url.indexOf('?');
    var filePath = sep < 0 ? request.url : request.url.slice(0, sep);
    console.log("GET file: " + filePath);

    //當(dāng)文件存在時(shí)發(fā)送數(shù)據(jù)給客戶端，否則404
    var fileStat = fs.stat("."+filePath, 
      function(err, stats){
        if(err) {
          response.writeHead(404);
          response.end();
          return null;
        }
        //TODO:Content-Type應(yīng)該根據(jù)文件類型設(shè)置
        response.writeHead(200, {"Content-Type": "text/plain", "Content-Length": stats.size});

        //使用Stream
        var stream = fs.createReadStream("."+filePath);

        stream.on('data',function(chunk){
          response.write(chunk);
        });

        stream.on('end',function(){
          response.end();
        });

        stream.on('error',function(){
          response.end();
        });
      }
    );
  }
).listen(8000); 

console.log("Hello World start listen on port 8000");

最大的變化，就在傳遞給createServer方法的參數(shù)了。

我們根據(jù)request.method作了判斷，不是GET就返回403。如果是呢，就判斷文件是否存在，不存在，返回404，存在就讀取數(shù)據(jù)寫給客戶端。邏輯就是這么簡(jiǎn)單。下面我們來(lái)介紹用到的新知識(shí)。

File System

要使用FileSystem，得用require引入fs模塊，就如前面代碼里那樣。File System的API老長(zhǎng)老長(zhǎng)了，看這里吧：https://nodejs.org/api/fs.html。我們只說(shuō)用到的特性。

獲取文件狀態(tài)

在我們的FileServer里，收到和客戶端請(qǐng)求時(shí)先通過(guò)fs.stat()方法獲取文件狀態(tài)。fs.stat()方法原型如下：

fs.stat(path, callback)

第一個(gè)參數(shù)是文件路徑，第二個(gè)參數(shù)是回調(diào)函數(shù)。fs.stat()方法是異步的，結(jié)果通過(guò)回調(diào)函數(shù)callback返回。callback的原型如下：

function(err, stats)

第一個(gè)參數(shù)指示是否出現(xiàn)了錯(cuò)誤，第二個(gè)參數(shù)是一個(gè)對(duì)象，類型是fs.Stats，保存了文件的狀態(tài)信息，比如大小、創(chuàng)建時(shí)間、修改時(shí)間等。

FileServer的代碼獲取到文件狀態(tài)后，讀取大小，調(diào)用http.ServerResponse的writeHead方法，設(shè)置HTTP狀態(tài)碼為200，還設(shè)置了Content-Length頭部。代碼如下：

ReadStream

接下來(lái)呢，我們調(diào)用fs.createReadStream創(chuàng)建了一個(gè)ReadStream對(duì)象。ReadStream是Stream，也是EventEmitter。

fs.createReadStream方法原型如下：

fs.createReadStream(path[, options])

第一個(gè)參數(shù)是文件路徑，第二個(gè)參數(shù)是可選的JSON對(duì)象，用來(lái)指定打開文件的一些選項(xiàng)，默認(rèn)值如下：

{ flags: ‘r', 
encoding: null, 
fd: null, 
mode: 0666, 
autoClose: true 
}

autoClose屬性默認(rèn)為true，讀完文件或讀取出錯(cuò)時(shí)，文件會(huì)被自動(dòng)關(guān)閉。fd屬性可以關(guān)聯(lián)一個(gè)已有的文件描述符，這樣就會(huì)忽略path，根據(jù)一個(gè)已經(jīng)打開的文件來(lái)創(chuàng)建流。options還可以有start和end項(xiàng)，指定起、止位置，讀取文件的特定區(qū)域。如果我們要實(shí)現(xiàn)斷點(diǎn)續(xù)傳，就需要這個(gè)了，用法類似這樣：

fs.createReadStream('sample.mp4', {start: 1000, end: 10000});

encoding用來(lái)指定文件的編碼，這對(duì)于文本文件有特殊的意義，目前支持'utf8'、'ascii'和'base64'。

ReadStream讀取數(shù)據(jù)是異步的，一塊一塊的讀，讀到一部分就發(fā)送一個(gè)data事件，數(shù)據(jù)呢，會(huì)傳遞給與事件關(guān)聯(lián)的listener（實(shí)際上是一個(gè)回調(diào)方法）。在我們的代碼里，僅僅是調(diào)用response.write把數(shù)據(jù)寫給客戶端。注意，可能會(huì)多次調(diào)用response.write哦。又因?yàn)槲覀冊(cè)O(shè)置了Content-Length，所以不會(huì)采用chunked編碼方式。如果我們不設(shè)置Content-Length，那默認(rèn)會(huì)啟用chunked方式。

ReadStream讀完文件時(shí)會(huì)發(fā)射end事件，出錯(cuò)時(shí)會(huì)發(fā)射error事件，我們監(jiān)聽這兩個(gè)事件，簡(jiǎn)單的終止響應(yīng)。

我們?cè)谑纠a中看到了stream.on這種代碼，下面來(lái)解釋吧。

EventEmitter

Node.js基于V8引擎實(shí)現(xiàn)的事件驅(qū)動(dòng)IO，是其最大最棒的特色之一。有了事件機(jī)制，就可以充分利用異步IO突破單線程編程模型的性能瓶頸，使得用JavaScript作后端開發(fā)有了實(shí)際意義。

EventEmitter的基本用法

events.EventEmitter是一個(gè)簡(jiǎn)單的事件發(fā)射器的實(shí)現(xiàn)，具有addListener、on、once、removeListener、emit等方法，開發(fā)者可以很方便的調(diào)用這些API監(jiān)聽某個(gè)事件或者發(fā)射某個(gè)事件。

我們?cè)谑纠杏玫降膄s.ReadStream就是一個(gè)EventEmitter，它實(shí)現(xiàn)了stream.Readable接口，而stream.Readable具有data、error、end、close、readable等事件。

通常我們使用EventEmitter的on或addListener來(lái)監(jiān)聽一個(gè)事件，這個(gè)時(shí)間可能會(huì)多次觸發(fā)，每次觸發(fā)，我們提供的回調(diào)方法都會(huì)被調(diào)用。我們示例中的代碼就是這樣：

    stream.on('data',function(chunk){
      response.write(chunk);
    });

Node.js的事件機(jī)制，會(huì)給某個(gè)事件關(guān)聯(lián)一個(gè)回調(diào)方法列表，這樣多個(gè)關(guān)注者就可以監(jiān)聽同一個(gè)事件。每個(gè)事件發(fā)射時(shí)，可能會(huì)帶有數(shù)據(jù)和狀態(tài)，這些數(shù)據(jù)是通過(guò)回調(diào)方法的參數(shù)傳遞出來(lái)的。那某一個(gè)特定的事件，它對(duì)應(yīng)的回調(diào)方法的參數(shù)是什么樣子的，則由事件定義的那個(gè)類（實(shí)例）來(lái)決定。EventEmitter的emit方法原型如下：

emitter.emit(event[, arg1][, arg2][, ...])

這個(gè)原型說(shuō)明一個(gè)事件的回調(diào)方法可以有一個(gè)或多個(gè)參數(shù)，也可以沒(méi)有參數(shù)。要想知道某個(gè)事件的回調(diào)方法是否有參數(shù)、每個(gè)參數(shù)的含義，只好去找相關(guān)的API文檔。stream.Readable的data事件的參數(shù)是chunk，Buffer類型，代表讀到的數(shù)據(jù)。

如果我們只想監(jiān)聽某個(gè)事件一次，則可以調(diào)用EventEmitter的once方法。要想移除一個(gè)事件監(jiān)聽器，可以調(diào)用removeListener，想移除所有，則可以調(diào)用removeAllListener。

自定義事件

Node.js的很多模塊都繼承自Event模塊。我們自己也可以通過(guò)繼承EventEmitter來(lái)實(shí)現(xiàn)自己的對(duì)象，添加自己的自定義事件。

這里有個(gè)簡(jiǎn)單的例子：

var util=require("util");
var events = require("events");
function Ticker() {
  var self = this;
  events.EventEmitter.call(this);
  setInterval(function(){
    self.emit("tick")
    },
    1000
  );
}
util.inherits(Ticker, events.EventEmitter);

var ticker = new Ticker();
ticker.on("tick", function() {
 console.log("tick event");
});

在這個(gè)簡(jiǎn)單的例子里，我們定義了Ticker對(duì)象，通過(guò)全局方法setInterval開啟了一個(gè)定時(shí)器，每隔1000毫秒發(fā)射一個(gè)名為“tick”的事件。

Node.js的工具模塊封裝了繼承的方法，我們調(diào)用它來(lái)的inherits方法來(lái)完成Ticker對(duì)events.EventEmitter的繼承。

自定義事件的使用方法，和Node.js內(nèi)置模塊提供的事件的用法完全一樣。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持億速云。