实战node静态文件服务器的示例代码

2023-09-15 16:32:07 380

本篇文章主要介绍了实战node静态文件服务器的示例，分享给大家，具体如下：

支持功能:

读取静态文件
访问目录可以自动寻找下面的index.html文件,如果没有index.html则列出文件列表
MIME类型支持
缓存支持/控制
支持gzip压缩
Range支持，断点续传
全局命令执行
子进程运行

1.创建服务读取静态文件

首先引入http模块，创建一个服务器，并监听配置端口:

consthttp=require('http');

constserver=http.createServer();

//监听请求
server.on('request',request.bind(this));

server.listen(config.port,()=>{
console.log(`静态文件服务启动成功,访问localhost:${config.port}`);
});

写一个fn专门处理请求,返回静态文件,url模块获取路径:

consturl=require('url');
constfs=require('fs');
functionrequest(req,res){
const{pathname}=url.parse(req.url);//访问路径

constfilepath=path.join(config.root,pathname);//文件路径

fs.createReadStream(filepath).pipe(res);//读取文件，并响应
}

支持寻找index.html:

if(pathname==='/'){
constrootPath=path.join(config.root,'index.html');
try{
constindexStat=fs.statSync(rootPath);
if(indexStat){
filepath=rootPath;
}
}catch(e){

}
}

