用Node提供静态文件服务

2019年9月20日 12:34:18js教程评论571 views阅读模式

这篇文章主要介绍了关于用Node提供静态文件服务，有着一定的参考价值，现在分享给大家，有需要的朋友可以参考一下

前言

对于一个web应用，提供静态文件（CSS、JavaScript、图片）服务常常是必须的。本文将介绍如何做一个自己的静态文件服务器。

创建一个静态文件服务器

每个静态文件服务器都有个根目录，也就是提供文件服务的基础目录。所以我们要在即将创建的服务器上定义一个root变量，它将作为我们这个静态文件服务器的根目录：

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

var root = __dirname

__dirname 在Node中是一个神奇的变量，它的值是该文件所在目录的路径。在本例中，服务器会将这个脚本所在的目录作为静态文件的根目录。

有了文件的路径，还需要传输文件的内容。
这可以用fs.ReadStream完成，它是Node中Stream类之一。成功调用 fs.createReadStream() 会返回一个新的 fs.ReadStream 对象。
下面的代码实现了一个简单但功能完备的文件服务器。

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)

这个文件服务器大体能用，但还有很多细节需要考虑。接下来我们要优化数据的传输，同时也精简一下服务器的代码。

用STREAM.PIPE()优化数据传输

虽然上面的代码看上去还不错，但Node还提供了更高级的实现机制：Stream.pipe()。用这个方法可以极大简化服务器的代码。优化后代码如下：

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

server.listen(3000)

这种写法，是不是更简单，更清晰了呢？

理解流和管道

流是Node中很重要的一个概念，你可以把Node中的管道想象成水管，如果你想让某个源头（比如热水器）流出来的水流到一个目的地（比如厨房的水龙头），可以在中间加一个管道把它们连起来，这样水就会顺着管道从源头流到目的地。
Node中的管道也是这样，但其中流动的不是水，而是来自源头（即ReadableStream）的数据，管道可以让它们“流动”到某个目的地（即WritableStream）。你可以用pipe方法把管道连起来：

ReadableStream.pipe(WritableStream)

读取一个文件（ReadableStream）并把其中的内容写到另一个文件中（WritableStream）用的就是管道：

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

所有ReadableStream都能接入任何一个WritableStream。比如HTTP请求（req）对
象就是ReadableStream，你可以让其中的内容流动到文件中：

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

运行

现在我们来运行上面的代码，我们在根目录下放一张图片，比如peiqi.jpg。
在浏览器中输入http://127.0.0.1:3000/peiqi.jpg，发现可爱的peiqi已经出现在你的面前了。peiqi.jpg被当作响应主体从http服务器送到了客户端（浏览器）。

虽然已经品尝到了成功的滋味，但这个静态文件服务器还不够完整，因为它很容易出错。想象一下，如果用户不小心输入了一个并不存在的资源，比如abc.html，服务器就会马上崩掉。所以我们还得给这个文件服务器加上错误处理机制，让它足够健壮。

处理服务器错误

在Node中，所有继承了EventEmitter的类都可能会发出error事件。为了监听错误，在fs.ReadStream上注册一个error事件处理器（比如下面这段代码），返回响应状态码500表明有服务器内部错误：

  stream.on('error', function(err){
    res.statusCode = 500
    res.end('服务器内部错误')
  })

用fs.stat()实现错误处理

我们可以用fs.stat()来获取文件的相关信息，如果文件不存在，fs.stat()会在err.code中放入ENOENT作为响应，然后你可以返回错误码404，向客户端表明文件未找到。如果fs.stat()返回了其他错误码，你可以返回通用的错误码500。
重构后的代码如下：

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('服务器内部错误')
      }
    } else { // 有该文件
      res.setHeader('Content-Length', stat.size)
      var stream = fs.createReadStream(path)
      stream.pipe(res)

      stream.on('error', function(err) { // 如果读取文件出错
        res.statusCode = 500
        res.end('服务器内部错误')
      })
    }
  })
})

server.listen(3000)