【超详细】Node.js搭建服务器之路由基础与实践并实现模块化

于 2024-08-16 21:26:39 发布
阅读量820 收藏 17
点赞数 16
文章标签： node.js 服务器 运维
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Lyy_ID/article/details/141269442
版权

Node.js路由基础与实践

简介

在Web开发中，路由是处理客户端请求并将其映射到服务器端资源的一种机制。Node.js提供了灵活的方式来处理HTTP请求，并通过路由来响应不同的URL。

环境搭建

在开始之前，请确保您的开发环境已经安装了Node.js。接着，创建一个新的项目文件夹，并在其中创建一个server.js文件。

前言：该篇文章默认你已经学会了fs文件流和管道实现基本读取写入、http创建服务器，res和req的相关属性（下文会给出），如果忘记了http、fs、path等模块的使用，可以参考笔者上一篇博客理解 Node.js 中的 HTTP 服务器、文件读写和流（采用fs、http、path模块）

基本路由实现

引入所需模块

const http = require('http');
const fs = require('fs');
const path = require('path');

创建HTTP服务器

使用http模块创建一个基本的HTTP服务器。

function startServer() {
    const server = http.createServer((req, res) => {
        // 响应处理逻辑
    });

    server.listen(3000, '127.0.0.1', () => {
        console.log('Server is listening on port 3000');
    });
}

