Detailed explanation of node static file server instance
This article mainly introduces you to an example of a practical node static file server. This article will first list its functions and then share it with you in the form of code. I hope it can help you.
Supported functions:
Read static files
Accessing the directory can automatically find the following index.html file, if If there is no index.html, list the files
MIME type support
Cache support/control
Support gzip compression
Range support, breakpoint resume transmission
Global command execution
Subprocess running
1. Create a service to read static files
First introduce the http module, create a server, and listen to the configuration port:
const http = require('http');
const server = http.createServer();
// 监听请求
server.on('request', request.bind(this));
server.listen(config.port, () => {
console.log(`静态文件服务启动成功, 访问localhost:${config.port}`);
});Write a fn specifically to handle requests and return static files. The url module obtains the path:
const url = require('url');
const fs = require('fs');
function request(req, res) {
const { pathname } = url.parse(req.url); // 访问路径
const filepath = path.join(config.root, pathname); // 文件路径
fs.createReadStream(filepath).pipe(res); // 读取文件，并响应
}Supports finding index.html:
if (pathname === '/') {
const rootPath = path.join(config.root, 'index.html');
try{
const indexStat = fs.statSync(rootPath);
if (indexStat) {
filepath = rootPath;
}
} catch(e) {
}
}When accessing the directory, list the file directory:
fs.stat(filepath, (err, stats) => {
if (err) {
res.end('not found');
return;
}
if (stats.isDirectory()) {
let files = fs.readdirSync(filepath);
files = files.map(file => ({
name: file,
url: path.join(pathname, file)
}));
let html = this.list()({
title: pathname,
files
});
res.setHeader('Content-Type', 'text/html');
res.end(html);
}
}html template:
function list() {
let tmpl = fs.readFileSync(path.resolve(__dirname, 'template', 'list.html'), 'utf8');
return handlebars.compile(tmpl);
} <!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>{{title}}</title>
</head>
<body>
<h1>hope-server静态文件服务器</h1>
<ul>
{{#each files}}
<li>
<a href={{url}}>{{name}}</a>
</li>
{{/each}}
</ul>
</body>
</html>2.MIME type support
Use the mime module to get the file type and set the encoding:
res.setHeader('Content-Type', mime.getType(filepath) + ';charset=utf-8');
3.Cache support
http protocol cache:
Cache-Control: http1.1 content, tells the client how to cache data, and the rules
private client can cache
public Both client and proxy server can cache
max-age=60 The cached content will expire after 60 seconds
no-cache You need to use the comparison cache to verify the data, and force the source server to verify again
no-store All content will not be cached, neither forced caching nor comparison caching Will trigger
Expires: http1.0 content, cache-control will overwrite it and tell the client when the cache will expire
ETag: The hash value of the content for the next client Request to add if-none-match: etag value in the request header
Last-Modified: Last modified time The next time the client requests, add if-modified-since: Last-Modified value in the request header
handleCache(req, res, stats, hash) {
// 当资源过期时, 客户端发现上一次请求资源，服务器有发送Last-Modified, 则再次请求时带上if-modified-since
const ifModifiedSince = req.headers['if-modified-since'];
// 服务器发送了etag,客户端再次请求时用If-None-Match字段来询问是否过期
const ifNoneMatch = 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', new Date(Date.now() + 30 * 1000).toGMTString());
// 设置ETag 根据内容生成的hash
res.setHeader('ETag', hash);
// 设置Last-Modified 文件最后修改时间
const lastModified = stats.ctime.toGMTString();
res.setHeader('Last-Modified', lastModified);
// 判断ETag是否过期
if (ifNoneMatch && ifNoneMatch != hash) {
return false;
}
// 判断文件最后修改时间
if (ifModifiedSince && ifModifiedSince != lastModified) {
return false;
}
// 如果存在且相等，走缓存304
if (ifNoneMatch || ifModifiedSince) {
res.writeHead(304);
res.end();
return true;
} else {
return false;
}
}4. Compression
The client sends content and tells the server which compression formats are supported through Accept-Encoding: gzip, deflate in the request header. The server compresses the content based on the supported compression formats. If the server does not support it, no compression will be performed.
getEncoding(req, res) {
const acceptEncoding = req.headers['accept-encoding'];
// gzip和deflate压缩
if (/\bgzip\b/.test(acceptEncoding)) {
res.setHeader('Content-Encoding', 'gzip');
return zlib.createGzip();
} else if (/\bdeflate\b/.test(acceptEncoding)) {
res.setHeader('Content-Encoding', 'deflate');
return zlib.createDeflate();
} else {
return null;
}
}5. Breakpoint resume transmission
The server uses the Range: bytes=0-xxx in the request header to determine whether it is making a Range request. If this value exists and is valid, it will only send Return the requested part of the file content, the response status code becomes 206, indicating Partial Content, and set Content-Range. If it is invalid, a 416 status code is returned, indicating that Request Range Not Satisfiable. If the Range request header is not included, continue to respond in the usual way.
getStream(req, res, filepath, statObj) {
let start = 0;
let end = statObj.size - 1;
const range = req.headers['range'];
if (range) {
res.setHeader('Accept-Range', 'bytes');
res.statusCode = 206;//返回整个内容的一块
let result = range.match(/bytes=(\d*)-(\d*)/);
if (result) {
start = isNaN(result[1]) ? start : parseInt(result[1]);
end = isNaN(result[2]) ? end : parseInt(result[2]) - 1;
}
}
return fs.createReadStream(filepath, {
start, end
});
}6. Global command execution
Achieved through npm link
Create a soft link for the npm package directory and link it to {prefix}/ lib/node_modules/
Create a soft link for the executable file (bin) and link it to {prefix}/bin/{name}
The npm link command makes the npm package command globally executable by linking directories and executable files.
Configuration in package.json
{
bin: {
"hope-server": "bin/hope"
}
}Create the bin directory hope file under the project, and use yargs to configure the command line to pass parameters
// 告诉电脑用node运行我的文件
#! /usr/bin/env node
const yargs = require('yargs');
const init = require('../src/index.js');
const argv = 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 / -p 9090 -o localhost', '在本机的9090端口上监听客户端的请求'
).help('h').argv;
// 启动服务
init(argv);7. Subprocess running
Achieved through spawn
index.js
const { spawn } = require('child_process');
const Server = require('./hope');
function init(argv) {
// 如果配置为子进程开启服务
if (argv.child) {
//子进程启动服务
const child = spawn('node', ['hope.js', JSON.stringify(argv)], {
cwd: __dirname,
detached: true,
stdio: 'inherit'
});
//后台运行
child.unref();
//退出主线程，让子线程单独运行
process.exit(0);
} else {
const server = new Server(argv);
server.start();
}
}
module.exports = init;
hope.js
if (process.argv[2] && process.argv[2].startsWith('{')) {
const argv = JSON.parse(process.argv[2]);
const server = new Hope(argv);
server.start();
}8. Source code and testing
Source code address: hope-server
npm install hope-server -g
Enter any directory
hope-server
Related recommendations:
detailed explanation of node static file server
A simple HTTP static file server written using nodejs and Python
Node.js static file server improved version_node.js
The above is the detailed content of Detailed explanation of node static file server instance. For more information, please follow other related articles on the PHP Chinese website!
Hot AI Tools
Undresser.AI Undress
AI-powered app for creating realistic nude photos
AI Clothes Remover
Online AI tool for removing clothes from photos.
Undress AI Tool
Undress images for free
Clothoff.io
AI clothes remover
AI Hentai Generator
Generate AI Hentai for free.
Hot Article
Hot Tools
Notepad++7.3.1
Easy-to-use and free code editor
SublimeText3 Chinese version
Chinese version, very easy to use
Zend Studio 13.0.1
Powerful PHP integrated development environment
Dreamweaver CS6
Visual web development tools
SublimeText3 Mac version
God-level code editing software (SublimeText3)
Hot Topics
1377
52
How to solve the problem that eMule search cannot connect to the server
Jan 25, 2024 pm 02:45 PM
Solution: 1. Check the eMule settings to make sure you have entered the correct server address and port number; 2. Check the network connection, make sure the computer is connected to the Internet, and reset the router; 3. Check whether the server is online. If your settings are If there is no problem with the network connection, you need to check whether the server is online; 4. Update the eMule version, visit the eMule official website, and download the latest version of the eMule software; 5. Seek help.
Solution to the inability to connect to the RPC server and the inability to enter the desktop
Feb 18, 2024 am 10:34 AM
What should I do if the RPC server is unavailable and cannot be accessed on the desktop? In recent years, computers and the Internet have penetrated into every corner of our lives. As a technology for centralized computing and resource sharing, Remote Procedure Call (RPC) plays a vital role in network communication. However, sometimes we may encounter a situation where the RPC server is unavailable, resulting in the inability to enter the desktop. This article will describe some of the possible causes of this problem and provide solutions. First, we need to understand why the RPC server is unavailable. RPC server is a
Detailed explanation of CentOS installation fuse and CentOS installation server
Feb 13, 2024 pm 08:40 PM
As a LINUX user, we often need to install various software and servers on CentOS. This article will introduce in detail how to install fuse and set up a server on CentOS to help you complete the related operations smoothly. CentOS installation fuseFuse is a user space file system framework that allows unprivileged users to access and operate the file system through a customized file system. Installing fuse on CentOS is very simple, just follow the following steps: 1. Open the terminal and Log in as root user. 2. Use the following command to install the fuse package: ```yuminstallfuse3. Confirm the prompts during the installation process and enter `y` to continue. 4. Installation completed
How to configure Dnsmasq as a DHCP relay server
Mar 21, 2024 am 08:50 AM
The role of a DHCP relay is to forward received DHCP packets to another DHCP server on the network, even if the two servers are on different subnets. By using a DHCP relay, you can deploy a centralized DHCP server in the network center and use it to dynamically assign IP addresses to all network subnets/VLANs. Dnsmasq is a commonly used DNS and DHCP protocol server that can be configured as a DHCP relay server to help manage dynamic host configurations in the network. In this article, we will show you how to configure dnsmasq as a DHCP relay server. Content Topics: Network Topology Configuring Static IP Addresses on a DHCP Relay D on a Centralized DHCP Server
Best Practice Guide for Building IP Proxy Servers with PHP
Mar 11, 2024 am 08:36 AM
In network data transmission, IP proxy servers play an important role, helping users hide their real IP addresses, protect privacy, and improve access speeds. In this article, we will introduce the best practice guide on how to build an IP proxy server with PHP and provide specific code examples. What is an IP proxy server? An IP proxy server is an intermediate server located between the user and the target server. It acts as a transfer station between the user and the target server, forwarding the user's requests and responses. By using an IP proxy server
What should I do if I can't enter the game when the epic server is offline? Solution to why Epic cannot enter the game offline
Mar 13, 2024 pm 04:40 PM
What should I do if I can’t enter the game when the epic server is offline? This problem must have been encountered by many friends. When this prompt appears, the genuine game cannot be started. This problem is usually caused by interference from the network and security software. So how should it be solved? The editor of this issue will explain I would like to share the solution with you, I hope today’s software tutorial can help you solve the problem. What to do if the epic server cannot enter the game when it is offline: 1. It may be interfered by security software. Close the game platform and security software and then restart. 2. The second is that the network fluctuates too much. Try restarting the router to see if it works. If the conditions are OK, you can try to use the 5g mobile network to operate. 3. Then there may be more
Pi Node Teaching: What is a Pi Node? How to install and set up Pi Node?
Mar 05, 2025 pm 05:57 PM
Detailed explanation and installation guide for PiNetwork nodes This article will introduce the PiNetwork ecosystem in detail - Pi nodes, a key role in the PiNetwork ecosystem, and provide complete steps for installation and configuration. After the launch of the PiNetwork blockchain test network, Pi nodes have become an important part of many pioneers actively participating in the testing, preparing for the upcoming main network release. If you don’t know PiNetwork yet, please refer to what is Picoin? What is the price for listing? Pi usage, mining and security analysis. What is PiNetwork? The PiNetwork project started in 2019 and owns its exclusive cryptocurrency Pi Coin. The project aims to create a one that everyone can participate
How to install PHP FFmpeg extension on server?
Mar 28, 2024 pm 02:39 PM
How to install PHPFFmpeg extension on server? Installing the PHPFFmpeg extension on the server can help us process audio and video files in PHP projects and implement functions such as encoding, decoding, editing, and processing of audio and video files. This article will introduce how to install the PHPFFmpeg extension on the server, as well as specific code examples. First, we need to ensure that PHP and FFmpeg are installed on the server. If FFmpeg is not installed, you can follow the steps below to install FFmpe
