用Node提供静态文件服务的方法


Posted in Javascript onJuly 06, 2018

前言

对于一个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服务器送到了客户端(浏览器)。

用Node提供静态文件服务的方法

虽然已经品尝到了成功的滋味,但这个静态文件服务器还不够完整,因为它很容易出错。想象一下,如果用户不小心输入了一个并不存在的资源,比如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)

注意

本节构建的文件服务器是个简化版。如果你想把它放到生产环境中,应该更全面地检查输入的有效性,以防用户通过目录遍历攻击访问到你本来不想开放给他们的那部分内容。

小结

读到这里,相信聪明的你已经掌握了如何用Node创建一个静态服务器,下一篇文章我会给大家介绍如何用Node处理用户上传的文件并存放到服务器中。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
jQuery 学习第五课 Ajax 使用说明
May 17 Javascript
js中function()使用方法
Dec 24 Javascript
JavaScript通过元素的ID和name设置样式
Jul 08 Javascript
jQuery扁平化风格下拉框美化插件FancySelect使用指南
Feb 10 Javascript
JavaScript通过join函数连接数组里所有元素的方法
Mar 20 Javascript
使用iojs的jsdom库实现同步系统时间
Apr 20 Javascript
详解javascript数组去重问题
Nov 06 Javascript
原生JS实现-星级评分系统的简单实例
Aug 21 Javascript
AngularJs expression详解及简单示例
Sep 01 Javascript
微信小程序外卖选购页实现切换分类与数量加减功能案例
Jan 15 Javascript
如何用原生js写一个弹窗消息提醒插件
May 24 Javascript
JavaScript中的this基本问题实例小结
Mar 09 Javascript
vue使用监听实现全选反选功能
Jul 06 #Javascript
vue 实现数字滚动增加效果的实例代码
Jul 06 #Javascript
详解在Vue中使用TypeScript的一些思考(实践)
Jul 06 #Javascript
javascript显示动态时间的方法汇总
Jul 06 #Javascript
Django+Vue跨域环境配置详解
Jul 06 #Javascript
微信小程序画布圆形进度条显示效果
Nov 17 #Javascript
微信小程序实时聊天WebSocket
Jul 05 #Javascript
You might like
php循环输出数据库内容的代码
2008/05/24 PHP
PHP文件操作实现代码分享
2011/09/01 PHP
PHP中Session可能会引起并发问题
2015/06/26 PHP
解决PHP程序运行时:Fatal error: Maximum execution time of 30 seconds exceeded in的错误提示
2016/11/25 PHP
thinkphp关于简单的权限判定方法
2017/04/03 PHP
Laravel中encrypt和decrypt的实现方法
2017/09/24 PHP
PHP设计模式之装饰器模式定义与用法简单示例
2018/08/13 PHP
一个小型js框架myJSFrame附API使用帮助
2008/06/28 Javascript
JavaScript 学习笔记二 字符串拼接
2010/03/28 Javascript
jquery maxlength使用说明
2011/09/09 Javascript
JavaScript中的运算符种类及其规则介绍
2013/09/26 Javascript
AngularJS 与Bootstrap实现表格分页实例代码
2016/10/14 Javascript
详解AngularJS用Interceptors来统一处理HTTP请求和响应
2017/06/08 Javascript
详解如何实现一个简单的Node.js脚手架
2017/12/04 Javascript
layui 关闭open弹出框 刷新table表格页面的方法
2019/09/16 Javascript
JS实现拼图游戏
2021/01/29 Javascript
[01:31]完美与DOTA2历程
2014/07/31 DOTA
python实现划词翻译
2020/04/23 Python
学习python之编写简单简单连接数据库并执行查询操作
2016/02/27 Python
python字典键值对的添加和遍历方法
2016/09/11 Python
python+django快速实现文件上传
2016/10/24 Python
Python 专题五 列表基础知识(二维list排序、获取下标和处理txt文本实例)
2017/03/20 Python
Python实现XML文件解析的示例代码
2018/02/05 Python
对python中xlsx,csv以及json文件的相互转化方法详解
2018/12/25 Python
python批量图片处理简单示例
2019/08/06 Python
Python 词典(Dict) 加载与保存示例
2019/12/06 Python
Python QTimer实现多线程及QSS应用过程解析
2020/07/11 Python
UI自动化定位常用实现方法代码示例
2020/10/27 Python
解决python3.6用cx_Oracle库连接Oracle的问题
2020/12/07 Python
python用opencv 图像傅里叶变换
2021/01/04 Python
美国按摩椅批发网站:Titan Chair
2018/12/27 全球购物
应届毕业生个人求职信范文
2014/01/29 职场文书
活动宣传稿范文
2015/07/23 职场文书
竞聘演讲报告:基本写作有哪些?附开头范文
2019/10/16 职场文书
基于Redission的分布式锁实战
2022/08/14 Redis
ECharts transform数据转换和dataZoom在项目中使用
2022/12/24 Javascript