http.createServer((req, res) => { // 处理请求的逻辑 });这个函数通常有两个参数，req 和 res，分别代表请求和响应对象。
请求对象 req
req.url: 请求的 URL。（常用 路由）
req.method: 请求的方法（如 GET 或 POST）。（常用）
req.headers: 请求头对象。（常用）
req.httpVersion: HTTP 协议版本。
req.setEncoding(): 设置请求体的编码，默认为 UTF-8。
req.on('data', callback): 当请求体数据到达时调用的回调函数。
req.on('end', callback): 当请求体完全接收完毕时调用的回调函数。
响应对象 res
res.statusCode: 响应的 HTTP 状态码，默认为 200。(不常用）
res.statusMessage: 响应的 HTTP 状态信息。
res.headersSent: 一个布尔值，指示头部是否已经被发送。(不常用）
res.setHeader(name, value): 设置响应头。(不常用）
res.getHeader(name): 获取响应头的值。(不常用）
res.removeHeader(name): 移除响应头。(不常用）
res.writeHead(statusCode[, statusMessage][, headers]): 发送响应头。(常用 复合属性，状态码+状态信息+响应头）
res.write(chunk[, encoding][, callback]): 发送响应体的一部分。（流式传输）
res.end([data][, encoding][, callback]): 结束响应过程，发送响应体的剩余部分，并关闭连接。（流式传输）

设置路由

使用switch语句来根据请求的URL设置不同的响应。

// 配置默认响应头
res.setHeader('Content-Type', 'text/html; charset=utf-8');

let filePath; // 根据url得到对应的文件路径
// 判断url
switch (req.url) {
    case '/':
        filePath = 'data.txt';
        break;
    case '/about':
        filePath = 'about.html';
        break;
    case '/user':
      // 直接设置响应头和管道流(我这里是json文件，所以需要修改'Content-Type')
      res.setHeader('Content-Type', 'application/json; charset=utf-8');
      // 获取json格式的数据
      let userInfoPath = path.join(__dirname, 'userInfo.json');
      stream = fs.createReadStream(userInfoPath, 'utf8');
      stream.pipe(res);
      return; // 退出http.createServer()函数，避免执行 res.end()
        break;
    default:
    	// 默认404页面	
        res.statusCode = 404;
        filePath = '404.html';
        break;
}

处理文件流

对于每个有效的路由，读取相应的文件并将其作为响应发送。

// 如果存在文件路径filePath
if (filePath) {
	// 流式读取绝对路径文件信息，编码格式为utf8
    const stream = fs.createReadStream(path.join(__dirname, filePath), 'utf8');
    //采用管道传给res
    stream.pipe(res);
} else {
    res.writeHead(404, { 'Content-Type': 'text/html; charset=utf-8' });
    res.end('404 Not Found');
}

错误处理

为文件流添加错误处理逻辑，以便在文件读取出错时返回500错误。

stream.on('error', (err) => {
    console.error('Stream error:', err);
    res.writeHead(500, { 'Content-Type': 'text/plain; charset=utf-8' });
    res.end('500 Internal Server Error');
});

完整代码示例

将上述部分组合在一起，我们得到以下完整的Node.js路由服务器代码。

const http = require('http');
const fs = require('fs');
const path = require('path');

function startServer() {
    const server = http.createServer((req, res) => {
        // 设置通用响应头
        res.setHeader('Content-Type', 'text/html; charset=utf-8');
        let stream;
        switch (req.url) {
            case '/':
                // 首页内容
                filePath = 'data.txt';
                break;
            case '/about':
                // 关于页面内容
                filePath = 'about.html';
                break;
            case '/user':
                // 直接设置响应头和管道流
                res.setHeader('Content-Type', 'application/json; charset=utf-8');
                // 获取json格式的数据
                let userInfoPath = path.join(__dirname, 'userInfo.json');
                stream = fs.createReadStream(userInfoPath, 'utf8');
                stream.pipe(res);
                return; // 退出http.createServer()函数，避免执行 res.end()
            default:
                // 设置404 Not Found的响应头
                res.statusCode = 404;
                filePath = '404.html';
                break;
        }

        if (filePath) {
            // 获取文件流
            stream = fs.createReadStream(path.join(__dirname, filePath), 'utf8');
            // 监听错误事件
            stream.on('error', (err) => {
                console.error('Stream error:', err);
                // 重写响应头
                res.writeHead(500, { 'Content-Type': 'text/plain; charset=utf-8' });
                res.end('500 Internal Server Error');
            });
            stream.pipe(res);
        } else {
            // 如果没有设置文件路径，发送404响应
            res.writeHead(404, { 'Content-Type': 'text/html; charset=utf-8' });
            res.end('404 Not Found');
        }
    });

    server.listen(3000, '127.0.0.1', () => {
        console.log('Server is listening on port 3000');
    });
}

module.exports = { startServer };

实例效果

  1. / 路由
    在这里插入图片描述

  2. about 路由
    在这里插入图片描述

  3. user 路由
    在这里插入图片描述

  4. api 路由（404）
    在这里插入图片描述

pipe()和res.end()使用时需要注意的

  1. 避免重复写入响应头: 在 Node.js 中，一旦响应头发送给客户端，就不能再修改它们。因此，在使用pipe()之前，确保没有调用过 res.writeHead() 或 res.write() 发送响应头或响应体。

  2. 正确使用 pipe(): pipe() 方法用于将一个流（源）的数据直接传输到另一个流（目标）。在使用 pipe() 将文件流传输到 HTTP 响应对象时，确保源流是可读的，并且目标流（res）是可写的。

  3. pipe() 中的end选项: 在pipe()方法中设置{ end: true }选项会在源流结束时自动调用 res.end()，从而结束响应。但要注意，如果管道的源流由于某些原因没有结束（例如，发生了错误），则res.end()也不会被调用。

  4. 错误处理: 监听源流的error事件，以便在发生错误时可以发送适当的错误响应给客户端。例如：

readStream.on('error', (err) => {
    res.writeHead(500, { 'Content-Type': 'text/plain' });
    res.end('An error occurred');
});
  1. 避免在管道后写入: 如果你已经开始使用pipe()传输数据，就不应该再使用 res.write() 向响应对象写入任何数据，因为这可能会导致 ERR_HTTP_HEADERS_SENT 错误。

监听流的结束事件: 虽然 pipe() 通常会自动结束响应，但有时你可能需要在流结束后执行一些额外的操作。在这种情况下，可以监听 finish 事件：

readStream.pipe(res, { end: true }).on('finish', () => {
    console.log('Stream has been piped and response ended');
});

模块化

倘若项目越来越庞大，有十几个路由，我们的server.js里面的switch函数就会变得有近百行代码，那么这个函数就会变得十分臃肿，于是我们采用模块化的方法将该项目分成三个模块，启动服务器模块server.js，路由模块router.js，入口文件index.js

index.js入口文件

const server = require('./server')// 导入server.js启动服务器
server.startServer()

server.js服务器模块

const http = require('http');
const handleRequest = require('./router'); // 引入路由处理模块

function startServer() {
    const server = http.createServer((req, res) => {
        // 设置通用响应头
        res.setHeader('Content-Type', 'text/html; charset=utf-8');
        // 调用路由处理函数，把req和res对象传过去做处理
        handleRequest(req, res);
    });
    server.listen(3000, '127.0.0.1', () => {
        console.log('Server is listening on port 3000');
    });
}
module.exports = { startServer };

router.js路由模块

// router.js
const fs = require('fs');
const path = require('path');
// server.js传过来的req和res对象
function handleRequest(req, res) {
    let filePath; // 文件路径
    let stream; // 文件流
    // 根据请求的 URL 进行路由处理
    switch (req.url) {
        case '/':
            filePath = 'data.txt';// 首页
            break;
        case '/about':
            filePath = 'about.html';// 关于页面
            break;
        case '/user':
        	// 我的数据是json文件，所以重写'Content-Type'
            res.setHeader('Content-Type', 'application/json; charset=utf-8');
            filePath = 'userInfo.json';
            break;
        default:
            res.statusCode = 404;
            res.end('404 Not Found');
            return; // 退出函数，避免进一步处理
    }

    // 如果设置了文件路径，获取文件流
    if (filePath) {
    	// 流式读取文件数据
        stream = fs.createReadStream(path.join(__dirname, filePath), 'utf8');
        // 监听错误事件
        stream.on('error', (err) => {
            console.error('Stream error:', err);
            res.writeHead(500, { 'Content-Type': 'text/plain; charset=utf-8' });
            res.end('500 Internal Server Error');
        });
        // 管道传递给res
        stream.pipe(res);
    }
}
module.exports = handleRequest;

这样，我们就成功把路由处理分到了专门的router.js文件，以后只需要对req.url 新增进行处理即可，不会增加server.js的代码行数。也不会影响入口文件

Cakndex
关注
Node.js | 搭建后端服务器（含内置模块 http | url | querystring 的使用）
前端之行，任重道远！
08-21 1万+
通过使用NodeJs的内置模块http快速搭建一个node后端服务器，并使用内置模块url等扩展其功能：实现后端路由、将node作为中间层使用、使用node实现爬虫
Node.js-Node.jsexpressMongoDB搭建个人博客
08-10
首先，Node.js是一个基于Chrome V8引擎的JavaScript运行环境，它允许我们在服务器端使用JavaScript编写代码，打破了传统的前端与后端的界限。Node.js拥有丰富的生态系统，提供了大量的模块，如Express，用于简化Web...
教你快速搭建Node.Js服务器的方法教程
10-20
Node.js是一套用来编写高性能网络服务器的JavaScript工具包，一系列的变化由此开始。这篇文章主要给大家介绍了如何快速搭建Node.Js服务器的方法教程，文中介绍的非常详细，对大家具有一定的参考价值，需要的朋友下面来一起看看吧。
nodejs路由
02-20
nodejs文件目录以及核心技术
Node.js(十三)
shi199434的博客
01-26 247
Node.js 路由 我们要为路由提供请求的 URL 和其他需要的 GET 及 POST 参数，随后路由需要根据这些数据来执行相应的代码。 因此，我们需要查看 HTTP 请求，从中提取出请求的 URL 以及 GET/POST 参数。这一功能应当属于路由还是服务器（甚至作为一个模块自身的功能）确实值得探讨，但这里暂定其为我们的HTTP服务器的功能。 我们需要的所有数据都会包含在 r
Node.js之路由
QSY_com的博客
02-11 1034
中间件(Middleware)，特指业务流程的中间处理环节。// 常量mv所指向的，就是一个中间件函数console.log('这是一个简单的中间件函数');// 注意：在当前中间件的业务处理完毕后，必须调用next()函数// 表示把流转关系交给下一个中间件或路由next();// 全局生效的中间件console.log('这是一个简单的中间件函数');next();});// 可以在路由中，通过如下两种等价的方式，使用多个局部中间件：自己手动模拟。
Node.js 路由
yuanlnet的博客
03-27 387
前言 Node.js 中的router，最主要的功能是将url请求信息，映射到具体的处理程序上，该处理程序可以是后端的controller，也可以是前端的具体页面（前端页面也是一个对象，它包括具体的template和脚本处理程序）。 示例（main.js） var http = require("http"); var url = require("url"); var app ={}; app.run = function start() { //router function ro...
node.js搭建的一个简单服务器
03-21
在IT领域，Node.js是一个基于Chrome V8引擎的JavaScript运行环境，它允许开发人员使用JavaScript进行服务器端编程。本教程将深入探讨如何使用Node.js搭建一个简单的服务器。 首先，我们需要安装Node.js。访问Node....
Node.js中的路由
大口喝脉动的博客
06-29 318
路由是指客户端请求地址与服务器端程序代码的对应关系。简单的说，就是请求什么响应什么。 举个栗子! var http = require('http') var url = require('url') http.createServer((req,res)=>{ //客户端发来请求 //设置响应信息的编码格式 res.setHeader('Content-Type','text/html;charset=UTF8') // url.parse() 函数第一
nodeJS及路由
m0_55836496的博客
09-15 738
使用NodeJS编写应用程序主要使用ECMAScript语法：变量、判断、循环等（JS三大组成部分：ECMA/DOM/BOM）内置/核心模块：http服务、fs文件操作、url路径、path路径处理、os操作系统第三方模块:后面讲自定义模块：自己创建的js文件格式声明模块//写法1exports.属性/方法名 = 功能//写法2module.exports.属性/方法名 = 变量名;//使用：先引入再调用var 对象 = require(‘路径及文件名’);对象.属性或方法名;
nodeJS实现路由功能
weixin_33801856的博客
06-07 136
前面的话 　　本文将使用NodeJS实现较复杂应用的路由功能   结构 　　项目结构如下 　　代码如下   功能 【router.js】 // 加载所需模块 var http = require('http'); var url = require('url'); var fs = require('fs'); var host = '127.0.0.1'...
Node.js路由方法
DearXuan的博客
01-10 2441
Nodejs制作服务器程序
[node] Node.js的路由
最新发布
前端
12-21 840
可以通过硬编码的方式将这一逻辑处理绑定到服务器上，但是对于推荐模块开发的情况下，使用依赖注入的方式较松散地添加路由模块会使得耦合性更低，也方便以后的代码变更。路由需要提供请求的 URL 和其他需要的 GET/POST 参数，随后路由需要根据这些数据来执行相应的代码。以上代码没有具体的逻辑处理，你之后可以根据需要添加，此时只是封装了路由的处理方法。以上整体是对路由信息的获取与如何添加路由处理逻辑的一个简单介绍，是一种方法上的介绍。然后，先来看看如何把路由和服务器整合起来。
nodejs之路由
大黄蜂的博客
01-08 178
前言 我们要为路由提供请求的 URL 和其他需要的 GET 及 POST 参数，随后路由需要根据这些数据来执行相应的代码。 因此，我们需要查看 HTTP 请求，从中提取出请求的 URL 以及 GET/POST 参数。这一功能应当属于路由还是服务器（甚至作为一个模块自身的功能）确实值得探讨，但这里暂定其为我们的HTTP服务器的功能。 我们需要的所有数据都会包含在 request 对象中，该对象作为 ...
Nodejs路由配置
weixin_52629158的博客
05-28 517
/载入文件res.render("home/index");创建routers文件夹，创建index.js路由配置文件,nodejs中实例化路由类router，目的是通过 路径，访问页面。req request对象 保存客户端请求的相关信息res response对象 服务器端返回的响应信息next 执行下一个方法。路由的目的：八个字，载入页面，显示数据（接口中的数据）。页面取接口中的数据，显示在页面上。
node.js 路由详解
05-18 298
路由的基本使用 第一步：获取url跟目录下的字符 var http = require('http'); var url = require('url') http.createServer(function (request,response) { response.writeHead(200, {'Content-Type': 'text/html; cha...
Node.js开发入门：从基础到实践
第5章“使用Node.js进行Web开发”侧重于实际应用，讲解如何利用Node.js搭建Web服务器，介绍Express框架，以及路由控制、模板引擎的使用，同时还提供了一个建立微博网站的实战案例，涵盖用户注册、登录和发布微博等...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值