用Node提供靜態(tài)文件服務(wù)的方法

前言

對(duì)于一個(gè)web應(yīng)用，提供靜態(tài)文件（CSS、JavaScript、圖片）服務(wù)常常是必須的。本文將介紹如何做一個(gè)自己的靜態(tài)文件服務(wù)器。

創(chuàng)建一個(gè)靜態(tài)文件服務(wù)器

每個(gè)靜態(tài)文件服務(wù)器都有個(gè)根目錄，也就是提供文件服務(wù)的基礎(chǔ)目錄。所以我們要在即將創(chuàng)建的服務(wù)器上定義一個(gè)root變量，它將作為我們這個(gè)靜態(tài)文件服務(wù)器的根目錄：

var http = require('http')
var join = require('path').join
var fs = require('fs')

var root = __dirname

__dirname 在Node中是一個(gè)神奇的變量，它的值是該文件所在目錄的路徑。在本例中，服務(wù)器會(huì)將這個(gè)腳本所在的目錄作為靜態(tài)文件的根目錄。

有了文件的路徑，還需要傳輸文件的內(nèi)容。

這可以用fs.ReadStream完成，它是Node中Stream類之一。成功調(diào)用 fs.createReadStream() 會(huì)返回一個(gè)新的 fs.ReadStream 對(duì)象。

下面的代碼實(shí)現(xiàn)了一個(gè)簡(jiǎn)單但功能完備的文件服務(wù)器。

var server = http.createServer(function(req, res){
 let path = join(root, req.url)
 let stream = fs.createReadStream(path)
 stream.on('data', function(chunk){
  res.write(chunk)
 })
 stream.on('end', function(){
  res.end()
 })
})

server.listen(3000)

這個(gè)文件服務(wù)器大體能用，但還有很多細(xì)節(jié)需要考慮。接下來我們要優(yōu)化數(shù)據(jù)的傳輸，同時(shí)也精簡(jiǎn)一下服務(wù)器的代碼。

用STREAM.PIPE()優(yōu)化數(shù)據(jù)傳輸

雖然上面的代碼看上去還不錯(cuò)，但Node還提供了更高級(jí)的實(shí)現(xiàn)機(jī)制：Stream.pipe()。用這個(gè)方法可以極大簡(jiǎn)化服務(wù)器的代碼。 優(yōu)化后代碼如下：

var server = http.createServer(function(req, res){
 let path = join(root, req.url)
 let stream = fs.createReadStream(path)
 stream.pipe(res)
})

server.listen(3000)

這種寫法，是不是更簡(jiǎn)單，更清晰了呢？

理解流和管道

流是Node中很重要的一個(gè)概念，你可以把Node中的管道想象成水管，如果你想讓某個(gè)源頭（比如熱水器）流出來的水流到一個(gè)目的地（比如廚房的水龍頭），可以在中間加一個(gè)管道把它們連起來，這樣水就會(huì)順著管道從源頭流到目的地。

Node中的管道也是這樣，但其中流動(dòng)的不是水，而是來自源頭（即ReadableStream）的數(shù)據(jù)，管道可以讓它們“流動(dòng)”到某個(gè)目的地（即WritableStream）。你可以用pipe方法把管道連起來：

ReadableStream.pipe(WritableStream)

讀取一個(gè)文件（ReadableStream）并把其中的內(nèi)容寫到另一個(gè)文件中（WritableStream）用的就是管道：

let readStream = fs.createReadStream('./original.txt') 
let writeStream = fs.createWriteStream('./copy.txt') 
readStream.pipe(writeStream)

所有ReadableStream都能接入任何一個(gè)WritableStream。比如HTTP請(qǐng)求（req）對(duì)象就是ReadableStream，你可以讓其中的內(nèi)容流動(dòng)到文件中：

req.pipe(fs.createWriteStream('./req-body.txt'))

運(yùn)行

現(xiàn)在我們來運(yùn)行上面的代碼，我們?cè)诟夸浵路乓粡垐D片，比如peiqi.jpg。

在瀏覽器中輸入http://127.0.0.1:3000/peiqi.jpg，發(fā)現(xiàn)可愛的peiqi已經(jīng)出現(xiàn)在你的面前了。peiqi.jpg被當(dāng)作響應(yīng)主體從http服務(wù)器送到了客戶端（瀏覽器）。

雖然已經(jīng)品嘗到了成功的滋味，但這個(gè)靜態(tài)文件服務(wù)器還不夠完整，因?yàn)樗苋菀壮鲥e(cuò)。想象一下，如果用戶不小心輸入了一個(gè)并不存在的資源，比如abc.html，服務(wù)器就會(huì)馬上崩掉。所以我們還得給這個(gè)文件服務(wù)器加上錯(cuò)誤處理機(jī)制，讓它足夠健壯。

處理服務(wù)器錯(cuò)誤

在Node中，所有繼承了EventEmitter的類都可能會(huì)發(fā)出error事件。為了監(jiān)聽錯(cuò)誤，在fs.ReadStream上注冊(cè)一個(gè)error事件處理器（比如下面這段代碼），返回響應(yīng)狀態(tài)碼500表明有服務(wù)器內(nèi)部錯(cuò)誤：

 stream.on('error', function(err){
  res.statusCode = 500
  res.end('服務(wù)器內(nèi)部錯(cuò)誤')
 })

用fs.stat()實(shí)現(xiàn)錯(cuò)誤處理

我們可以用fs.stat()來獲取文件的相關(guān)信息，如果文件不存在，fs.stat()會(huì)在err.code中放入ENOENT作為響應(yīng)，然后你可以返回錯(cuò)誤碼404，向客戶端表明文件未找到。如果fs.stat()返回了其他錯(cuò)誤碼，你可以返回通用的錯(cuò)誤碼500。
重構(gòu)后的代碼如下：

var server = http.createServer(function(req, res){
 let path = join(root, req.url)

 fs.stat(path, function(err, stat) {
  if (err) {
   if ('ENOENT' == err.code) {
    res.statusCode = 404
    res.end('Not Found')
   } else {
    res.statusCode = 500
    res.end('服務(wù)器內(nèi)部錯(cuò)誤')
   }
  } else { // 有該文件
   res.setHeader('Content-Length', stat.size)
   var stream = fs.createReadStream(path)
   stream.pipe(res)

   stream.on('error', function(err) { // 如果讀取文件出錯(cuò)
    res.statusCode = 500
    res.end('服務(wù)器內(nèi)部錯(cuò)誤')
   })
  }
 })
})

server.listen(3000)

注意

本節(jié)構(gòu)建的文件服務(wù)器是個(gè)簡(jiǎn)化版。如果你想把它放到生產(chǎn)環(huán)境中，應(yīng)該更全面地檢查輸入的有效性，以防用戶通過目錄遍歷攻擊訪問到你本來不想開放給他們的那部分內(nèi)容。

小結(jié)

讀到這里，相信聰明的你已經(jīng)掌握了如何用Node創(chuàng)建一個(gè)靜態(tài)服務(wù)器，下一篇文章我會(huì)給大家介紹如何用Node處理用戶上傳的文件并存放到服務(wù)器中。

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