fs.stat(filepath,(err,stats)=>{
if(err){
res.end('notfound');
return;
}
if(stats.isDirectory()){
letfiles=fs.readdirSync(filepath);
files=files.map(file=>({
name:file,
url:path.join(pathname,file)
}));
lethtml=this.list()({
title:pathname,
files
});
res.setHeader('Content-Type','text/html');
res.end(html);
}
}

html模板:

functionlist(){
lettmpl=fs.readFileSync(path.resolve(__dirname,'template','list.html'),'utf8');
returnhandlebars.compile(tmpl);
}







{{title}}


hope-server静态文件服务器

{{#eachfiles}}

{{name}}

{{/each}}

2.MIME类型支持

利用mime模块得到文件类型,并设置编码:

res.setHeader('Content-Type',mime.getType(filepath)+';charset=utf-8');

3.缓存支持

http协议缓存:

Cache-Control:http1.1内容，告诉客户端如何缓存数据，以及规则

private客户端可以缓存
public客户端和代理服务器都可以缓存
max-age=60缓存内容将在60秒后失效
no-cache需要使用对比缓存验证数据,强制向源服务器再次验证
no-store所有内容都不会缓存，强制缓存和对比缓存都不会触发

Expires:http1.0内容，cache-control会覆盖，告诉客户端缓存什么时候过期

ETag:内容的hash值下一次客户端请求在请求头里添加if-none-match:etag值

Last-Modified:最后的修改时间下一次客户端请求在请求头里添加if-modified-since:Last-Modified值

handleCache(req,res,stats,hash){
//当资源过期时,客户端发现上一次请求资源，服务器有发送Last-Modified,则再次请求时带上if-modified-since
constifModifiedSince=req.headers['if-modified-since'];
//服务器发送了etag,客户端再次请求时用If-None-Match字段来询问是否过期
constifNoneMatch=req.headers['if-none-match'];
//http1.1内容max-age=30为强行缓存30秒30秒内再次请求则用缓存private仅客户端缓存，代理服务器不可缓存
res.setHeader('Cache-Control','private,max-age=30');
//http1.0内容作用与Cache-Control一致告诉客户端什么时间，资源过期优先级低于Cache-Control
res.setHeader('Expires',newDate(Date.now()+30*1000).toGMTString());
//设置ETag根据内容生成的hash
res.setHeader('ETag',hash);
//设置Last-Modified文件最后修改时间
constlastModified=stats.ctime.toGMTString();
res.setHeader('Last-Modified',lastModified);

//判断ETag是否过期
if(ifNoneMatch&&ifNoneMatch!=hash){
returnfalse;
}
//判断文件最后修改时间
if(ifModifiedSince&&ifModifiedSince!=lastModified){
returnfalse;
}
//如果存在且相等，走缓存304
if(ifNoneMatch||ifModifiedSince){
res.writeHead(304);
res.end();
returntrue;
}else{
returnfalse;
}
}

4.压缩

客户端发送内容，通过请求头里Accept-Encoding:gzip,deflate告诉服务器支持哪些压缩格式，服务器根据支持的压缩格式，压缩内容。如服务器不支持，则不压缩。

getEncoding(req,res){
constacceptEncoding=req.headers['accept-encoding'];
//gzip和deflate压缩
if(/\bgzip\b/.test(acceptEncoding)){
res.setHeader('Content-Encoding','gzip');
returnzlib.createGzip();
}elseif(/\bdeflate\b/.test(acceptEncoding)){
res.setHeader('Content-Encoding','deflate');
returnzlib.createDeflate();
}else{
returnnull;
}
}

5.断点续传

服务器通过请求头中的Range:bytes=0-xxx来判断是否是做Range请求，如果这个值存在而且有效，则只发回请求的那部分文件内容，响应的状态码变成206，表示PartialContent，并设置Content-Range。如果无效，则返回416状态码，表明RequestRangeNotSatisfiable。如果不包含Range的请求头，则继续通过常规的方式响应。

getStream(req,res,filepath,statObj){
letstart=0;
letend=statObj.size-1;
constrange=req.headers['range'];
if(range){
res.setHeader('Accept-Range','bytes');
res.statusCode=206;//返回整个内容的一块
letresult=range.match(/bytes=(\d*)-(\d*)/);
if(result){
start=isNaN(result[1])?start:parseInt(result[1]);
end=isNaN(result[2])?end:parseInt(result[2])-1;
}
}
returnfs.createReadStream(filepath,{
start,end
});
}

6.全局命令执行

通过npmlink实现

为npm包目录创建软链接，将其链到{prefix}/lib/node_modules/
为可执行文件(bin)创建软链接，将其链到{prefix}/bin/{name}

npmlink命令通过链接目录和可执行文件，实现npm包命令的全局可执行。

package.json里面配置

{
bin:{
"hope-server":"bin/hope"
}
}

在项目下面创建bin目录hope文件,利用yargs配置命令行传参数

//告诉电脑用node运行我的文件
#!/usr/bin/envnode

constyargs=require('yargs');
constinit=require('../src/index.js');
constargv=yargs.option('d',{
alias:'root',
demand:'false',
type:'string',
default:process.cwd(),
description:'静态文件根目录'
}).option('o',{
alias:'host',
demand:'false',
default:'localhost',
type:'string',
description:'配置监听的主机'
}).option('p',{
alias:'port',
demand:'false',
type:'number',
default:8080,
description:'配置端口号'
}).option('c',{
alias:'child',
demand:'false',
type:'boolean',
default:false,
description:'是否子进程运行'
})
.usage('hope-server[options]')
.example(
'hope-server-d/-p9090-olocalhost','在本机的9090端口上监听客户端的请求'
).help('h').argv;

//启动服务
init(argv);

7.子进程运行

通过spawn实现

index.js

const{spawn}=require('child_process');
constServer=require('./hope');

functioninit(argv){
//如果配置为子进程开启服务
if(argv.child){
//子进程启动服务
constchild=spawn('node',['hope.js',JSON.stringify(argv)],{
cwd:__dirname,
detached:true,
stdio:'inherit'
});

//后台运行
child.unref();
//退出主线程，让子线程单独运行
process.exit(0);
}else{
constserver=newServer(argv);
server.start();
}
}

module.exports=init;
hope.js
if(process.argv[2]&&process.argv[2].startsWith('{')){
constargv=JSON.parse(process.argv[2]);
constserver=newHope(argv);
server.start();
}

8.源码及测试

源码地址:hope-server

npminstallhope-server-g

进入任意目录

hope-server

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。

实战node静态文件服务器的示例代码

hope-server静态文件服务器

热门推荐

随机推荐