NodeJS 中的基本静态文件服务器

Question

我正在尝试在 nodejs 中创建一个静态文件服务器，而不是作为一个完美的服务器来理解 node。我非常了解 Connect 和 node-static 之类的项目，并且完全打算将这些库用于更多可用于生产的代码，但我也想了解我正在使用的基础知识。考虑到这一点，我编写了一个小型 server.js：

var http = require('http'),
    url = require('url'),
    path = require('path'),
    fs = require('fs');
var mimeTypes = {
    "html": "text/html",
    "jpeg": "image/jpeg",
    "jpg": "image/jpeg",
    "png": "image/png",
    "js": "text/javascript",
    "css": "text/css"};

http.createServer(function(req, res) {
    var uri = url.parse(req.url).pathname;
    var filename = path.join(process.cwd(), uri);
    path.exists(filename, function(exists) {
        if(!exists) {
            console.log("not exists: " + filename);
            res.writeHead(200, {'Content-Type': 'text/plain'});
            res.write('404 Not Found\n');
            res.end();
        }
        var mimeType = mimeTypes[path.extname(filename).split(".")[1]];
        res.writeHead(200, mimeType);

        var fileStream = fs.createReadStream(filename);
        fileStream.pipe(res);

    }); //end path.exists
}).listen(1337);

我的问题是双重的

1. 这是在节点中创建和流式传输基本 html 等的“正确”方法，还是有更好/更优雅/更健壮的方法？

2. node中的.pipe()基本上只是在做下面的事情吗？

.

var fileStream = fs.createReadStream(filename);
fileStream.on('data', function (data) {
    res.write(data);
});
fileStream.on('end', function() {
    res.end();
});

谢谢大家！

Answer 1

少即是多

只需在您的项目上先进入命令提示符并使用

$ npm install express

然后像这样编写你的 app.js 代码：

var express = require('express'),
app = express(),
port = process.env.PORT || 4000;

app.use(express.static(__dirname + '/public'));
app.listen(port);

然后，您将创建一个“公共”文件夹来放置文件。我首先尝试了更难的方法，但是您必须担心 mime 类型，它只需要映射耗时的东西，然后担心响应类型等等等....不，谢谢。

Answer 2

• 您的基本服务器看起来不错，除了：

  缺少return 语句。

  res.write('404 Not Found\n');
  res.end();
  return; // <- Don't forget to return here !!
  

  还有：

  res.writeHead(200, mimeType);

  应该是：

  res.writeHead(200, {'Content-Type':mimeType});

• 是的pipe() 基本上是这样做的，它还会暂停/恢复源流（以防接收器速度较慢）。 这里是pipe()函数的源代码：https://github.com/joyent/node/blob/master/lib/stream.js

Answer 3

我也喜欢了解幕后发生的事情。

我注意到你的代码中有一些你可能想要清理的东西：

• 当文件名指向一个目录时它会崩溃，因为存在为真并且它试图读取一个文件流。我使用 fs.lstatSync 来确定目录是否存在。

• 未正确使用 HTTP 响应代码（200、404 等）

• 在确定 MimeType 时（从文件扩展名），它在 res.writeHead 中的设置不正确（正如stete 指出的那样）

• 要处理特殊字符，您可能需要取消转义 uri

• 它盲目地遵循符号链接（可能是一个安全问题）

鉴于此，一些 apache 选项（FollowSymLinks、ShowIndexes 等）开始变得更有意义。我已将您的简单文件服务器的代码更新如下：

var http = require('http'),
    url = require('url'),
    path = require('path'),
    fs = require('fs');
var mimeTypes = {
    "html": "text/html",
    "jpeg": "image/jpeg",
    "jpg": "image/jpeg",
    "png": "image/png",
    "js": "text/javascript",
    "css": "text/css"};

http.createServer(function(req, res) {
  var uri = url.parse(req.url).pathname;
  var filename = path.join(process.cwd(), unescape(uri));
  var stats;

  try {
    stats = fs.lstatSync(filename); // throws if path doesn't exist
  } catch (e) {
    res.writeHead(404, {'Content-Type': 'text/plain'});
    res.write('404 Not Found\n');
    res.end();
    return;
  }


  if (stats.isFile()) {
    // path exists, is a file
    var mimeType = mimeTypes[path.extname(filename).split(".").reverse()[0]];
    res.writeHead(200, {'Content-Type': mimeType} );

    var fileStream = fs.createReadStream(filename);
    fileStream.pipe(res);
  } else if (stats.isDirectory()) {
    // path exists, is a directory
    res.writeHead(200, {'Content-Type': 'text/plain'});
    res.write('Index of '+uri+'\n');
    res.write('TODO, show index?\n');
    res.end();
  } else {
    // Symbolic link, other?
    // TODO: follow symlinks?  security?
    res.writeHead(500, {'Content-Type': 'text/plain'});
    res.write('500 Internal server error\n');
    res.end();
  }

}).listen(1337);

Answer 4

var http = require('http')
var fs = require('fs')

var server = http.createServer(function (req, res) {
  res.writeHead(200, { 'content-type': 'text/plain' })

  fs.createReadStream(process.argv[3]).pipe(res)
})

server.listen(Number(process.argv[2]))

Answer 5

这个模式怎么样，它避免单独检查文件是否存在

        var fileStream = fs.createReadStream(filename);
        fileStream.on('error', function (error) {
            response.writeHead(404, { "Content-Type": "text/plain"});
            response.end("file not found");
        });
        fileStream.on('open', function() {
            var mimeType = mimeTypes[path.extname(filename).split(".")[1]];
            response.writeHead(200, {'Content-Type': mimeType});
        });
        fileStream.on('end', function() {
            console.log('sent file ' + filename);
        });
        fileStream.pipe(response);

Answer 6

我根据@Jeff Ward 的回答制作了一个带有额外功能的 httpServer 函数以供一般使用

1. 自定义目录
2. 如果 req === dir 则返回 index.html

用法：

httpServer(dir).listen(port);

https://github.com/kenokabe/ConciseStaticHttpServer

谢谢。

Answer 7

st module 使提供静态文件变得容易。这是 README.md 的摘录：

var mount = st({ path: __dirname + '/static', url: '/static' })
http.createServer(function(req, res) {
  var stHandled = mount(req, res);
  if (stHandled)
    return
  else
    res.end('this is not a static file')
}).listen(1338)

Answer 8

@JasonSebring 的回答为我指明了正确的方向，但是他的代码已经过时了。这是使用最新的connect 版本的方法。

var connect = require('connect'),
    serveStatic = require('serve-static'),
    serveIndex = require('serve-index');

var app = connect()
    .use(serveStatic('public'))
    .use(serveIndex('public', {'icons': true, 'view': 'details'}))
    .listen(3000);

在connectGitHub Repository还有其他中间件可以使用。